babylon.module.d.ts 5.4 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752
  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. /** @hidden */
  41. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  42. }
  43. /** @hidden */
  44. /** @hidden */
  45. type DeepImmutableObject<T> = {
  46. readonly [K in keyof T]: DeepImmutable<T[K]>;
  47. };
  48. }
  49. declare module "babylonjs/Misc/observable" {
  50. import { Nullable } from "babylonjs/types";
  51. /**
  52. * A class serves as a medium between the observable and its observers
  53. */
  54. export class EventState {
  55. /**
  56. * Create a new EventState
  57. * @param mask defines the mask associated with this state
  58. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  59. * @param target defines the original target of the state
  60. * @param currentTarget defines the current target of the state
  61. */
  62. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  63. /**
  64. * Initialize the current event state
  65. * @param mask defines the mask associated with this state
  66. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  67. * @param target defines the original target of the state
  68. * @param currentTarget defines the current target of the state
  69. * @returns the current event state
  70. */
  71. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  72. /**
  73. * An Observer can set this property to true to prevent subsequent observers of being notified
  74. */
  75. skipNextObservers: boolean;
  76. /**
  77. * Get the mask value that were used to trigger the event corresponding to this EventState object
  78. */
  79. mask: number;
  80. /**
  81. * The object that originally notified the event
  82. */
  83. target?: any;
  84. /**
  85. * The current object in the bubbling phase
  86. */
  87. currentTarget?: any;
  88. /**
  89. * This will be populated with the return value of the last function that was executed.
  90. * If it is the first function in the callback chain it will be the event data.
  91. */
  92. lastReturnValue?: any;
  93. }
  94. /**
  95. * Represent an Observer registered to a given Observable object.
  96. */
  97. export class Observer<T> {
  98. /**
  99. * Defines the callback to call when the observer is notified
  100. */
  101. callback: (eventData: T, eventState: EventState) => void;
  102. /**
  103. * Defines the mask of the observer (used to filter notifications)
  104. */
  105. mask: number;
  106. /**
  107. * Defines the current scope used to restore the JS context
  108. */
  109. scope: any;
  110. /** @hidden */
  111. _willBeUnregistered: boolean;
  112. /**
  113. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  114. */
  115. unregisterOnNextCall: boolean;
  116. /**
  117. * Creates a new observer
  118. * @param callback defines the callback to call when the observer is notified
  119. * @param mask defines the mask of the observer (used to filter notifications)
  120. * @param scope defines the current scope used to restore the JS context
  121. */
  122. constructor(
  123. /**
  124. * Defines the callback to call when the observer is notified
  125. */
  126. callback: (eventData: T, eventState: EventState) => void,
  127. /**
  128. * Defines the mask of the observer (used to filter notifications)
  129. */
  130. mask: number,
  131. /**
  132. * Defines the current scope used to restore the JS context
  133. */
  134. scope?: any);
  135. }
  136. /**
  137. * Represent a list of observers registered to multiple Observables object.
  138. */
  139. export class MultiObserver<T> {
  140. private _observers;
  141. private _observables;
  142. /**
  143. * Release associated resources
  144. */
  145. dispose(): void;
  146. /**
  147. * Raise a callback when one of the observable will notify
  148. * @param observables defines a list of observables to watch
  149. * @param callback defines the callback to call on notification
  150. * @param mask defines the mask used to filter notifications
  151. * @param scope defines the current scope used to restore the JS context
  152. * @returns the new MultiObserver
  153. */
  154. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  155. }
  156. /**
  157. * The Observable class is a simple implementation of the Observable pattern.
  158. *
  159. * 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.
  160. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  161. * 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).
  162. * 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.
  163. */
  164. export class Observable<T> {
  165. private _observers;
  166. private _eventState;
  167. private _onObserverAdded;
  168. /**
  169. * Gets the list of observers
  170. */
  171. readonly observers: Array<Observer<T>>;
  172. /**
  173. * Creates a new observable
  174. * @param onObserverAdded defines a callback to call when a new observer is added
  175. */
  176. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  177. /**
  178. * Create a new Observer with the specified callback
  179. * @param callback the callback that will be executed for that Observer
  180. * @param mask the mask used to filter observers
  181. * @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.
  182. * @param scope optional scope for the callback to be called from
  183. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  184. * @returns the new observer created for the callback
  185. */
  186. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  187. /**
  188. * Create a new Observer with the specified callback and unregisters after the next notification
  189. * @param callback the callback that will be executed for that Observer
  190. * @returns the new observer created for the callback
  191. */
  192. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  193. /**
  194. * Remove an Observer from the Observable object
  195. * @param observer the instance of the Observer to remove
  196. * @returns false if it doesn't belong to this Observable
  197. */
  198. remove(observer: Nullable<Observer<T>>): boolean;
  199. /**
  200. * Remove a callback from the Observable object
  201. * @param callback the callback to remove
  202. * @param scope optional scope. If used only the callbacks with this scope will be removed
  203. * @returns false if it doesn't belong to this Observable
  204. */
  205. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  206. private _deferUnregister;
  207. private _remove;
  208. /**
  209. * Moves the observable to the top of the observer list making it get called first when notified
  210. * @param observer the observer to move
  211. */
  212. makeObserverTopPriority(observer: Observer<T>): void;
  213. /**
  214. * Moves the observable to the bottom of the observer list making it get called last when notified
  215. * @param observer the observer to move
  216. */
  217. makeObserverBottomPriority(observer: Observer<T>): void;
  218. /**
  219. * Notify all Observers by calling their respective callback with the given data
  220. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  221. * @param eventData defines the data to send to all observers
  222. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  223. * @param target defines the original target of the state
  224. * @param currentTarget defines the current target of the state
  225. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  226. */
  227. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  228. /**
  229. * Calling this will execute each callback, expecting it to be a promise or return a value.
  230. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  231. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  232. * and it is crucial that all callbacks will be executed.
  233. * The order of the callbacks is kept, callbacks are not executed parallel.
  234. *
  235. * @param eventData The data to be sent to each callback
  236. * @param mask is used to filter observers defaults to -1
  237. * @param target defines the callback target (see EventState)
  238. * @param currentTarget defines he current object in the bubbling phase
  239. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  240. */
  241. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  242. /**
  243. * Notify a specific observer
  244. * @param observer defines the observer to notify
  245. * @param eventData defines the data to be sent to each callback
  246. * @param mask is used to filter observers defaults to -1
  247. */
  248. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  249. /**
  250. * Gets a boolean indicating if the observable has at least one observer
  251. * @returns true is the Observable has at least one Observer registered
  252. */
  253. hasObservers(): boolean;
  254. /**
  255. * Clear the list of observers
  256. */
  257. clear(): void;
  258. /**
  259. * Clone the current observable
  260. * @returns a new observable
  261. */
  262. clone(): Observable<T>;
  263. /**
  264. * Does this observable handles observer registered with a given mask
  265. * @param mask defines the mask to be tested
  266. * @return whether or not one observer registered with the given mask is handeled
  267. **/
  268. hasSpecificMask(mask?: number): boolean;
  269. }
  270. }
  271. declare module "babylonjs/Misc/domManagement" {
  272. /**
  273. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  274. * Babylon.js
  275. */
  276. export class DomManagement {
  277. /**
  278. * Checks if the window object exists
  279. * @returns true if the window object exists
  280. */
  281. static IsWindowObjectExist(): boolean;
  282. /**
  283. * Extracts text content from a DOM element hierarchy
  284. * @param element defines the root element
  285. * @returns a string
  286. */
  287. static GetDOMTextContent(element: HTMLElement): string;
  288. }
  289. }
  290. declare module "babylonjs/Misc/logger" {
  291. /**
  292. * Logger used througouht the application to allow configuration of
  293. * the log level required for the messages.
  294. */
  295. export class Logger {
  296. /**
  297. * No log
  298. */
  299. static readonly NoneLogLevel: number;
  300. /**
  301. * Only message logs
  302. */
  303. static readonly MessageLogLevel: number;
  304. /**
  305. * Only warning logs
  306. */
  307. static readonly WarningLogLevel: number;
  308. /**
  309. * Only error logs
  310. */
  311. static readonly ErrorLogLevel: number;
  312. /**
  313. * All logs
  314. */
  315. static readonly AllLogLevel: number;
  316. private static _LogCache;
  317. /**
  318. * Gets a value indicating the number of loading errors
  319. * @ignorenaming
  320. */
  321. static errorsCount: number;
  322. /**
  323. * Callback called when a new log is added
  324. */
  325. static OnNewCacheEntry: (entry: string) => void;
  326. private static _AddLogEntry;
  327. private static _FormatMessage;
  328. private static _LogDisabled;
  329. private static _LogEnabled;
  330. private static _WarnDisabled;
  331. private static _WarnEnabled;
  332. private static _ErrorDisabled;
  333. private static _ErrorEnabled;
  334. /**
  335. * Log a message to the console
  336. */
  337. static Log: (message: string) => void;
  338. /**
  339. * Write a warning message to the console
  340. */
  341. static Warn: (message: string) => void;
  342. /**
  343. * Write an error message to the console
  344. */
  345. static Error: (message: string) => void;
  346. /**
  347. * Gets current log cache (list of logs)
  348. */
  349. static readonly LogCache: string;
  350. /**
  351. * Clears the log cache
  352. */
  353. static ClearLogCache(): void;
  354. /**
  355. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  356. */
  357. static LogLevels: number;
  358. }
  359. }
  360. declare module "babylonjs/Misc/typeStore" {
  361. /** @hidden */
  362. export class _TypeStore {
  363. /** @hidden */
  364. static RegisteredTypes: {
  365. [key: string]: Object;
  366. };
  367. /** @hidden */
  368. static GetClass(fqdn: string): any;
  369. }
  370. }
  371. declare module "babylonjs/Misc/deepCopier" {
  372. /**
  373. * Class containing a set of static utilities functions for deep copy.
  374. */
  375. export class DeepCopier {
  376. /**
  377. * Tries to copy an object by duplicating every property
  378. * @param source defines the source object
  379. * @param destination defines the target object
  380. * @param doNotCopyList defines a list of properties to avoid
  381. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  382. */
  383. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  384. }
  385. }
  386. declare module "babylonjs/Misc/precisionDate" {
  387. /**
  388. * Class containing a set of static utilities functions for precision date
  389. */
  390. export class PrecisionDate {
  391. /**
  392. * Gets either window.performance.now() if supported or Date.now() else
  393. */
  394. static readonly Now: number;
  395. }
  396. }
  397. declare module "babylonjs/Misc/devTools" {
  398. /** @hidden */
  399. export class _DevTools {
  400. static WarnImport(name: string): string;
  401. }
  402. }
  403. declare module "babylonjs/Misc/webRequest" {
  404. /**
  405. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  406. */
  407. export class WebRequest {
  408. private _xhr;
  409. /**
  410. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  411. * i.e. when loading files, where the server/service expects an Authorization header
  412. */
  413. static CustomRequestHeaders: {
  414. [key: string]: string;
  415. };
  416. /**
  417. * Add callback functions in this array to update all the requests before they get sent to the network
  418. */
  419. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  420. private _injectCustomRequestHeaders;
  421. /**
  422. * Gets or sets a function to be called when loading progress changes
  423. */
  424. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  425. /**
  426. * Returns client's state
  427. */
  428. readonly readyState: number;
  429. /**
  430. * Returns client's status
  431. */
  432. readonly status: number;
  433. /**
  434. * Returns client's status as a text
  435. */
  436. readonly statusText: string;
  437. /**
  438. * Returns client's response
  439. */
  440. readonly response: any;
  441. /**
  442. * Returns client's response url
  443. */
  444. readonly responseURL: string;
  445. /**
  446. * Returns client's response as text
  447. */
  448. readonly responseText: string;
  449. /**
  450. * Gets or sets the expected response type
  451. */
  452. responseType: XMLHttpRequestResponseType;
  453. /** @hidden */
  454. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  455. /** @hidden */
  456. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  457. /**
  458. * Cancels any network activity
  459. */
  460. abort(): void;
  461. /**
  462. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  463. * @param body defines an optional request body
  464. */
  465. send(body?: Document | BodyInit | null): void;
  466. /**
  467. * Sets the request method, request URL
  468. * @param method defines the method to use (GET, POST, etc..)
  469. * @param url defines the url to connect with
  470. */
  471. open(method: string, url: string): void;
  472. }
  473. }
  474. declare module "babylonjs/Misc/fileRequest" {
  475. import { Observable } from "babylonjs/Misc/observable";
  476. /**
  477. * File request interface
  478. */
  479. export interface IFileRequest {
  480. /**
  481. * Raised when the request is complete (success or error).
  482. */
  483. onCompleteObservable: Observable<IFileRequest>;
  484. /**
  485. * Aborts the request for a file.
  486. */
  487. abort: () => void;
  488. }
  489. }
  490. declare module "babylonjs/Misc/performanceMonitor" {
  491. /**
  492. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  493. */
  494. export class PerformanceMonitor {
  495. private _enabled;
  496. private _rollingFrameTime;
  497. private _lastFrameTimeMs;
  498. /**
  499. * constructor
  500. * @param frameSampleSize The number of samples required to saturate the sliding window
  501. */
  502. constructor(frameSampleSize?: number);
  503. /**
  504. * Samples current frame
  505. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  506. */
  507. sampleFrame(timeMs?: number): void;
  508. /**
  509. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  510. */
  511. readonly averageFrameTime: number;
  512. /**
  513. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  514. */
  515. readonly averageFrameTimeVariance: number;
  516. /**
  517. * Returns the frame time of the most recent frame
  518. */
  519. readonly instantaneousFrameTime: number;
  520. /**
  521. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  522. */
  523. readonly averageFPS: number;
  524. /**
  525. * Returns the average framerate in frames per second using the most recent frame time
  526. */
  527. readonly instantaneousFPS: number;
  528. /**
  529. * Returns true if enough samples have been taken to completely fill the sliding window
  530. */
  531. readonly isSaturated: boolean;
  532. /**
  533. * Enables contributions to the sliding window sample set
  534. */
  535. enable(): void;
  536. /**
  537. * Disables contributions to the sliding window sample set
  538. * Samples will not be interpolated over the disabled period
  539. */
  540. disable(): void;
  541. /**
  542. * Returns true if sampling is enabled
  543. */
  544. readonly isEnabled: boolean;
  545. /**
  546. * Resets performance monitor
  547. */
  548. reset(): void;
  549. }
  550. /**
  551. * RollingAverage
  552. *
  553. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  554. */
  555. export class RollingAverage {
  556. /**
  557. * Current average
  558. */
  559. average: number;
  560. /**
  561. * Current variance
  562. */
  563. variance: number;
  564. protected _samples: Array<number>;
  565. protected _sampleCount: number;
  566. protected _pos: number;
  567. protected _m2: number;
  568. /**
  569. * constructor
  570. * @param length The number of samples required to saturate the sliding window
  571. */
  572. constructor(length: number);
  573. /**
  574. * Adds a sample to the sample set
  575. * @param v The sample value
  576. */
  577. add(v: number): void;
  578. /**
  579. * Returns previously added values or null if outside of history or outside the sliding window domain
  580. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  581. * @return Value previously recorded with add() or null if outside of range
  582. */
  583. history(i: number): number;
  584. /**
  585. * Returns true if enough samples have been taken to completely fill the sliding window
  586. * @return true if sample-set saturated
  587. */
  588. isSaturated(): boolean;
  589. /**
  590. * Resets the rolling average (equivalent to 0 samples taken so far)
  591. */
  592. reset(): void;
  593. /**
  594. * Wraps a value around the sample range boundaries
  595. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  596. * @return Wrapped position in sample range
  597. */
  598. protected _wrapPosition(i: number): number;
  599. }
  600. }
  601. declare module "babylonjs/Misc/stringDictionary" {
  602. import { Nullable } from "babylonjs/types";
  603. /**
  604. * This class implement a typical dictionary using a string as key and the generic type T as value.
  605. * The underlying implementation relies on an associative array to ensure the best performances.
  606. * The value can be anything including 'null' but except 'undefined'
  607. */
  608. export class StringDictionary<T> {
  609. /**
  610. * This will clear this dictionary and copy the content from the 'source' one.
  611. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  612. * @param source the dictionary to take the content from and copy to this dictionary
  613. */
  614. copyFrom(source: StringDictionary<T>): void;
  615. /**
  616. * Get a value based from its key
  617. * @param key the given key to get the matching value from
  618. * @return the value if found, otherwise undefined is returned
  619. */
  620. get(key: string): T | undefined;
  621. /**
  622. * Get a value from its key or add it if it doesn't exist.
  623. * This method will ensure you that a given key/data will be present in the dictionary.
  624. * @param key the given key to get the matching value from
  625. * @param factory the factory that will create the value if the key is not present in the dictionary.
  626. * The factory will only be invoked if there's no data for the given key.
  627. * @return the value corresponding to the key.
  628. */
  629. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  630. /**
  631. * Get a value from its key if present in the dictionary otherwise add it
  632. * @param key the key to get the value from
  633. * @param val if there's no such key/value pair in the dictionary add it with this value
  634. * @return the value corresponding to the key
  635. */
  636. getOrAdd(key: string, val: T): T;
  637. /**
  638. * Check if there's a given key in the dictionary
  639. * @param key the key to check for
  640. * @return true if the key is present, false otherwise
  641. */
  642. contains(key: string): boolean;
  643. /**
  644. * Add a new key and its corresponding value
  645. * @param key the key to add
  646. * @param value the value corresponding to the key
  647. * @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
  648. */
  649. add(key: string, value: T): boolean;
  650. /**
  651. * Update a specific value associated to a key
  652. * @param key defines the key to use
  653. * @param value defines the value to store
  654. * @returns true if the value was updated (or false if the key was not found)
  655. */
  656. set(key: string, value: T): boolean;
  657. /**
  658. * Get the element of the given key and remove it from the dictionary
  659. * @param key defines the key to search
  660. * @returns the value associated with the key or null if not found
  661. */
  662. getAndRemove(key: string): Nullable<T>;
  663. /**
  664. * Remove a key/value from the dictionary.
  665. * @param key the key to remove
  666. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  667. */
  668. remove(key: string): boolean;
  669. /**
  670. * Clear the whole content of the dictionary
  671. */
  672. clear(): void;
  673. /**
  674. * Gets the current count
  675. */
  676. readonly count: number;
  677. /**
  678. * Execute a callback on each key/val of the dictionary.
  679. * Note that you can remove any element in this dictionary in the callback implementation
  680. * @param callback the callback to execute on a given key/value pair
  681. */
  682. forEach(callback: (key: string, val: T) => void): void;
  683. /**
  684. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  685. * If the callback returns null or undefined the method will iterate to the next key/value pair
  686. * Note that you can remove any element in this dictionary in the callback implementation
  687. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  688. * @returns the first item
  689. */
  690. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  691. private _count;
  692. private _data;
  693. }
  694. }
  695. declare module "babylonjs/Meshes/dataBuffer" {
  696. /**
  697. * Class used to store gfx data (like WebGLBuffer)
  698. */
  699. export class DataBuffer {
  700. /**
  701. * Gets or sets the number of objects referencing this buffer
  702. */
  703. references: number;
  704. /** Gets or sets the size of the underlying buffer */
  705. capacity: number;
  706. /**
  707. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  708. */
  709. is32Bits: boolean;
  710. /**
  711. * Gets the underlying buffer
  712. */
  713. readonly underlyingResource: any;
  714. }
  715. }
  716. declare module "babylonjs/Meshes/buffer" {
  717. import { Nullable, DataArray } from "babylonjs/types";
  718. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  719. /**
  720. * Class used to store data that will be store in GPU memory
  721. */
  722. export class Buffer {
  723. private _engine;
  724. private _buffer;
  725. /** @hidden */
  726. _data: Nullable<DataArray>;
  727. private _updatable;
  728. private _instanced;
  729. /**
  730. * Gets the byte stride.
  731. */
  732. readonly byteStride: number;
  733. /**
  734. * Constructor
  735. * @param engine the engine
  736. * @param data the data to use for this buffer
  737. * @param updatable whether the data is updatable
  738. * @param stride the stride (optional)
  739. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  740. * @param instanced whether the buffer is instanced (optional)
  741. * @param useBytes set to true if the stride in in bytes (optional)
  742. */
  743. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean);
  744. /**
  745. * Create a new VertexBuffer based on the current buffer
  746. * @param kind defines the vertex buffer kind (position, normal, etc.)
  747. * @param offset defines offset in the buffer (0 by default)
  748. * @param size defines the size in floats of attributes (position is 3 for instance)
  749. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  750. * @param instanced defines if the vertex buffer contains indexed data
  751. * @param useBytes defines if the offset and stride are in bytes
  752. * @returns the new vertex buffer
  753. */
  754. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean): VertexBuffer;
  755. /**
  756. * Gets a boolean indicating if the Buffer is updatable?
  757. * @returns true if the buffer is updatable
  758. */
  759. isUpdatable(): boolean;
  760. /**
  761. * Gets current buffer's data
  762. * @returns a DataArray or null
  763. */
  764. getData(): Nullable<DataArray>;
  765. /**
  766. * Gets underlying native buffer
  767. * @returns underlying native buffer
  768. */
  769. getBuffer(): Nullable<DataBuffer>;
  770. /**
  771. * Gets the stride in float32 units (i.e. byte stride / 4).
  772. * May not be an integer if the byte stride is not divisible by 4.
  773. * DEPRECATED. Use byteStride instead.
  774. * @returns the stride in float32 units
  775. */
  776. getStrideSize(): number;
  777. /**
  778. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  779. * @param data defines the data to store
  780. */
  781. create(data?: Nullable<DataArray>): void;
  782. /** @hidden */
  783. _rebuild(): void;
  784. /**
  785. * Update current buffer data
  786. * @param data defines the data to store
  787. */
  788. update(data: DataArray): void;
  789. /**
  790. * Updates the data directly.
  791. * @param data the new data
  792. * @param offset the new offset
  793. * @param vertexCount the vertex count (optional)
  794. * @param useBytes set to true if the offset is in bytes
  795. */
  796. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  797. /**
  798. * Release all resources
  799. */
  800. dispose(): void;
  801. }
  802. /**
  803. * Specialized buffer used to store vertex data
  804. */
  805. export class VertexBuffer {
  806. /** @hidden */
  807. _buffer: Buffer;
  808. private _kind;
  809. private _size;
  810. private _ownsBuffer;
  811. private _instanced;
  812. private _instanceDivisor;
  813. /**
  814. * The byte type.
  815. */
  816. static readonly BYTE: number;
  817. /**
  818. * The unsigned byte type.
  819. */
  820. static readonly UNSIGNED_BYTE: number;
  821. /**
  822. * The short type.
  823. */
  824. static readonly SHORT: number;
  825. /**
  826. * The unsigned short type.
  827. */
  828. static readonly UNSIGNED_SHORT: number;
  829. /**
  830. * The integer type.
  831. */
  832. static readonly INT: number;
  833. /**
  834. * The unsigned integer type.
  835. */
  836. static readonly UNSIGNED_INT: number;
  837. /**
  838. * The float type.
  839. */
  840. static readonly FLOAT: number;
  841. /**
  842. * Gets or sets the instance divisor when in instanced mode
  843. */
  844. instanceDivisor: number;
  845. /**
  846. * Gets the byte stride.
  847. */
  848. readonly byteStride: number;
  849. /**
  850. * Gets the byte offset.
  851. */
  852. readonly byteOffset: number;
  853. /**
  854. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  855. */
  856. readonly normalized: boolean;
  857. /**
  858. * Gets the data type of each component in the array.
  859. */
  860. readonly type: number;
  861. /**
  862. * Constructor
  863. * @param engine the engine
  864. * @param data the data to use for this vertex buffer
  865. * @param kind the vertex buffer kind
  866. * @param updatable whether the data is updatable
  867. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  868. * @param stride the stride (optional)
  869. * @param instanced whether the buffer is instanced (optional)
  870. * @param offset the offset of the data (optional)
  871. * @param size the number of components (optional)
  872. * @param type the type of the component (optional)
  873. * @param normalized whether the data contains normalized data (optional)
  874. * @param useBytes set to true if stride and offset are in bytes (optional)
  875. */
  876. 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);
  877. /** @hidden */
  878. _rebuild(): void;
  879. /**
  880. * Returns the kind of the VertexBuffer (string)
  881. * @returns a string
  882. */
  883. getKind(): string;
  884. /**
  885. * Gets a boolean indicating if the VertexBuffer is updatable?
  886. * @returns true if the buffer is updatable
  887. */
  888. isUpdatable(): boolean;
  889. /**
  890. * Gets current buffer's data
  891. * @returns a DataArray or null
  892. */
  893. getData(): Nullable<DataArray>;
  894. /**
  895. * Gets underlying native buffer
  896. * @returns underlying native buffer
  897. */
  898. getBuffer(): Nullable<DataBuffer>;
  899. /**
  900. * Gets the stride in float32 units (i.e. byte stride / 4).
  901. * May not be an integer if the byte stride is not divisible by 4.
  902. * DEPRECATED. Use byteStride instead.
  903. * @returns the stride in float32 units
  904. */
  905. getStrideSize(): number;
  906. /**
  907. * Returns the offset as a multiple of the type byte length.
  908. * DEPRECATED. Use byteOffset instead.
  909. * @returns the offset in bytes
  910. */
  911. getOffset(): number;
  912. /**
  913. * Returns the number of components per vertex attribute (integer)
  914. * @returns the size in float
  915. */
  916. getSize(): number;
  917. /**
  918. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  919. * @returns true if this buffer is instanced
  920. */
  921. getIsInstanced(): boolean;
  922. /**
  923. * Returns the instancing divisor, zero for non-instanced (integer).
  924. * @returns a number
  925. */
  926. getInstanceDivisor(): number;
  927. /**
  928. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  929. * @param data defines the data to store
  930. */
  931. create(data?: DataArray): void;
  932. /**
  933. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  934. * This function will create a new buffer if the current one is not updatable
  935. * @param data defines the data to store
  936. */
  937. update(data: DataArray): void;
  938. /**
  939. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  940. * Returns the directly updated WebGLBuffer.
  941. * @param data the new data
  942. * @param offset the new offset
  943. * @param useBytes set to true if the offset is in bytes
  944. */
  945. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  946. /**
  947. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  948. */
  949. dispose(): void;
  950. /**
  951. * Enumerates each value of this vertex buffer as numbers.
  952. * @param count the number of values to enumerate
  953. * @param callback the callback function called for each value
  954. */
  955. forEach(count: number, callback: (value: number, index: number) => void): void;
  956. /**
  957. * Positions
  958. */
  959. static readonly PositionKind: string;
  960. /**
  961. * Normals
  962. */
  963. static readonly NormalKind: string;
  964. /**
  965. * Tangents
  966. */
  967. static readonly TangentKind: string;
  968. /**
  969. * Texture coordinates
  970. */
  971. static readonly UVKind: string;
  972. /**
  973. * Texture coordinates 2
  974. */
  975. static readonly UV2Kind: string;
  976. /**
  977. * Texture coordinates 3
  978. */
  979. static readonly UV3Kind: string;
  980. /**
  981. * Texture coordinates 4
  982. */
  983. static readonly UV4Kind: string;
  984. /**
  985. * Texture coordinates 5
  986. */
  987. static readonly UV5Kind: string;
  988. /**
  989. * Texture coordinates 6
  990. */
  991. static readonly UV6Kind: string;
  992. /**
  993. * Colors
  994. */
  995. static readonly ColorKind: string;
  996. /**
  997. * Matrix indices (for bones)
  998. */
  999. static readonly MatricesIndicesKind: string;
  1000. /**
  1001. * Matrix weights (for bones)
  1002. */
  1003. static readonly MatricesWeightsKind: string;
  1004. /**
  1005. * Additional matrix indices (for bones)
  1006. */
  1007. static readonly MatricesIndicesExtraKind: string;
  1008. /**
  1009. * Additional matrix weights (for bones)
  1010. */
  1011. static readonly MatricesWeightsExtraKind: string;
  1012. /**
  1013. * Deduces the stride given a kind.
  1014. * @param kind The kind string to deduce
  1015. * @returns The deduced stride
  1016. */
  1017. static DeduceStride(kind: string): number;
  1018. /**
  1019. * Gets the byte length of the given type.
  1020. * @param type the type
  1021. * @returns the number of bytes
  1022. */
  1023. static GetTypeByteLength(type: number): number;
  1024. /**
  1025. * Enumerates each value of the given parameters as numbers.
  1026. * @param data the data to enumerate
  1027. * @param byteOffset the byte offset of the data
  1028. * @param byteStride the byte stride of the data
  1029. * @param componentCount the number of components per element
  1030. * @param componentType the type of the component
  1031. * @param count the number of values to enumerate
  1032. * @param normalized whether the data is normalized
  1033. * @param callback the callback function called for each value
  1034. */
  1035. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  1036. private static _GetFloatValue;
  1037. }
  1038. }
  1039. declare module "babylonjs/Maths/math.scalar" {
  1040. /**
  1041. * Scalar computation library
  1042. */
  1043. export class Scalar {
  1044. /**
  1045. * Two pi constants convenient for computation.
  1046. */
  1047. static TwoPi: number;
  1048. /**
  1049. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1050. * @param a number
  1051. * @param b number
  1052. * @param epsilon (default = 1.401298E-45)
  1053. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1054. */
  1055. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1056. /**
  1057. * Returns a string : the upper case translation of the number i to hexadecimal.
  1058. * @param i number
  1059. * @returns the upper case translation of the number i to hexadecimal.
  1060. */
  1061. static ToHex(i: number): string;
  1062. /**
  1063. * Returns -1 if value is negative and +1 is value is positive.
  1064. * @param value the value
  1065. * @returns the value itself if it's equal to zero.
  1066. */
  1067. static Sign(value: number): number;
  1068. /**
  1069. * Returns the value itself if it's between min and max.
  1070. * Returns min if the value is lower than min.
  1071. * Returns max if the value is greater than max.
  1072. * @param value the value to clmap
  1073. * @param min the min value to clamp to (default: 0)
  1074. * @param max the max value to clamp to (default: 1)
  1075. * @returns the clamped value
  1076. */
  1077. static Clamp(value: number, min?: number, max?: number): number;
  1078. /**
  1079. * the log2 of value.
  1080. * @param value the value to compute log2 of
  1081. * @returns the log2 of value.
  1082. */
  1083. static Log2(value: number): number;
  1084. /**
  1085. * Loops the value, so that it is never larger than length and never smaller than 0.
  1086. *
  1087. * This is similar to the modulo operator but it works with floating point numbers.
  1088. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1089. * With t = 5 and length = 2.5, the result would be 0.0.
  1090. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1091. * @param value the value
  1092. * @param length the length
  1093. * @returns the looped value
  1094. */
  1095. static Repeat(value: number, length: number): number;
  1096. /**
  1097. * Normalize the value between 0.0 and 1.0 using min and max values
  1098. * @param value value to normalize
  1099. * @param min max to normalize between
  1100. * @param max min to normalize between
  1101. * @returns the normalized value
  1102. */
  1103. static Normalize(value: number, min: number, max: number): number;
  1104. /**
  1105. * Denormalize the value from 0.0 and 1.0 using min and max values
  1106. * @param normalized value to denormalize
  1107. * @param min max to denormalize between
  1108. * @param max min to denormalize between
  1109. * @returns the denormalized value
  1110. */
  1111. static Denormalize(normalized: number, min: number, max: number): number;
  1112. /**
  1113. * Calculates the shortest difference between two given angles given in degrees.
  1114. * @param current current angle in degrees
  1115. * @param target target angle in degrees
  1116. * @returns the delta
  1117. */
  1118. static DeltaAngle(current: number, target: number): number;
  1119. /**
  1120. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1121. * @param tx value
  1122. * @param length length
  1123. * @returns The returned value will move back and forth between 0 and length
  1124. */
  1125. static PingPong(tx: number, length: number): number;
  1126. /**
  1127. * Interpolates between min and max with smoothing at the limits.
  1128. *
  1129. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1130. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1131. * @param from from
  1132. * @param to to
  1133. * @param tx value
  1134. * @returns the smooth stepped value
  1135. */
  1136. static SmoothStep(from: number, to: number, tx: number): number;
  1137. /**
  1138. * Moves a value current towards target.
  1139. *
  1140. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1141. * Negative values of maxDelta pushes the value away from target.
  1142. * @param current current value
  1143. * @param target target value
  1144. * @param maxDelta max distance to move
  1145. * @returns resulting value
  1146. */
  1147. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1148. /**
  1149. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1150. *
  1151. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1152. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1153. * @param current current value
  1154. * @param target target value
  1155. * @param maxDelta max distance to move
  1156. * @returns resulting angle
  1157. */
  1158. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1159. /**
  1160. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1161. * @param start start value
  1162. * @param end target value
  1163. * @param amount amount to lerp between
  1164. * @returns the lerped value
  1165. */
  1166. static Lerp(start: number, end: number, amount: number): number;
  1167. /**
  1168. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1169. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1170. * @param start start value
  1171. * @param end target value
  1172. * @param amount amount to lerp between
  1173. * @returns the lerped value
  1174. */
  1175. static LerpAngle(start: number, end: number, amount: number): number;
  1176. /**
  1177. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1178. * @param a start value
  1179. * @param b target value
  1180. * @param value value between a and b
  1181. * @returns the inverseLerp value
  1182. */
  1183. static InverseLerp(a: number, b: number, value: number): number;
  1184. /**
  1185. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1186. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1187. * @param value1 spline value
  1188. * @param tangent1 spline value
  1189. * @param value2 spline value
  1190. * @param tangent2 spline value
  1191. * @param amount input value
  1192. * @returns hermite result
  1193. */
  1194. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1195. /**
  1196. * Returns a random float number between and min and max values
  1197. * @param min min value of random
  1198. * @param max max value of random
  1199. * @returns random value
  1200. */
  1201. static RandomRange(min: number, max: number): number;
  1202. /**
  1203. * This function returns percentage of a number in a given range.
  1204. *
  1205. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1206. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1207. * @param number to convert to percentage
  1208. * @param min min range
  1209. * @param max max range
  1210. * @returns the percentage
  1211. */
  1212. static RangeToPercent(number: number, min: number, max: number): number;
  1213. /**
  1214. * This function returns number that corresponds to the percentage in a given range.
  1215. *
  1216. * PercentToRange(0.34,0,100) will return 34.
  1217. * @param percent to convert to number
  1218. * @param min min range
  1219. * @param max max range
  1220. * @returns the number
  1221. */
  1222. static PercentToRange(percent: number, min: number, max: number): number;
  1223. /**
  1224. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1225. * @param angle The angle to normalize in radian.
  1226. * @return The converted angle.
  1227. */
  1228. static NormalizeRadians(angle: number): number;
  1229. }
  1230. }
  1231. declare module "babylonjs/Maths/math.constants" {
  1232. /**
  1233. * Constant used to convert a value to gamma space
  1234. * @ignorenaming
  1235. */
  1236. export const ToGammaSpace: number;
  1237. /**
  1238. * Constant used to convert a value to linear space
  1239. * @ignorenaming
  1240. */
  1241. export const ToLinearSpace = 2.2;
  1242. /**
  1243. * Constant used to define the minimal number value in Babylon.js
  1244. * @ignorenaming
  1245. */
  1246. let Epsilon: number;
  1247. export { Epsilon };
  1248. }
  1249. declare module "babylonjs/Maths/math.viewport" {
  1250. /**
  1251. * Class used to represent a viewport on screen
  1252. */
  1253. export class Viewport {
  1254. /** viewport left coordinate */
  1255. x: number;
  1256. /** viewport top coordinate */
  1257. y: number;
  1258. /**viewport width */
  1259. width: number;
  1260. /** viewport height */
  1261. height: number;
  1262. /**
  1263. * Creates a Viewport object located at (x, y) and sized (width, height)
  1264. * @param x defines viewport left coordinate
  1265. * @param y defines viewport top coordinate
  1266. * @param width defines the viewport width
  1267. * @param height defines the viewport height
  1268. */
  1269. constructor(
  1270. /** viewport left coordinate */
  1271. x: number,
  1272. /** viewport top coordinate */
  1273. y: number,
  1274. /**viewport width */
  1275. width: number,
  1276. /** viewport height */
  1277. height: number);
  1278. /**
  1279. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1280. * @param renderWidth defines the rendering width
  1281. * @param renderHeight defines the rendering height
  1282. * @returns a new Viewport
  1283. */
  1284. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1285. /**
  1286. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1287. * @param renderWidth defines the rendering width
  1288. * @param renderHeight defines the rendering height
  1289. * @param ref defines the target viewport
  1290. * @returns the current viewport
  1291. */
  1292. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1293. /**
  1294. * Returns a new Viewport copied from the current one
  1295. * @returns a new Viewport
  1296. */
  1297. clone(): Viewport;
  1298. }
  1299. }
  1300. declare module "babylonjs/Misc/arrayTools" {
  1301. /**
  1302. * Class containing a set of static utilities functions for arrays.
  1303. */
  1304. export class ArrayTools {
  1305. /**
  1306. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1307. * @param size the number of element to construct and put in the array
  1308. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1309. * @returns a new array filled with new objects
  1310. */
  1311. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1312. }
  1313. }
  1314. declare module "babylonjs/Maths/math.like" {
  1315. import { float, int, DeepImmutable } from "babylonjs/types";
  1316. /**
  1317. * @hidden
  1318. */
  1319. export interface IColor4Like {
  1320. r: float;
  1321. g: float;
  1322. b: float;
  1323. a: float;
  1324. }
  1325. /**
  1326. * @hidden
  1327. */
  1328. export interface IColor3Like {
  1329. r: float;
  1330. g: float;
  1331. b: float;
  1332. }
  1333. /**
  1334. * @hidden
  1335. */
  1336. export interface IVector4Like {
  1337. x: float;
  1338. y: float;
  1339. z: float;
  1340. w: float;
  1341. }
  1342. /**
  1343. * @hidden
  1344. */
  1345. export interface IVector3Like {
  1346. x: float;
  1347. y: float;
  1348. z: float;
  1349. }
  1350. /**
  1351. * @hidden
  1352. */
  1353. export interface IVector2Like {
  1354. x: float;
  1355. y: float;
  1356. }
  1357. /**
  1358. * @hidden
  1359. */
  1360. export interface IMatrixLike {
  1361. toArray(): DeepImmutable<Float32Array>;
  1362. updateFlag: int;
  1363. }
  1364. /**
  1365. * @hidden
  1366. */
  1367. export interface IViewportLike {
  1368. x: float;
  1369. y: float;
  1370. width: float;
  1371. height: float;
  1372. }
  1373. /**
  1374. * @hidden
  1375. */
  1376. export interface IPlaneLike {
  1377. normal: IVector3Like;
  1378. d: float;
  1379. normalize(): void;
  1380. }
  1381. }
  1382. declare module "babylonjs/Maths/math.vector" {
  1383. import { Viewport } from "babylonjs/Maths/math.viewport";
  1384. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1385. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1386. /**
  1387. * Class representing a vector containing 2 coordinates
  1388. */
  1389. export class Vector2 {
  1390. /** defines the first coordinate */
  1391. x: number;
  1392. /** defines the second coordinate */
  1393. y: number;
  1394. /**
  1395. * Creates a new Vector2 from the given x and y coordinates
  1396. * @param x defines the first coordinate
  1397. * @param y defines the second coordinate
  1398. */
  1399. constructor(
  1400. /** defines the first coordinate */
  1401. x?: number,
  1402. /** defines the second coordinate */
  1403. y?: number);
  1404. /**
  1405. * Gets a string with the Vector2 coordinates
  1406. * @returns a string with the Vector2 coordinates
  1407. */
  1408. toString(): string;
  1409. /**
  1410. * Gets class name
  1411. * @returns the string "Vector2"
  1412. */
  1413. getClassName(): string;
  1414. /**
  1415. * Gets current vector hash code
  1416. * @returns the Vector2 hash code as a number
  1417. */
  1418. getHashCode(): number;
  1419. /**
  1420. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1421. * @param array defines the source array
  1422. * @param index defines the offset in source array
  1423. * @returns the current Vector2
  1424. */
  1425. toArray(array: FloatArray, index?: number): Vector2;
  1426. /**
  1427. * Copy the current vector to an array
  1428. * @returns a new array with 2 elements: the Vector2 coordinates.
  1429. */
  1430. asArray(): number[];
  1431. /**
  1432. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1433. * @param source defines the source Vector2
  1434. * @returns the current updated Vector2
  1435. */
  1436. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1437. /**
  1438. * Sets the Vector2 coordinates with the given floats
  1439. * @param x defines the first coordinate
  1440. * @param y defines the second coordinate
  1441. * @returns the current updated Vector2
  1442. */
  1443. copyFromFloats(x: number, y: number): Vector2;
  1444. /**
  1445. * Sets the Vector2 coordinates with the given floats
  1446. * @param x defines the first coordinate
  1447. * @param y defines the second coordinate
  1448. * @returns the current updated Vector2
  1449. */
  1450. set(x: number, y: number): Vector2;
  1451. /**
  1452. * Add another vector with the current one
  1453. * @param otherVector defines the other vector
  1454. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1455. */
  1456. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1457. /**
  1458. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  1459. * @param otherVector defines the other vector
  1460. * @param result defines the target vector
  1461. * @returns the unmodified current Vector2
  1462. */
  1463. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1464. /**
  1465. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  1466. * @param otherVector defines the other vector
  1467. * @returns the current updated Vector2
  1468. */
  1469. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1470. /**
  1471. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  1472. * @param otherVector defines the other vector
  1473. * @returns a new Vector2
  1474. */
  1475. addVector3(otherVector: Vector3): Vector2;
  1476. /**
  1477. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  1478. * @param otherVector defines the other vector
  1479. * @returns a new Vector2
  1480. */
  1481. subtract(otherVector: Vector2): Vector2;
  1482. /**
  1483. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  1484. * @param otherVector defines the other vector
  1485. * @param result defines the target vector
  1486. * @returns the unmodified current Vector2
  1487. */
  1488. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1489. /**
  1490. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  1491. * @param otherVector defines the other vector
  1492. * @returns the current updated Vector2
  1493. */
  1494. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1495. /**
  1496. * Multiplies in place the current Vector2 coordinates by the given ones
  1497. * @param otherVector defines the other vector
  1498. * @returns the current updated Vector2
  1499. */
  1500. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1501. /**
  1502. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  1503. * @param otherVector defines the other vector
  1504. * @returns a new Vector2
  1505. */
  1506. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  1507. /**
  1508. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  1509. * @param otherVector defines the other vector
  1510. * @param result defines the target vector
  1511. * @returns the unmodified current Vector2
  1512. */
  1513. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1514. /**
  1515. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  1516. * @param x defines the first coordinate
  1517. * @param y defines the second coordinate
  1518. * @returns a new Vector2
  1519. */
  1520. multiplyByFloats(x: number, y: number): Vector2;
  1521. /**
  1522. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  1523. * @param otherVector defines the other vector
  1524. * @returns a new Vector2
  1525. */
  1526. divide(otherVector: Vector2): Vector2;
  1527. /**
  1528. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  1529. * @param otherVector defines the other vector
  1530. * @param result defines the target vector
  1531. * @returns the unmodified current Vector2
  1532. */
  1533. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  1534. /**
  1535. * Divides the current Vector2 coordinates by the given ones
  1536. * @param otherVector defines the other vector
  1537. * @returns the current updated Vector2
  1538. */
  1539. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  1540. /**
  1541. * Gets a new Vector2 with current Vector2 negated coordinates
  1542. * @returns a new Vector2
  1543. */
  1544. negate(): Vector2;
  1545. /**
  1546. * Multiply the Vector2 coordinates by scale
  1547. * @param scale defines the scaling factor
  1548. * @returns the current updated Vector2
  1549. */
  1550. scaleInPlace(scale: number): Vector2;
  1551. /**
  1552. * Returns a new Vector2 scaled by "scale" from the current Vector2
  1553. * @param scale defines the scaling factor
  1554. * @returns a new Vector2
  1555. */
  1556. scale(scale: number): Vector2;
  1557. /**
  1558. * Scale the current Vector2 values by a factor to a given Vector2
  1559. * @param scale defines the scale factor
  1560. * @param result defines the Vector2 object where to store the result
  1561. * @returns the unmodified current Vector2
  1562. */
  1563. scaleToRef(scale: number, result: Vector2): Vector2;
  1564. /**
  1565. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  1566. * @param scale defines the scale factor
  1567. * @param result defines the Vector2 object where to store the result
  1568. * @returns the unmodified current Vector2
  1569. */
  1570. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  1571. /**
  1572. * Gets a boolean if two vectors are equals
  1573. * @param otherVector defines the other vector
  1574. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  1575. */
  1576. equals(otherVector: DeepImmutable<Vector2>): boolean;
  1577. /**
  1578. * Gets a boolean if two vectors are equals (using an epsilon value)
  1579. * @param otherVector defines the other vector
  1580. * @param epsilon defines the minimal distance to consider equality
  1581. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  1582. */
  1583. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  1584. /**
  1585. * Gets a new Vector2 from current Vector2 floored values
  1586. * @returns a new Vector2
  1587. */
  1588. floor(): Vector2;
  1589. /**
  1590. * Gets a new Vector2 from current Vector2 floored values
  1591. * @returns a new Vector2
  1592. */
  1593. fract(): Vector2;
  1594. /**
  1595. * Gets the length of the vector
  1596. * @returns the vector length (float)
  1597. */
  1598. length(): number;
  1599. /**
  1600. * Gets the vector squared length
  1601. * @returns the vector squared length (float)
  1602. */
  1603. lengthSquared(): number;
  1604. /**
  1605. * Normalize the vector
  1606. * @returns the current updated Vector2
  1607. */
  1608. normalize(): Vector2;
  1609. /**
  1610. * Gets a new Vector2 copied from the Vector2
  1611. * @returns a new Vector2
  1612. */
  1613. clone(): Vector2;
  1614. /**
  1615. * Gets a new Vector2(0, 0)
  1616. * @returns a new Vector2
  1617. */
  1618. static Zero(): Vector2;
  1619. /**
  1620. * Gets a new Vector2(1, 1)
  1621. * @returns a new Vector2
  1622. */
  1623. static One(): Vector2;
  1624. /**
  1625. * Gets a new Vector2 set from the given index element of the given array
  1626. * @param array defines the data source
  1627. * @param offset defines the offset in the data source
  1628. * @returns a new Vector2
  1629. */
  1630. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  1631. /**
  1632. * Sets "result" from the given index element of the given array
  1633. * @param array defines the data source
  1634. * @param offset defines the offset in the data source
  1635. * @param result defines the target vector
  1636. */
  1637. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  1638. /**
  1639. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  1640. * @param value1 defines 1st point of control
  1641. * @param value2 defines 2nd point of control
  1642. * @param value3 defines 3rd point of control
  1643. * @param value4 defines 4th point of control
  1644. * @param amount defines the interpolation factor
  1645. * @returns a new Vector2
  1646. */
  1647. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  1648. /**
  1649. * 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".
  1650. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  1651. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  1652. * @param value defines the value to clamp
  1653. * @param min defines the lower limit
  1654. * @param max defines the upper limit
  1655. * @returns a new Vector2
  1656. */
  1657. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  1658. /**
  1659. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  1660. * @param value1 defines the 1st control point
  1661. * @param tangent1 defines the outgoing tangent
  1662. * @param value2 defines the 2nd control point
  1663. * @param tangent2 defines the incoming tangent
  1664. * @param amount defines the interpolation factor
  1665. * @returns a new Vector2
  1666. */
  1667. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  1668. /**
  1669. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  1670. * @param start defines the start vector
  1671. * @param end defines the end vector
  1672. * @param amount defines the interpolation factor
  1673. * @returns a new Vector2
  1674. */
  1675. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  1676. /**
  1677. * Gets the dot product of the vector "left" and the vector "right"
  1678. * @param left defines first vector
  1679. * @param right defines second vector
  1680. * @returns the dot product (float)
  1681. */
  1682. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  1683. /**
  1684. * Returns a new Vector2 equal to the normalized given vector
  1685. * @param vector defines the vector to normalize
  1686. * @returns a new Vector2
  1687. */
  1688. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  1689. /**
  1690. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  1691. * @param left defines 1st vector
  1692. * @param right defines 2nd vector
  1693. * @returns a new Vector2
  1694. */
  1695. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  1696. /**
  1697. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  1698. * @param left defines 1st vector
  1699. * @param right defines 2nd vector
  1700. * @returns a new Vector2
  1701. */
  1702. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  1703. /**
  1704. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  1705. * @param vector defines the vector to transform
  1706. * @param transformation defines the matrix to apply
  1707. * @returns a new Vector2
  1708. */
  1709. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  1710. /**
  1711. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  1712. * @param vector defines the vector to transform
  1713. * @param transformation defines the matrix to apply
  1714. * @param result defines the target vector
  1715. */
  1716. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  1717. /**
  1718. * Determines if a given vector is included in a triangle
  1719. * @param p defines the vector to test
  1720. * @param p0 defines 1st triangle point
  1721. * @param p1 defines 2nd triangle point
  1722. * @param p2 defines 3rd triangle point
  1723. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  1724. */
  1725. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  1726. /**
  1727. * Gets the distance between the vectors "value1" and "value2"
  1728. * @param value1 defines first vector
  1729. * @param value2 defines second vector
  1730. * @returns the distance between vectors
  1731. */
  1732. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  1733. /**
  1734. * Returns the squared distance between the vectors "value1" and "value2"
  1735. * @param value1 defines first vector
  1736. * @param value2 defines second vector
  1737. * @returns the squared distance between vectors
  1738. */
  1739. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  1740. /**
  1741. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  1742. * @param value1 defines first vector
  1743. * @param value2 defines second vector
  1744. * @returns a new Vector2
  1745. */
  1746. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  1747. /**
  1748. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  1749. * @param p defines the middle point
  1750. * @param segA defines one point of the segment
  1751. * @param segB defines the other point of the segment
  1752. * @returns the shortest distance
  1753. */
  1754. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  1755. }
  1756. /**
  1757. * Classed used to store (x,y,z) vector representation
  1758. * A Vector3 is the main object used in 3D geometry
  1759. * It can represent etiher the coordinates of a point the space, either a direction
  1760. * Reminder: js uses a left handed forward facing system
  1761. */
  1762. export class Vector3 {
  1763. /**
  1764. * Defines the first coordinates (on X axis)
  1765. */
  1766. x: number;
  1767. /**
  1768. * Defines the second coordinates (on Y axis)
  1769. */
  1770. y: number;
  1771. /**
  1772. * Defines the third coordinates (on Z axis)
  1773. */
  1774. z: number;
  1775. private static _UpReadOnly;
  1776. private static _ZeroReadOnly;
  1777. /**
  1778. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  1779. * @param x defines the first coordinates (on X axis)
  1780. * @param y defines the second coordinates (on Y axis)
  1781. * @param z defines the third coordinates (on Z axis)
  1782. */
  1783. constructor(
  1784. /**
  1785. * Defines the first coordinates (on X axis)
  1786. */
  1787. x?: number,
  1788. /**
  1789. * Defines the second coordinates (on Y axis)
  1790. */
  1791. y?: number,
  1792. /**
  1793. * Defines the third coordinates (on Z axis)
  1794. */
  1795. z?: number);
  1796. /**
  1797. * Creates a string representation of the Vector3
  1798. * @returns a string with the Vector3 coordinates.
  1799. */
  1800. toString(): string;
  1801. /**
  1802. * Gets the class name
  1803. * @returns the string "Vector3"
  1804. */
  1805. getClassName(): string;
  1806. /**
  1807. * Creates the Vector3 hash code
  1808. * @returns a number which tends to be unique between Vector3 instances
  1809. */
  1810. getHashCode(): number;
  1811. /**
  1812. * Creates an array containing three elements : the coordinates of the Vector3
  1813. * @returns a new array of numbers
  1814. */
  1815. asArray(): number[];
  1816. /**
  1817. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  1818. * @param array defines the destination array
  1819. * @param index defines the offset in the destination array
  1820. * @returns the current Vector3
  1821. */
  1822. toArray(array: FloatArray, index?: number): Vector3;
  1823. /**
  1824. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  1825. * @returns a new Quaternion object, computed from the Vector3 coordinates
  1826. */
  1827. toQuaternion(): Quaternion;
  1828. /**
  1829. * Adds the given vector to the current Vector3
  1830. * @param otherVector defines the second operand
  1831. * @returns the current updated Vector3
  1832. */
  1833. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  1834. /**
  1835. * Adds the given coordinates to the current Vector3
  1836. * @param x defines the x coordinate of the operand
  1837. * @param y defines the y coordinate of the operand
  1838. * @param z defines the z coordinate of the operand
  1839. * @returns the current updated Vector3
  1840. */
  1841. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  1842. /**
  1843. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  1844. * @param otherVector defines the second operand
  1845. * @returns the resulting Vector3
  1846. */
  1847. add(otherVector: DeepImmutable<Vector3>): Vector3;
  1848. /**
  1849. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  1850. * @param otherVector defines the second operand
  1851. * @param result defines the Vector3 object where to store the result
  1852. * @returns the current Vector3
  1853. */
  1854. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1855. /**
  1856. * Subtract the given vector from the current Vector3
  1857. * @param otherVector defines the second operand
  1858. * @returns the current updated Vector3
  1859. */
  1860. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  1861. /**
  1862. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  1863. * @param otherVector defines the second operand
  1864. * @returns the resulting Vector3
  1865. */
  1866. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  1867. /**
  1868. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  1869. * @param otherVector defines the second operand
  1870. * @param result defines the Vector3 object where to store the result
  1871. * @returns the current Vector3
  1872. */
  1873. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1874. /**
  1875. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  1876. * @param x defines the x coordinate of the operand
  1877. * @param y defines the y coordinate of the operand
  1878. * @param z defines the z coordinate of the operand
  1879. * @returns the resulting Vector3
  1880. */
  1881. subtractFromFloats(x: number, y: number, z: number): Vector3;
  1882. /**
  1883. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  1884. * @param x defines the x coordinate of the operand
  1885. * @param y defines the y coordinate of the operand
  1886. * @param z defines the z coordinate of the operand
  1887. * @param result defines the Vector3 object where to store the result
  1888. * @returns the current Vector3
  1889. */
  1890. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  1891. /**
  1892. * Gets a new Vector3 set with the current Vector3 negated coordinates
  1893. * @returns a new Vector3
  1894. */
  1895. negate(): Vector3;
  1896. /**
  1897. * Multiplies the Vector3 coordinates by the float "scale"
  1898. * @param scale defines the multiplier factor
  1899. * @returns the current updated Vector3
  1900. */
  1901. scaleInPlace(scale: number): Vector3;
  1902. /**
  1903. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  1904. * @param scale defines the multiplier factor
  1905. * @returns a new Vector3
  1906. */
  1907. scale(scale: number): Vector3;
  1908. /**
  1909. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  1910. * @param scale defines the multiplier factor
  1911. * @param result defines the Vector3 object where to store the result
  1912. * @returns the current Vector3
  1913. */
  1914. scaleToRef(scale: number, result: Vector3): Vector3;
  1915. /**
  1916. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  1917. * @param scale defines the scale factor
  1918. * @param result defines the Vector3 object where to store the result
  1919. * @returns the unmodified current Vector3
  1920. */
  1921. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  1922. /**
  1923. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  1924. * @param otherVector defines the second operand
  1925. * @returns true if both vectors are equals
  1926. */
  1927. equals(otherVector: DeepImmutable<Vector3>): boolean;
  1928. /**
  1929. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  1930. * @param otherVector defines the second operand
  1931. * @param epsilon defines the minimal distance to define values as equals
  1932. * @returns true if both vectors are distant less than epsilon
  1933. */
  1934. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  1935. /**
  1936. * Returns true if the current Vector3 coordinates equals the given floats
  1937. * @param x defines the x coordinate of the operand
  1938. * @param y defines the y coordinate of the operand
  1939. * @param z defines the z coordinate of the operand
  1940. * @returns true if both vectors are equals
  1941. */
  1942. equalsToFloats(x: number, y: number, z: number): boolean;
  1943. /**
  1944. * Multiplies the current Vector3 coordinates by the given ones
  1945. * @param otherVector defines the second operand
  1946. * @returns the current updated Vector3
  1947. */
  1948. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  1949. /**
  1950. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  1951. * @param otherVector defines the second operand
  1952. * @returns the new Vector3
  1953. */
  1954. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  1955. /**
  1956. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  1957. * @param otherVector defines the second operand
  1958. * @param result defines the Vector3 object where to store the result
  1959. * @returns the current Vector3
  1960. */
  1961. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1962. /**
  1963. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  1964. * @param x defines the x coordinate of the operand
  1965. * @param y defines the y coordinate of the operand
  1966. * @param z defines the z coordinate of the operand
  1967. * @returns the new Vector3
  1968. */
  1969. multiplyByFloats(x: number, y: number, z: number): Vector3;
  1970. /**
  1971. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  1972. * @param otherVector defines the second operand
  1973. * @returns the new Vector3
  1974. */
  1975. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  1976. /**
  1977. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  1978. * @param otherVector defines the second operand
  1979. * @param result defines the Vector3 object where to store the result
  1980. * @returns the current Vector3
  1981. */
  1982. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  1983. /**
  1984. * Divides the current Vector3 coordinates by the given ones.
  1985. * @param otherVector defines the second operand
  1986. * @returns the current updated Vector3
  1987. */
  1988. divideInPlace(otherVector: Vector3): Vector3;
  1989. /**
  1990. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  1991. * @param other defines the second operand
  1992. * @returns the current updated Vector3
  1993. */
  1994. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  1995. /**
  1996. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  1997. * @param other defines the second operand
  1998. * @returns the current updated Vector3
  1999. */
  2000. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2001. /**
  2002. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2003. * @param x defines the x coordinate of the operand
  2004. * @param y defines the y coordinate of the operand
  2005. * @param z defines the z coordinate of the operand
  2006. * @returns the current updated Vector3
  2007. */
  2008. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2009. /**
  2010. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2011. * @param x defines the x coordinate of the operand
  2012. * @param y defines the y coordinate of the operand
  2013. * @param z defines the z coordinate of the operand
  2014. * @returns the current updated Vector3
  2015. */
  2016. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2017. /**
  2018. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2019. * Check if is non uniform within a certain amount of decimal places to account for this
  2020. * @param epsilon the amount the values can differ
  2021. * @returns if the the vector is non uniform to a certain number of decimal places
  2022. */
  2023. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2024. /**
  2025. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2026. */
  2027. readonly isNonUniform: boolean;
  2028. /**
  2029. * Gets a new Vector3 from current Vector3 floored values
  2030. * @returns a new Vector3
  2031. */
  2032. floor(): Vector3;
  2033. /**
  2034. * Gets a new Vector3 from current Vector3 floored values
  2035. * @returns a new Vector3
  2036. */
  2037. fract(): Vector3;
  2038. /**
  2039. * Gets the length of the Vector3
  2040. * @returns the length of the Vector3
  2041. */
  2042. length(): number;
  2043. /**
  2044. * Gets the squared length of the Vector3
  2045. * @returns squared length of the Vector3
  2046. */
  2047. lengthSquared(): number;
  2048. /**
  2049. * Normalize the current Vector3.
  2050. * Please note that this is an in place operation.
  2051. * @returns the current updated Vector3
  2052. */
  2053. normalize(): Vector3;
  2054. /**
  2055. * Reorders the x y z properties of the vector in place
  2056. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2057. * @returns the current updated vector
  2058. */
  2059. reorderInPlace(order: string): this;
  2060. /**
  2061. * Rotates the vector around 0,0,0 by a quaternion
  2062. * @param quaternion the rotation quaternion
  2063. * @param result vector to store the result
  2064. * @returns the resulting vector
  2065. */
  2066. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2067. /**
  2068. * Rotates a vector around a given point
  2069. * @param quaternion the rotation quaternion
  2070. * @param point the point to rotate around
  2071. * @param result vector to store the result
  2072. * @returns the resulting vector
  2073. */
  2074. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2075. /**
  2076. * Normalize the current Vector3 with the given input length.
  2077. * Please note that this is an in place operation.
  2078. * @param len the length of the vector
  2079. * @returns the current updated Vector3
  2080. */
  2081. normalizeFromLength(len: number): Vector3;
  2082. /**
  2083. * Normalize the current Vector3 to a new vector
  2084. * @returns the new Vector3
  2085. */
  2086. normalizeToNew(): Vector3;
  2087. /**
  2088. * Normalize the current Vector3 to the reference
  2089. * @param reference define the Vector3 to update
  2090. * @returns the updated Vector3
  2091. */
  2092. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2093. /**
  2094. * Creates a new Vector3 copied from the current Vector3
  2095. * @returns the new Vector3
  2096. */
  2097. clone(): Vector3;
  2098. /**
  2099. * Copies the given vector coordinates to the current Vector3 ones
  2100. * @param source defines the source Vector3
  2101. * @returns the current updated Vector3
  2102. */
  2103. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2104. /**
  2105. * Copies the given floats to the current Vector3 coordinates
  2106. * @param x defines the x coordinate of the operand
  2107. * @param y defines the y coordinate of the operand
  2108. * @param z defines the z coordinate of the operand
  2109. * @returns the current updated Vector3
  2110. */
  2111. copyFromFloats(x: number, y: number, z: number): Vector3;
  2112. /**
  2113. * Copies the given floats to the current Vector3 coordinates
  2114. * @param x defines the x coordinate of the operand
  2115. * @param y defines the y coordinate of the operand
  2116. * @param z defines the z coordinate of the operand
  2117. * @returns the current updated Vector3
  2118. */
  2119. set(x: number, y: number, z: number): Vector3;
  2120. /**
  2121. * Copies the given float to the current Vector3 coordinates
  2122. * @param v defines the x, y and z coordinates of the operand
  2123. * @returns the current updated Vector3
  2124. */
  2125. setAll(v: number): Vector3;
  2126. /**
  2127. * Get the clip factor between two vectors
  2128. * @param vector0 defines the first operand
  2129. * @param vector1 defines the second operand
  2130. * @param axis defines the axis to use
  2131. * @param size defines the size along the axis
  2132. * @returns the clip factor
  2133. */
  2134. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2135. /**
  2136. * Get angle between two vectors
  2137. * @param vector0 angle between vector0 and vector1
  2138. * @param vector1 angle between vector0 and vector1
  2139. * @param normal direction of the normal
  2140. * @return the angle between vector0 and vector1
  2141. */
  2142. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2143. /**
  2144. * Returns a new Vector3 set from the index "offset" of the given array
  2145. * @param array defines the source array
  2146. * @param offset defines the offset in the source array
  2147. * @returns the new Vector3
  2148. */
  2149. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2150. /**
  2151. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2152. * This function is deprecated. Use FromArray instead
  2153. * @param array defines the source array
  2154. * @param offset defines the offset in the source array
  2155. * @returns the new Vector3
  2156. */
  2157. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2158. /**
  2159. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2160. * @param array defines the source array
  2161. * @param offset defines the offset in the source array
  2162. * @param result defines the Vector3 where to store the result
  2163. */
  2164. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2165. /**
  2166. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2167. * This function is deprecated. Use FromArrayToRef instead.
  2168. * @param array defines the source array
  2169. * @param offset defines the offset in the source array
  2170. * @param result defines the Vector3 where to store the result
  2171. */
  2172. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2173. /**
  2174. * Sets the given vector "result" with the given floats.
  2175. * @param x defines the x coordinate of the source
  2176. * @param y defines the y coordinate of the source
  2177. * @param z defines the z coordinate of the source
  2178. * @param result defines the Vector3 where to store the result
  2179. */
  2180. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2181. /**
  2182. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2183. * @returns a new empty Vector3
  2184. */
  2185. static Zero(): Vector3;
  2186. /**
  2187. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2188. * @returns a new unit Vector3
  2189. */
  2190. static One(): Vector3;
  2191. /**
  2192. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2193. * @returns a new up Vector3
  2194. */
  2195. static Up(): Vector3;
  2196. /**
  2197. * Gets a up Vector3 that must not be updated
  2198. */
  2199. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2200. /**
  2201. * Gets a zero Vector3 that must not be updated
  2202. */
  2203. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2204. /**
  2205. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2206. * @returns a new down Vector3
  2207. */
  2208. static Down(): Vector3;
  2209. /**
  2210. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2211. * @returns a new forward Vector3
  2212. */
  2213. static Forward(): Vector3;
  2214. /**
  2215. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2216. * @returns a new forward Vector3
  2217. */
  2218. static Backward(): Vector3;
  2219. /**
  2220. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2221. * @returns a new right Vector3
  2222. */
  2223. static Right(): Vector3;
  2224. /**
  2225. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2226. * @returns a new left Vector3
  2227. */
  2228. static Left(): Vector3;
  2229. /**
  2230. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2231. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2232. * @param vector defines the Vector3 to transform
  2233. * @param transformation defines the transformation matrix
  2234. * @returns the transformed Vector3
  2235. */
  2236. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2237. /**
  2238. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2239. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2240. * @param vector defines the Vector3 to transform
  2241. * @param transformation defines the transformation matrix
  2242. * @param result defines the Vector3 where to store the result
  2243. */
  2244. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2245. /**
  2246. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2247. * This method computes tranformed coordinates only, not transformed direction vectors
  2248. * @param x define the x coordinate of the source vector
  2249. * @param y define the y coordinate of the source vector
  2250. * @param z define the z coordinate of the source vector
  2251. * @param transformation defines the transformation matrix
  2252. * @param result defines the Vector3 where to store the result
  2253. */
  2254. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2255. /**
  2256. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2257. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2258. * @param vector defines the Vector3 to transform
  2259. * @param transformation defines the transformation matrix
  2260. * @returns the new Vector3
  2261. */
  2262. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2263. /**
  2264. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2265. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2266. * @param vector defines the Vector3 to transform
  2267. * @param transformation defines the transformation matrix
  2268. * @param result defines the Vector3 where to store the result
  2269. */
  2270. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2271. /**
  2272. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2273. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2274. * @param x define the x coordinate of the source vector
  2275. * @param y define the y coordinate of the source vector
  2276. * @param z define the z coordinate of the source vector
  2277. * @param transformation defines the transformation matrix
  2278. * @param result defines the Vector3 where to store the result
  2279. */
  2280. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2281. /**
  2282. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2283. * @param value1 defines the first control point
  2284. * @param value2 defines the second control point
  2285. * @param value3 defines the third control point
  2286. * @param value4 defines the fourth control point
  2287. * @param amount defines the amount on the spline to use
  2288. * @returns the new Vector3
  2289. */
  2290. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2291. /**
  2292. * 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"
  2293. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2294. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2295. * @param value defines the current value
  2296. * @param min defines the lower range value
  2297. * @param max defines the upper range value
  2298. * @returns the new Vector3
  2299. */
  2300. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2301. /**
  2302. * 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"
  2303. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2304. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2305. * @param value defines the current value
  2306. * @param min defines the lower range value
  2307. * @param max defines the upper range value
  2308. * @param result defines the Vector3 where to store the result
  2309. */
  2310. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2311. /**
  2312. * Checks if a given vector is inside a specific range
  2313. * @param v defines the vector to test
  2314. * @param min defines the minimum range
  2315. * @param max defines the maximum range
  2316. */
  2317. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2318. /**
  2319. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2320. * @param value1 defines the first control point
  2321. * @param tangent1 defines the first tangent vector
  2322. * @param value2 defines the second control point
  2323. * @param tangent2 defines the second tangent vector
  2324. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2325. * @returns the new Vector3
  2326. */
  2327. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2328. /**
  2329. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2330. * @param start defines the start value
  2331. * @param end defines the end value
  2332. * @param amount max defines amount between both (between 0 and 1)
  2333. * @returns the new Vector3
  2334. */
  2335. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2336. /**
  2337. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2338. * @param start defines the start value
  2339. * @param end defines the end value
  2340. * @param amount max defines amount between both (between 0 and 1)
  2341. * @param result defines the Vector3 where to store the result
  2342. */
  2343. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2344. /**
  2345. * Returns the dot product (float) between the vectors "left" and "right"
  2346. * @param left defines the left operand
  2347. * @param right defines the right operand
  2348. * @returns the dot product
  2349. */
  2350. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2351. /**
  2352. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2353. * The cross product is then orthogonal to both "left" and "right"
  2354. * @param left defines the left operand
  2355. * @param right defines the right operand
  2356. * @returns the cross product
  2357. */
  2358. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2359. /**
  2360. * Sets the given vector "result" with the cross product of "left" and "right"
  2361. * The cross product is then orthogonal to both "left" and "right"
  2362. * @param left defines the left operand
  2363. * @param right defines the right operand
  2364. * @param result defines the Vector3 where to store the result
  2365. */
  2366. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2367. /**
  2368. * Returns a new Vector3 as the normalization of the given vector
  2369. * @param vector defines the Vector3 to normalize
  2370. * @returns the new Vector3
  2371. */
  2372. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2373. /**
  2374. * Sets the given vector "result" with the normalization of the given first vector
  2375. * @param vector defines the Vector3 to normalize
  2376. * @param result defines the Vector3 where to store the result
  2377. */
  2378. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2379. /**
  2380. * Project a Vector3 onto screen space
  2381. * @param vector defines the Vector3 to project
  2382. * @param world defines the world matrix to use
  2383. * @param transform defines the transform (view x projection) matrix to use
  2384. * @param viewport defines the screen viewport to use
  2385. * @returns the new Vector3
  2386. */
  2387. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2388. /** @hidden */
  2389. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2390. /**
  2391. * Unproject from screen space to object space
  2392. * @param source defines the screen space Vector3 to use
  2393. * @param viewportWidth defines the current width of the viewport
  2394. * @param viewportHeight defines the current height of the viewport
  2395. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2396. * @param transform defines the transform (view x projection) matrix to use
  2397. * @returns the new Vector3
  2398. */
  2399. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2400. /**
  2401. * Unproject from screen space to object space
  2402. * @param source defines the screen space Vector3 to use
  2403. * @param viewportWidth defines the current width of the viewport
  2404. * @param viewportHeight defines the current height of the viewport
  2405. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2406. * @param view defines the view matrix to use
  2407. * @param projection defines the projection matrix to use
  2408. * @returns the new Vector3
  2409. */
  2410. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2411. /**
  2412. * Unproject from screen space to object space
  2413. * @param source defines the screen space Vector3 to use
  2414. * @param viewportWidth defines the current width of the viewport
  2415. * @param viewportHeight defines the current height of the viewport
  2416. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2417. * @param view defines the view matrix to use
  2418. * @param projection defines the projection matrix to use
  2419. * @param result defines the Vector3 where to store the result
  2420. */
  2421. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2422. /**
  2423. * Unproject from screen space to object space
  2424. * @param sourceX defines the screen space x coordinate to use
  2425. * @param sourceY defines the screen space y coordinate to use
  2426. * @param sourceZ defines the screen space z coordinate to use
  2427. * @param viewportWidth defines the current width of the viewport
  2428. * @param viewportHeight defines the current height of the viewport
  2429. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2430. * @param view defines the view matrix to use
  2431. * @param projection defines the projection matrix to use
  2432. * @param result defines the Vector3 where to store the result
  2433. */
  2434. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2435. /**
  2436. * Gets the minimal coordinate values between two Vector3
  2437. * @param left defines the first operand
  2438. * @param right defines the second operand
  2439. * @returns the new Vector3
  2440. */
  2441. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2442. /**
  2443. * Gets the maximal coordinate values between two Vector3
  2444. * @param left defines the first operand
  2445. * @param right defines the second operand
  2446. * @returns the new Vector3
  2447. */
  2448. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2449. /**
  2450. * Returns the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines the first operand
  2452. * @param value2 defines the second operand
  2453. * @returns the distance
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines the first operand
  2459. * @param value2 defines the second operand
  2460. * @returns the squared distance
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  2463. /**
  2464. * Returns a new Vector3 located at the center between "value1" and "value2"
  2465. * @param value1 defines the first operand
  2466. * @param value2 defines the second operand
  2467. * @returns the new Vector3
  2468. */
  2469. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  2470. /**
  2471. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  2472. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  2473. * to something in order to rotate it from its local system to the given target system
  2474. * Note: axis1, axis2 and axis3 are normalized during this operation
  2475. * @param axis1 defines the first axis
  2476. * @param axis2 defines the second axis
  2477. * @param axis3 defines the third axis
  2478. * @returns a new Vector3
  2479. */
  2480. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  2481. /**
  2482. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  2483. * @param axis1 defines the first axis
  2484. * @param axis2 defines the second axis
  2485. * @param axis3 defines the third axis
  2486. * @param ref defines the Vector3 where to store the result
  2487. */
  2488. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  2489. }
  2490. /**
  2491. * Vector4 class created for EulerAngle class conversion to Quaternion
  2492. */
  2493. export class Vector4 {
  2494. /** x value of the vector */
  2495. x: number;
  2496. /** y value of the vector */
  2497. y: number;
  2498. /** z value of the vector */
  2499. z: number;
  2500. /** w value of the vector */
  2501. w: number;
  2502. /**
  2503. * Creates a Vector4 object from the given floats.
  2504. * @param x x value of the vector
  2505. * @param y y value of the vector
  2506. * @param z z value of the vector
  2507. * @param w w value of the vector
  2508. */
  2509. constructor(
  2510. /** x value of the vector */
  2511. x: number,
  2512. /** y value of the vector */
  2513. y: number,
  2514. /** z value of the vector */
  2515. z: number,
  2516. /** w value of the vector */
  2517. w: number);
  2518. /**
  2519. * Returns the string with the Vector4 coordinates.
  2520. * @returns a string containing all the vector values
  2521. */
  2522. toString(): string;
  2523. /**
  2524. * Returns the string "Vector4".
  2525. * @returns "Vector4"
  2526. */
  2527. getClassName(): string;
  2528. /**
  2529. * Returns the Vector4 hash code.
  2530. * @returns a unique hash code
  2531. */
  2532. getHashCode(): number;
  2533. /**
  2534. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  2535. * @returns the resulting array
  2536. */
  2537. asArray(): number[];
  2538. /**
  2539. * Populates the given array from the given index with the Vector4 coordinates.
  2540. * @param array array to populate
  2541. * @param index index of the array to start at (default: 0)
  2542. * @returns the Vector4.
  2543. */
  2544. toArray(array: FloatArray, index?: number): Vector4;
  2545. /**
  2546. * Adds the given vector to the current Vector4.
  2547. * @param otherVector the vector to add
  2548. * @returns the updated Vector4.
  2549. */
  2550. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  2551. /**
  2552. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  2553. * @param otherVector the vector to add
  2554. * @returns the resulting vector
  2555. */
  2556. add(otherVector: DeepImmutable<Vector4>): Vector4;
  2557. /**
  2558. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  2559. * @param otherVector the vector to add
  2560. * @param result the vector to store the result
  2561. * @returns the current Vector4.
  2562. */
  2563. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2564. /**
  2565. * Subtract in place the given vector from the current Vector4.
  2566. * @param otherVector the vector to subtract
  2567. * @returns the updated Vector4.
  2568. */
  2569. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  2570. /**
  2571. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  2572. * @param otherVector the vector to add
  2573. * @returns the new vector with the result
  2574. */
  2575. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  2576. /**
  2577. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  2578. * @param otherVector the vector to subtract
  2579. * @param result the vector to store the result
  2580. * @returns the current Vector4.
  2581. */
  2582. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2583. /**
  2584. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  2585. */
  2586. /**
  2587. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  2588. * @param x value to subtract
  2589. * @param y value to subtract
  2590. * @param z value to subtract
  2591. * @param w value to subtract
  2592. * @returns new vector containing the result
  2593. */
  2594. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  2595. /**
  2596. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  2597. * @param x value to subtract
  2598. * @param y value to subtract
  2599. * @param z value to subtract
  2600. * @param w value to subtract
  2601. * @param result the vector to store the result in
  2602. * @returns the current Vector4.
  2603. */
  2604. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  2605. /**
  2606. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  2607. * @returns a new vector with the negated values
  2608. */
  2609. negate(): Vector4;
  2610. /**
  2611. * Multiplies the current Vector4 coordinates by scale (float).
  2612. * @param scale the number to scale with
  2613. * @returns the updated Vector4.
  2614. */
  2615. scaleInPlace(scale: number): Vector4;
  2616. /**
  2617. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  2618. * @param scale the number to scale with
  2619. * @returns a new vector with the result
  2620. */
  2621. scale(scale: number): Vector4;
  2622. /**
  2623. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  2624. * @param scale the number to scale with
  2625. * @param result a vector to store the result in
  2626. * @returns the current Vector4.
  2627. */
  2628. scaleToRef(scale: number, result: Vector4): Vector4;
  2629. /**
  2630. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  2631. * @param scale defines the scale factor
  2632. * @param result defines the Vector4 object where to store the result
  2633. * @returns the unmodified current Vector4
  2634. */
  2635. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  2636. /**
  2637. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  2638. * @param otherVector the vector to compare against
  2639. * @returns true if they are equal
  2640. */
  2641. equals(otherVector: DeepImmutable<Vector4>): boolean;
  2642. /**
  2643. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  2644. * @param otherVector vector to compare against
  2645. * @param epsilon (Default: very small number)
  2646. * @returns true if they are equal
  2647. */
  2648. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  2649. /**
  2650. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  2651. * @param x x value to compare against
  2652. * @param y y value to compare against
  2653. * @param z z value to compare against
  2654. * @param w w value to compare against
  2655. * @returns true if equal
  2656. */
  2657. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  2658. /**
  2659. * Multiplies in place the current Vector4 by the given one.
  2660. * @param otherVector vector to multiple with
  2661. * @returns the updated Vector4.
  2662. */
  2663. multiplyInPlace(otherVector: Vector4): Vector4;
  2664. /**
  2665. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  2666. * @param otherVector vector to multiple with
  2667. * @returns resulting new vector
  2668. */
  2669. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  2670. /**
  2671. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  2672. * @param otherVector vector to multiple with
  2673. * @param result vector to store the result
  2674. * @returns the current Vector4.
  2675. */
  2676. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2677. /**
  2678. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  2679. * @param x x value multiply with
  2680. * @param y y value multiply with
  2681. * @param z z value multiply with
  2682. * @param w w value multiply with
  2683. * @returns resulting new vector
  2684. */
  2685. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  2686. /**
  2687. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  2688. * @param otherVector vector to devide with
  2689. * @returns resulting new vector
  2690. */
  2691. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  2692. /**
  2693. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  2694. * @param otherVector vector to devide with
  2695. * @param result vector to store the result
  2696. * @returns the current Vector4.
  2697. */
  2698. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  2699. /**
  2700. * Divides the current Vector3 coordinates by the given ones.
  2701. * @param otherVector vector to devide with
  2702. * @returns the updated Vector3.
  2703. */
  2704. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  2705. /**
  2706. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  2707. * @param other defines the second operand
  2708. * @returns the current updated Vector4
  2709. */
  2710. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  2711. /**
  2712. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  2713. * @param other defines the second operand
  2714. * @returns the current updated Vector4
  2715. */
  2716. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  2717. /**
  2718. * Gets a new Vector4 from current Vector4 floored values
  2719. * @returns a new Vector4
  2720. */
  2721. floor(): Vector4;
  2722. /**
  2723. * Gets a new Vector4 from current Vector3 floored values
  2724. * @returns a new Vector4
  2725. */
  2726. fract(): Vector4;
  2727. /**
  2728. * Returns the Vector4 length (float).
  2729. * @returns the length
  2730. */
  2731. length(): number;
  2732. /**
  2733. * Returns the Vector4 squared length (float).
  2734. * @returns the length squared
  2735. */
  2736. lengthSquared(): number;
  2737. /**
  2738. * Normalizes in place the Vector4.
  2739. * @returns the updated Vector4.
  2740. */
  2741. normalize(): Vector4;
  2742. /**
  2743. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  2744. * @returns this converted to a new vector3
  2745. */
  2746. toVector3(): Vector3;
  2747. /**
  2748. * Returns a new Vector4 copied from the current one.
  2749. * @returns the new cloned vector
  2750. */
  2751. clone(): Vector4;
  2752. /**
  2753. * Updates the current Vector4 with the given one coordinates.
  2754. * @param source the source vector to copy from
  2755. * @returns the updated Vector4.
  2756. */
  2757. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  2758. /**
  2759. * Updates the current Vector4 coordinates with the given floats.
  2760. * @param x float to copy from
  2761. * @param y float to copy from
  2762. * @param z float to copy from
  2763. * @param w float to copy from
  2764. * @returns the updated Vector4.
  2765. */
  2766. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  2767. /**
  2768. * Updates the current Vector4 coordinates with the given floats.
  2769. * @param x float to set from
  2770. * @param y float to set from
  2771. * @param z float to set from
  2772. * @param w float to set from
  2773. * @returns the updated Vector4.
  2774. */
  2775. set(x: number, y: number, z: number, w: number): Vector4;
  2776. /**
  2777. * Copies the given float to the current Vector3 coordinates
  2778. * @param v defines the x, y, z and w coordinates of the operand
  2779. * @returns the current updated Vector3
  2780. */
  2781. setAll(v: number): Vector4;
  2782. /**
  2783. * Returns a new Vector4 set from the starting index of the given array.
  2784. * @param array the array to pull values from
  2785. * @param offset the offset into the array to start at
  2786. * @returns the new vector
  2787. */
  2788. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  2789. /**
  2790. * Updates the given vector "result" from the starting index of the given array.
  2791. * @param array the array to pull values from
  2792. * @param offset the offset into the array to start at
  2793. * @param result the vector to store the result in
  2794. */
  2795. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  2796. /**
  2797. * Updates the given vector "result" from the starting index of the given Float32Array.
  2798. * @param array the array to pull values from
  2799. * @param offset the offset into the array to start at
  2800. * @param result the vector to store the result in
  2801. */
  2802. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  2803. /**
  2804. * Updates the given vector "result" coordinates from the given floats.
  2805. * @param x float to set from
  2806. * @param y float to set from
  2807. * @param z float to set from
  2808. * @param w float to set from
  2809. * @param result the vector to the floats in
  2810. */
  2811. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  2812. /**
  2813. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  2814. * @returns the new vector
  2815. */
  2816. static Zero(): Vector4;
  2817. /**
  2818. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  2819. * @returns the new vector
  2820. */
  2821. static One(): Vector4;
  2822. /**
  2823. * Returns a new normalized Vector4 from the given one.
  2824. * @param vector the vector to normalize
  2825. * @returns the vector
  2826. */
  2827. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  2828. /**
  2829. * Updates the given vector "result" from the normalization of the given one.
  2830. * @param vector the vector to normalize
  2831. * @param result the vector to store the result in
  2832. */
  2833. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  2834. /**
  2835. * Returns a vector with the minimum values from the left and right vectors
  2836. * @param left left vector to minimize
  2837. * @param right right vector to minimize
  2838. * @returns a new vector with the minimum of the left and right vector values
  2839. */
  2840. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  2841. /**
  2842. * Returns a vector with the maximum values from the left and right vectors
  2843. * @param left left vector to maximize
  2844. * @param right right vector to maximize
  2845. * @returns a new vector with the maximum of the left and right vector values
  2846. */
  2847. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  2848. /**
  2849. * Returns the distance (float) between the vectors "value1" and "value2".
  2850. * @param value1 value to calulate the distance between
  2851. * @param value2 value to calulate the distance between
  2852. * @return the distance between the two vectors
  2853. */
  2854. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  2855. /**
  2856. * Returns the squared distance (float) between the vectors "value1" and "value2".
  2857. * @param value1 value to calulate the distance between
  2858. * @param value2 value to calulate the distance between
  2859. * @return the distance between the two vectors squared
  2860. */
  2861. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  2862. /**
  2863. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  2864. * @param value1 value to calulate the center between
  2865. * @param value2 value to calulate the center between
  2866. * @return the center between the two vectors
  2867. */
  2868. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  2869. /**
  2870. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  2871. * This methods computes transformed normalized direction vectors only.
  2872. * @param vector the vector to transform
  2873. * @param transformation the transformation matrix to apply
  2874. * @returns the new vector
  2875. */
  2876. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  2877. /**
  2878. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  2879. * This methods computes transformed normalized direction vectors only.
  2880. * @param vector the vector to transform
  2881. * @param transformation the transformation matrix to apply
  2882. * @param result the vector to store the result in
  2883. */
  2884. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  2885. /**
  2886. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  2887. * This methods computes transformed normalized direction vectors only.
  2888. * @param x value to transform
  2889. * @param y value to transform
  2890. * @param z value to transform
  2891. * @param w value to transform
  2892. * @param transformation the transformation matrix to apply
  2893. * @param result the vector to store the results in
  2894. */
  2895. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  2896. /**
  2897. * Creates a new Vector4 from a Vector3
  2898. * @param source defines the source data
  2899. * @param w defines the 4th component (default is 0)
  2900. * @returns a new Vector4
  2901. */
  2902. static FromVector3(source: Vector3, w?: number): Vector4;
  2903. }
  2904. /**
  2905. * Class used to store quaternion data
  2906. * @see https://en.wikipedia.org/wiki/Quaternion
  2907. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  2908. */
  2909. export class Quaternion {
  2910. /** defines the first component (0 by default) */
  2911. x: number;
  2912. /** defines the second component (0 by default) */
  2913. y: number;
  2914. /** defines the third component (0 by default) */
  2915. z: number;
  2916. /** defines the fourth component (1.0 by default) */
  2917. w: number;
  2918. /**
  2919. * Creates a new Quaternion from the given floats
  2920. * @param x defines the first component (0 by default)
  2921. * @param y defines the second component (0 by default)
  2922. * @param z defines the third component (0 by default)
  2923. * @param w defines the fourth component (1.0 by default)
  2924. */
  2925. constructor(
  2926. /** defines the first component (0 by default) */
  2927. x?: number,
  2928. /** defines the second component (0 by default) */
  2929. y?: number,
  2930. /** defines the third component (0 by default) */
  2931. z?: number,
  2932. /** defines the fourth component (1.0 by default) */
  2933. w?: number);
  2934. /**
  2935. * Gets a string representation for the current quaternion
  2936. * @returns a string with the Quaternion coordinates
  2937. */
  2938. toString(): string;
  2939. /**
  2940. * Gets the class name of the quaternion
  2941. * @returns the string "Quaternion"
  2942. */
  2943. getClassName(): string;
  2944. /**
  2945. * Gets a hash code for this quaternion
  2946. * @returns the quaternion hash code
  2947. */
  2948. getHashCode(): number;
  2949. /**
  2950. * Copy the quaternion to an array
  2951. * @returns a new array populated with 4 elements from the quaternion coordinates
  2952. */
  2953. asArray(): number[];
  2954. /**
  2955. * Check if two quaternions are equals
  2956. * @param otherQuaternion defines the second operand
  2957. * @return true if the current quaternion and the given one coordinates are strictly equals
  2958. */
  2959. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  2960. /**
  2961. * Clone the current quaternion
  2962. * @returns a new quaternion copied from the current one
  2963. */
  2964. clone(): Quaternion;
  2965. /**
  2966. * Copy a quaternion to the current one
  2967. * @param other defines the other quaternion
  2968. * @returns the updated current quaternion
  2969. */
  2970. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  2971. /**
  2972. * Updates the current quaternion with the given float coordinates
  2973. * @param x defines the x coordinate
  2974. * @param y defines the y coordinate
  2975. * @param z defines the z coordinate
  2976. * @param w defines the w coordinate
  2977. * @returns the updated current quaternion
  2978. */
  2979. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  2980. /**
  2981. * Updates the current quaternion from the given float coordinates
  2982. * @param x defines the x coordinate
  2983. * @param y defines the y coordinate
  2984. * @param z defines the z coordinate
  2985. * @param w defines the w coordinate
  2986. * @returns the updated current quaternion
  2987. */
  2988. set(x: number, y: number, z: number, w: number): Quaternion;
  2989. /**
  2990. * Adds two quaternions
  2991. * @param other defines the second operand
  2992. * @returns a new quaternion as the addition result of the given one and the current quaternion
  2993. */
  2994. add(other: DeepImmutable<Quaternion>): Quaternion;
  2995. /**
  2996. * Add a quaternion to the current one
  2997. * @param other defines the quaternion to add
  2998. * @returns the current quaternion
  2999. */
  3000. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3001. /**
  3002. * Subtract two quaternions
  3003. * @param other defines the second operand
  3004. * @returns a new quaternion as the subtraction result of the given one from the current one
  3005. */
  3006. subtract(other: Quaternion): Quaternion;
  3007. /**
  3008. * Multiplies the current quaternion by a scale factor
  3009. * @param value defines the scale factor
  3010. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3011. */
  3012. scale(value: number): Quaternion;
  3013. /**
  3014. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3015. * @param scale defines the scale factor
  3016. * @param result defines the Quaternion object where to store the result
  3017. * @returns the unmodified current quaternion
  3018. */
  3019. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3020. /**
  3021. * Multiplies in place the current quaternion by a scale factor
  3022. * @param value defines the scale factor
  3023. * @returns the current modified quaternion
  3024. */
  3025. scaleInPlace(value: number): Quaternion;
  3026. /**
  3027. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3028. * @param scale defines the scale factor
  3029. * @param result defines the Quaternion object where to store the result
  3030. * @returns the unmodified current quaternion
  3031. */
  3032. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3033. /**
  3034. * Multiplies two quaternions
  3035. * @param q1 defines the second operand
  3036. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3037. */
  3038. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3039. /**
  3040. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3041. * @param q1 defines the second operand
  3042. * @param result defines the target quaternion
  3043. * @returns the current quaternion
  3044. */
  3045. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3046. /**
  3047. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3048. * @param q1 defines the second operand
  3049. * @returns the currentupdated quaternion
  3050. */
  3051. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3052. /**
  3053. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3054. * @param ref defines the target quaternion
  3055. * @returns the current quaternion
  3056. */
  3057. conjugateToRef(ref: Quaternion): Quaternion;
  3058. /**
  3059. * Conjugates in place (1-q) the current quaternion
  3060. * @returns the current updated quaternion
  3061. */
  3062. conjugateInPlace(): Quaternion;
  3063. /**
  3064. * Conjugates in place (1-q) the current quaternion
  3065. * @returns a new quaternion
  3066. */
  3067. conjugate(): Quaternion;
  3068. /**
  3069. * Gets length of current quaternion
  3070. * @returns the quaternion length (float)
  3071. */
  3072. length(): number;
  3073. /**
  3074. * Normalize in place the current quaternion
  3075. * @returns the current updated quaternion
  3076. */
  3077. normalize(): Quaternion;
  3078. /**
  3079. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3080. * @param order is a reserved parameter and is ignore for now
  3081. * @returns a new Vector3 containing the Euler angles
  3082. */
  3083. toEulerAngles(order?: string): Vector3;
  3084. /**
  3085. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3086. * @param result defines the vector which will be filled with the Euler angles
  3087. * @param order is a reserved parameter and is ignore for now
  3088. * @returns the current unchanged quaternion
  3089. */
  3090. toEulerAnglesToRef(result: Vector3): Quaternion;
  3091. /**
  3092. * Updates the given rotation matrix with the current quaternion values
  3093. * @param result defines the target matrix
  3094. * @returns the current unchanged quaternion
  3095. */
  3096. toRotationMatrix(result: Matrix): Quaternion;
  3097. /**
  3098. * Updates the current quaternion from the given rotation matrix values
  3099. * @param matrix defines the source matrix
  3100. * @returns the current updated quaternion
  3101. */
  3102. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3103. /**
  3104. * Creates a new quaternion from a rotation matrix
  3105. * @param matrix defines the source matrix
  3106. * @returns a new quaternion created from the given rotation matrix values
  3107. */
  3108. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3109. /**
  3110. * Updates the given quaternion with the given rotation matrix values
  3111. * @param matrix defines the source matrix
  3112. * @param result defines the target quaternion
  3113. */
  3114. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3115. /**
  3116. * Returns the dot product (float) between the quaternions "left" and "right"
  3117. * @param left defines the left operand
  3118. * @param right defines the right operand
  3119. * @returns the dot product
  3120. */
  3121. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3122. /**
  3123. * Checks if the two quaternions are close to each other
  3124. * @param quat0 defines the first quaternion to check
  3125. * @param quat1 defines the second quaternion to check
  3126. * @returns true if the two quaternions are close to each other
  3127. */
  3128. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3129. /**
  3130. * Creates an empty quaternion
  3131. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3132. */
  3133. static Zero(): Quaternion;
  3134. /**
  3135. * Inverse a given quaternion
  3136. * @param q defines the source quaternion
  3137. * @returns a new quaternion as the inverted current quaternion
  3138. */
  3139. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3140. /**
  3141. * Inverse a given quaternion
  3142. * @param q defines the source quaternion
  3143. * @param result the quaternion the result will be stored in
  3144. * @returns the result quaternion
  3145. */
  3146. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3147. /**
  3148. * Creates an identity quaternion
  3149. * @returns the identity quaternion
  3150. */
  3151. static Identity(): Quaternion;
  3152. /**
  3153. * Gets a boolean indicating if the given quaternion is identity
  3154. * @param quaternion defines the quaternion to check
  3155. * @returns true if the quaternion is identity
  3156. */
  3157. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3158. /**
  3159. * Creates a quaternion from a rotation around an axis
  3160. * @param axis defines the axis to use
  3161. * @param angle defines the angle to use
  3162. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3163. */
  3164. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3165. /**
  3166. * Creates a rotation around an axis and stores it into the given quaternion
  3167. * @param axis defines the axis to use
  3168. * @param angle defines the angle to use
  3169. * @param result defines the target quaternion
  3170. * @returns the target quaternion
  3171. */
  3172. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3173. /**
  3174. * Creates a new quaternion from data stored into an array
  3175. * @param array defines the data source
  3176. * @param offset defines the offset in the source array where the data starts
  3177. * @returns a new quaternion
  3178. */
  3179. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3180. /**
  3181. * Create a quaternion from Euler rotation angles
  3182. * @param x Pitch
  3183. * @param y Yaw
  3184. * @param z Roll
  3185. * @returns the new Quaternion
  3186. */
  3187. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3188. /**
  3189. * Updates a quaternion from Euler rotation angles
  3190. * @param x Pitch
  3191. * @param y Yaw
  3192. * @param z Roll
  3193. * @param result the quaternion to store the result
  3194. * @returns the updated quaternion
  3195. */
  3196. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3197. /**
  3198. * Create a quaternion from Euler rotation vector
  3199. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3200. * @returns the new Quaternion
  3201. */
  3202. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3203. /**
  3204. * Updates a quaternion from Euler rotation vector
  3205. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3206. * @param result the quaternion to store the result
  3207. * @returns the updated quaternion
  3208. */
  3209. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3210. /**
  3211. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3212. * @param yaw defines the rotation around Y axis
  3213. * @param pitch defines the rotation around X axis
  3214. * @param roll defines the rotation around Z axis
  3215. * @returns the new quaternion
  3216. */
  3217. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3218. /**
  3219. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3220. * @param yaw defines the rotation around Y axis
  3221. * @param pitch defines the rotation around X axis
  3222. * @param roll defines the rotation around Z axis
  3223. * @param result defines the target quaternion
  3224. */
  3225. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3226. /**
  3227. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3228. * @param alpha defines the rotation around first axis
  3229. * @param beta defines the rotation around second axis
  3230. * @param gamma defines the rotation around third axis
  3231. * @returns the new quaternion
  3232. */
  3233. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3234. /**
  3235. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3236. * @param alpha defines the rotation around first axis
  3237. * @param beta defines the rotation around second axis
  3238. * @param gamma defines the rotation around third axis
  3239. * @param result defines the target quaternion
  3240. */
  3241. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3242. /**
  3243. * 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)
  3244. * @param axis1 defines the first axis
  3245. * @param axis2 defines the second axis
  3246. * @param axis3 defines the third axis
  3247. * @returns the new quaternion
  3248. */
  3249. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3250. /**
  3251. * 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
  3252. * @param axis1 defines the first axis
  3253. * @param axis2 defines the second axis
  3254. * @param axis3 defines the third axis
  3255. * @param ref defines the target quaternion
  3256. */
  3257. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3258. /**
  3259. * Interpolates between two quaternions
  3260. * @param left defines first quaternion
  3261. * @param right defines second quaternion
  3262. * @param amount defines the gradient to use
  3263. * @returns the new interpolated quaternion
  3264. */
  3265. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3266. /**
  3267. * Interpolates between two quaternions and stores it into a target quaternion
  3268. * @param left defines first quaternion
  3269. * @param right defines second quaternion
  3270. * @param amount defines the gradient to use
  3271. * @param result defines the target quaternion
  3272. */
  3273. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3274. /**
  3275. * Interpolate between two quaternions using Hermite interpolation
  3276. * @param value1 defines first quaternion
  3277. * @param tangent1 defines the incoming tangent
  3278. * @param value2 defines second quaternion
  3279. * @param tangent2 defines the outgoing tangent
  3280. * @param amount defines the target quaternion
  3281. * @returns the new interpolated quaternion
  3282. */
  3283. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3284. }
  3285. /**
  3286. * Class used to store matrix data (4x4)
  3287. */
  3288. export class Matrix {
  3289. private static _updateFlagSeed;
  3290. private static _identityReadOnly;
  3291. private _isIdentity;
  3292. private _isIdentityDirty;
  3293. private _isIdentity3x2;
  3294. private _isIdentity3x2Dirty;
  3295. /**
  3296. * Gets the update flag of the matrix which is an unique number for the matrix.
  3297. * It will be incremented every time the matrix data change.
  3298. * You can use it to speed the comparison between two versions of the same matrix.
  3299. */
  3300. updateFlag: number;
  3301. private readonly _m;
  3302. /**
  3303. * Gets the internal data of the matrix
  3304. */
  3305. readonly m: DeepImmutable<Float32Array>;
  3306. /** @hidden */
  3307. _markAsUpdated(): void;
  3308. /** @hidden */
  3309. private _updateIdentityStatus;
  3310. /**
  3311. * Creates an empty matrix (filled with zeros)
  3312. */
  3313. constructor();
  3314. /**
  3315. * Check if the current matrix is identity
  3316. * @returns true is the matrix is the identity matrix
  3317. */
  3318. isIdentity(): boolean;
  3319. /**
  3320. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3321. * @returns true is the matrix is the identity matrix
  3322. */
  3323. isIdentityAs3x2(): boolean;
  3324. /**
  3325. * Gets the determinant of the matrix
  3326. * @returns the matrix determinant
  3327. */
  3328. determinant(): number;
  3329. /**
  3330. * Returns the matrix as a Float32Array
  3331. * @returns the matrix underlying array
  3332. */
  3333. toArray(): DeepImmutable<Float32Array>;
  3334. /**
  3335. * Returns the matrix as a Float32Array
  3336. * @returns the matrix underlying array.
  3337. */
  3338. asArray(): DeepImmutable<Float32Array>;
  3339. /**
  3340. * Inverts the current matrix in place
  3341. * @returns the current inverted matrix
  3342. */
  3343. invert(): Matrix;
  3344. /**
  3345. * Sets all the matrix elements to zero
  3346. * @returns the current matrix
  3347. */
  3348. reset(): Matrix;
  3349. /**
  3350. * Adds the current matrix with a second one
  3351. * @param other defines the matrix to add
  3352. * @returns a new matrix as the addition of the current matrix and the given one
  3353. */
  3354. add(other: DeepImmutable<Matrix>): Matrix;
  3355. /**
  3356. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3357. * @param other defines the matrix to add
  3358. * @param result defines the target matrix
  3359. * @returns the current matrix
  3360. */
  3361. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3362. /**
  3363. * Adds in place the given matrix to the current matrix
  3364. * @param other defines the second operand
  3365. * @returns the current updated matrix
  3366. */
  3367. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3368. /**
  3369. * Sets the given matrix to the current inverted Matrix
  3370. * @param other defines the target matrix
  3371. * @returns the unmodified current matrix
  3372. */
  3373. invertToRef(other: Matrix): Matrix;
  3374. /**
  3375. * add a value at the specified position in the current Matrix
  3376. * @param index the index of the value within the matrix. between 0 and 15.
  3377. * @param value the value to be added
  3378. * @returns the current updated matrix
  3379. */
  3380. addAtIndex(index: number, value: number): Matrix;
  3381. /**
  3382. * mutiply the specified position in the current Matrix by a value
  3383. * @param index the index of the value within the matrix. between 0 and 15.
  3384. * @param value the value to be added
  3385. * @returns the current updated matrix
  3386. */
  3387. multiplyAtIndex(index: number, value: number): Matrix;
  3388. /**
  3389. * Inserts the translation vector (using 3 floats) in the current matrix
  3390. * @param x defines the 1st component of the translation
  3391. * @param y defines the 2nd component of the translation
  3392. * @param z defines the 3rd component of the translation
  3393. * @returns the current updated matrix
  3394. */
  3395. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3396. /**
  3397. * Adds the translation vector (using 3 floats) in the current matrix
  3398. * @param x defines the 1st component of the translation
  3399. * @param y defines the 2nd component of the translation
  3400. * @param z defines the 3rd component of the translation
  3401. * @returns the current updated matrix
  3402. */
  3403. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3404. /**
  3405. * Inserts the translation vector in the current matrix
  3406. * @param vector3 defines the translation to insert
  3407. * @returns the current updated matrix
  3408. */
  3409. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3410. /**
  3411. * Gets the translation value of the current matrix
  3412. * @returns a new Vector3 as the extracted translation from the matrix
  3413. */
  3414. getTranslation(): Vector3;
  3415. /**
  3416. * Fill a Vector3 with the extracted translation from the matrix
  3417. * @param result defines the Vector3 where to store the translation
  3418. * @returns the current matrix
  3419. */
  3420. getTranslationToRef(result: Vector3): Matrix;
  3421. /**
  3422. * Remove rotation and scaling part from the matrix
  3423. * @returns the updated matrix
  3424. */
  3425. removeRotationAndScaling(): Matrix;
  3426. /**
  3427. * Multiply two matrices
  3428. * @param other defines the second operand
  3429. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3430. */
  3431. multiply(other: DeepImmutable<Matrix>): Matrix;
  3432. /**
  3433. * Copy the current matrix from the given one
  3434. * @param other defines the source matrix
  3435. * @returns the current updated matrix
  3436. */
  3437. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3438. /**
  3439. * Populates the given array from the starting index with the current matrix values
  3440. * @param array defines the target array
  3441. * @param offset defines the offset in the target array where to start storing values
  3442. * @returns the current matrix
  3443. */
  3444. copyToArray(array: Float32Array, offset?: number): Matrix;
  3445. /**
  3446. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3447. * @param other defines the second operand
  3448. * @param result defines the matrix where to store the multiplication
  3449. * @returns the current matrix
  3450. */
  3451. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3452. /**
  3453. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  3454. * @param other defines the second operand
  3455. * @param result defines the array where to store the multiplication
  3456. * @param offset defines the offset in the target array where to start storing values
  3457. * @returns the current matrix
  3458. */
  3459. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  3460. /**
  3461. * Check equality between this matrix and a second one
  3462. * @param value defines the second matrix to compare
  3463. * @returns true is the current matrix and the given one values are strictly equal
  3464. */
  3465. equals(value: DeepImmutable<Matrix>): boolean;
  3466. /**
  3467. * Clone the current matrix
  3468. * @returns a new matrix from the current matrix
  3469. */
  3470. clone(): Matrix;
  3471. /**
  3472. * Returns the name of the current matrix class
  3473. * @returns the string "Matrix"
  3474. */
  3475. getClassName(): string;
  3476. /**
  3477. * Gets the hash code of the current matrix
  3478. * @returns the hash code
  3479. */
  3480. getHashCode(): number;
  3481. /**
  3482. * Decomposes the current Matrix into a translation, rotation and scaling components
  3483. * @param scale defines the scale vector3 given as a reference to update
  3484. * @param rotation defines the rotation quaternion given as a reference to update
  3485. * @param translation defines the translation vector3 given as a reference to update
  3486. * @returns true if operation was successful
  3487. */
  3488. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  3489. /**
  3490. * Gets specific row of the matrix
  3491. * @param index defines the number of the row to get
  3492. * @returns the index-th row of the current matrix as a new Vector4
  3493. */
  3494. getRow(index: number): Nullable<Vector4>;
  3495. /**
  3496. * Sets the index-th row of the current matrix to the vector4 values
  3497. * @param index defines the number of the row to set
  3498. * @param row defines the target vector4
  3499. * @returns the updated current matrix
  3500. */
  3501. setRow(index: number, row: Vector4): Matrix;
  3502. /**
  3503. * Compute the transpose of the matrix
  3504. * @returns the new transposed matrix
  3505. */
  3506. transpose(): Matrix;
  3507. /**
  3508. * Compute the transpose of the matrix and store it in a given matrix
  3509. * @param result defines the target matrix
  3510. * @returns the current matrix
  3511. */
  3512. transposeToRef(result: Matrix): Matrix;
  3513. /**
  3514. * Sets the index-th row of the current matrix with the given 4 x float values
  3515. * @param index defines the row index
  3516. * @param x defines the x component to set
  3517. * @param y defines the y component to set
  3518. * @param z defines the z component to set
  3519. * @param w defines the w component to set
  3520. * @returns the updated current matrix
  3521. */
  3522. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  3523. /**
  3524. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  3525. * @param scale defines the scale factor
  3526. * @returns a new matrix
  3527. */
  3528. scale(scale: number): Matrix;
  3529. /**
  3530. * Scale the current matrix values by a factor to a given result matrix
  3531. * @param scale defines the scale factor
  3532. * @param result defines the matrix to store the result
  3533. * @returns the current matrix
  3534. */
  3535. scaleToRef(scale: number, result: Matrix): Matrix;
  3536. /**
  3537. * Scale the current matrix values by a factor and add the result to a given matrix
  3538. * @param scale defines the scale factor
  3539. * @param result defines the Matrix to store the result
  3540. * @returns the current matrix
  3541. */
  3542. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  3543. /**
  3544. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  3545. * @param ref matrix to store the result
  3546. */
  3547. toNormalMatrix(ref: Matrix): void;
  3548. /**
  3549. * Gets only rotation part of the current matrix
  3550. * @returns a new matrix sets to the extracted rotation matrix from the current one
  3551. */
  3552. getRotationMatrix(): Matrix;
  3553. /**
  3554. * Extracts the rotation matrix from the current one and sets it as the given "result"
  3555. * @param result defines the target matrix to store data to
  3556. * @returns the current matrix
  3557. */
  3558. getRotationMatrixToRef(result: Matrix): Matrix;
  3559. /**
  3560. * Toggles model matrix from being right handed to left handed in place and vice versa
  3561. */
  3562. toggleModelMatrixHandInPlace(): void;
  3563. /**
  3564. * Toggles projection matrix from being right handed to left handed in place and vice versa
  3565. */
  3566. toggleProjectionMatrixHandInPlace(): void;
  3567. /**
  3568. * Creates a matrix from an array
  3569. * @param array defines the source array
  3570. * @param offset defines an offset in the source array
  3571. * @returns a new Matrix set from the starting index of the given array
  3572. */
  3573. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  3574. /**
  3575. * Copy the content of an array into a given matrix
  3576. * @param array defines the source array
  3577. * @param offset defines an offset in the source array
  3578. * @param result defines the target matrix
  3579. */
  3580. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  3581. /**
  3582. * Stores an array into a matrix after having multiplied each component by a given factor
  3583. * @param array defines the source array
  3584. * @param offset defines the offset in the source array
  3585. * @param scale defines the scaling factor
  3586. * @param result defines the target matrix
  3587. */
  3588. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  3589. /**
  3590. * Gets an identity matrix that must not be updated
  3591. */
  3592. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  3593. /**
  3594. * Stores a list of values (16) inside a given matrix
  3595. * @param initialM11 defines 1st value of 1st row
  3596. * @param initialM12 defines 2nd value of 1st row
  3597. * @param initialM13 defines 3rd value of 1st row
  3598. * @param initialM14 defines 4th value of 1st row
  3599. * @param initialM21 defines 1st value of 2nd row
  3600. * @param initialM22 defines 2nd value of 2nd row
  3601. * @param initialM23 defines 3rd value of 2nd row
  3602. * @param initialM24 defines 4th value of 2nd row
  3603. * @param initialM31 defines 1st value of 3rd row
  3604. * @param initialM32 defines 2nd value of 3rd row
  3605. * @param initialM33 defines 3rd value of 3rd row
  3606. * @param initialM34 defines 4th value of 3rd row
  3607. * @param initialM41 defines 1st value of 4th row
  3608. * @param initialM42 defines 2nd value of 4th row
  3609. * @param initialM43 defines 3rd value of 4th row
  3610. * @param initialM44 defines 4th value of 4th row
  3611. * @param result defines the target matrix
  3612. */
  3613. 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;
  3614. /**
  3615. * Creates new matrix from a list of values (16)
  3616. * @param initialM11 defines 1st value of 1st row
  3617. * @param initialM12 defines 2nd value of 1st row
  3618. * @param initialM13 defines 3rd value of 1st row
  3619. * @param initialM14 defines 4th value of 1st row
  3620. * @param initialM21 defines 1st value of 2nd row
  3621. * @param initialM22 defines 2nd value of 2nd row
  3622. * @param initialM23 defines 3rd value of 2nd row
  3623. * @param initialM24 defines 4th value of 2nd row
  3624. * @param initialM31 defines 1st value of 3rd row
  3625. * @param initialM32 defines 2nd value of 3rd row
  3626. * @param initialM33 defines 3rd value of 3rd row
  3627. * @param initialM34 defines 4th value of 3rd row
  3628. * @param initialM41 defines 1st value of 4th row
  3629. * @param initialM42 defines 2nd value of 4th row
  3630. * @param initialM43 defines 3rd value of 4th row
  3631. * @param initialM44 defines 4th value of 4th row
  3632. * @returns the new matrix
  3633. */
  3634. 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;
  3635. /**
  3636. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  3637. * @param scale defines the scale vector3
  3638. * @param rotation defines the rotation quaternion
  3639. * @param translation defines the translation vector3
  3640. * @returns a new matrix
  3641. */
  3642. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  3643. /**
  3644. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  3645. * @param scale defines the scale vector3
  3646. * @param rotation defines the rotation quaternion
  3647. * @param translation defines the translation vector3
  3648. * @param result defines the target matrix
  3649. */
  3650. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  3651. /**
  3652. * Creates a new identity matrix
  3653. * @returns a new identity matrix
  3654. */
  3655. static Identity(): Matrix;
  3656. /**
  3657. * Creates a new identity matrix and stores the result in a given matrix
  3658. * @param result defines the target matrix
  3659. */
  3660. static IdentityToRef(result: Matrix): void;
  3661. /**
  3662. * Creates a new zero matrix
  3663. * @returns a new zero matrix
  3664. */
  3665. static Zero(): Matrix;
  3666. /**
  3667. * Creates a new rotation matrix for "angle" radians around the X axis
  3668. * @param angle defines the angle (in radians) to use
  3669. * @return the new matrix
  3670. */
  3671. static RotationX(angle: number): Matrix;
  3672. /**
  3673. * Creates a new matrix as the invert of a given matrix
  3674. * @param source defines the source matrix
  3675. * @returns the new matrix
  3676. */
  3677. static Invert(source: DeepImmutable<Matrix>): Matrix;
  3678. /**
  3679. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  3680. * @param angle defines the angle (in radians) to use
  3681. * @param result defines the target matrix
  3682. */
  3683. static RotationXToRef(angle: number, result: Matrix): void;
  3684. /**
  3685. * Creates a new rotation matrix for "angle" radians around the Y axis
  3686. * @param angle defines the angle (in radians) to use
  3687. * @return the new matrix
  3688. */
  3689. static RotationY(angle: number): Matrix;
  3690. /**
  3691. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  3692. * @param angle defines the angle (in radians) to use
  3693. * @param result defines the target matrix
  3694. */
  3695. static RotationYToRef(angle: number, result: Matrix): void;
  3696. /**
  3697. * Creates a new rotation matrix for "angle" radians around the Z axis
  3698. * @param angle defines the angle (in radians) to use
  3699. * @return the new matrix
  3700. */
  3701. static RotationZ(angle: number): Matrix;
  3702. /**
  3703. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  3704. * @param angle defines the angle (in radians) to use
  3705. * @param result defines the target matrix
  3706. */
  3707. static RotationZToRef(angle: number, result: Matrix): void;
  3708. /**
  3709. * Creates a new rotation matrix for "angle" radians around the given axis
  3710. * @param axis defines the axis to use
  3711. * @param angle defines the angle (in radians) to use
  3712. * @return the new matrix
  3713. */
  3714. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  3715. /**
  3716. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  3717. * @param axis defines the axis to use
  3718. * @param angle defines the angle (in radians) to use
  3719. * @param result defines the target matrix
  3720. */
  3721. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  3722. /**
  3723. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  3724. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  3725. * @param from defines the vector to align
  3726. * @param to defines the vector to align to
  3727. * @param result defines the target matrix
  3728. */
  3729. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  3730. /**
  3731. * Creates a rotation matrix
  3732. * @param yaw defines the yaw angle in radians (Y axis)
  3733. * @param pitch defines the pitch angle in radians (X axis)
  3734. * @param roll defines the roll angle in radians (X axis)
  3735. * @returns the new rotation matrix
  3736. */
  3737. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  3738. /**
  3739. * Creates a rotation matrix and stores it in a given matrix
  3740. * @param yaw defines the yaw angle in radians (Y axis)
  3741. * @param pitch defines the pitch angle in radians (X axis)
  3742. * @param roll defines the roll angle in radians (X axis)
  3743. * @param result defines the target matrix
  3744. */
  3745. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  3746. /**
  3747. * Creates a scaling matrix
  3748. * @param x defines the scale factor on X axis
  3749. * @param y defines the scale factor on Y axis
  3750. * @param z defines the scale factor on Z axis
  3751. * @returns the new matrix
  3752. */
  3753. static Scaling(x: number, y: number, z: number): Matrix;
  3754. /**
  3755. * Creates a scaling matrix and stores it in a given matrix
  3756. * @param x defines the scale factor on X axis
  3757. * @param y defines the scale factor on Y axis
  3758. * @param z defines the scale factor on Z axis
  3759. * @param result defines the target matrix
  3760. */
  3761. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  3762. /**
  3763. * Creates a translation matrix
  3764. * @param x defines the translation on X axis
  3765. * @param y defines the translation on Y axis
  3766. * @param z defines the translationon Z axis
  3767. * @returns the new matrix
  3768. */
  3769. static Translation(x: number, y: number, z: number): Matrix;
  3770. /**
  3771. * Creates a translation matrix and stores it in a given matrix
  3772. * @param x defines the translation on X axis
  3773. * @param y defines the translation on Y axis
  3774. * @param z defines the translationon Z axis
  3775. * @param result defines the target matrix
  3776. */
  3777. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  3778. /**
  3779. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  3780. * @param startValue defines the start value
  3781. * @param endValue defines the end value
  3782. * @param gradient defines the gradient factor
  3783. * @returns the new matrix
  3784. */
  3785. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  3786. /**
  3787. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  3788. * @param startValue defines the start value
  3789. * @param endValue defines the end value
  3790. * @param gradient defines the gradient factor
  3791. * @param result defines the Matrix object where to store data
  3792. */
  3793. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  3794. /**
  3795. * Builds a new matrix whose values are computed by:
  3796. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  3797. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  3798. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  3799. * @param startValue defines the first matrix
  3800. * @param endValue defines the second matrix
  3801. * @param gradient defines the gradient between the two matrices
  3802. * @returns the new matrix
  3803. */
  3804. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  3805. /**
  3806. * Update a matrix to values which are computed by:
  3807. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  3808. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  3809. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  3810. * @param startValue defines the first matrix
  3811. * @param endValue defines the second matrix
  3812. * @param gradient defines the gradient between the two matrices
  3813. * @param result defines the target matrix
  3814. */
  3815. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  3816. /**
  3817. * 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"
  3818. * This function works in left handed mode
  3819. * @param eye defines the final position of the entity
  3820. * @param target defines where the entity should look at
  3821. * @param up defines the up vector for the entity
  3822. * @returns the new matrix
  3823. */
  3824. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  3825. /**
  3826. * 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".
  3827. * This function works in left handed mode
  3828. * @param eye defines the final position of the entity
  3829. * @param target defines where the entity should look at
  3830. * @param up defines the up vector for the entity
  3831. * @param result defines the target matrix
  3832. */
  3833. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  3834. /**
  3835. * 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"
  3836. * This function works in right handed mode
  3837. * @param eye defines the final position of the entity
  3838. * @param target defines where the entity should look at
  3839. * @param up defines the up vector for the entity
  3840. * @returns the new matrix
  3841. */
  3842. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  3843. /**
  3844. * 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".
  3845. * This function works in right handed mode
  3846. * @param eye defines the final position of the entity
  3847. * @param target defines where the entity should look at
  3848. * @param up defines the up vector for the entity
  3849. * @param result defines the target matrix
  3850. */
  3851. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  3852. /**
  3853. * Create a left-handed orthographic projection matrix
  3854. * @param width defines the viewport width
  3855. * @param height defines the viewport height
  3856. * @param znear defines the near clip plane
  3857. * @param zfar defines the far clip plane
  3858. * @returns a new matrix as a left-handed orthographic projection matrix
  3859. */
  3860. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  3861. /**
  3862. * Store a left-handed orthographic projection to a given matrix
  3863. * @param width defines the viewport width
  3864. * @param height defines the viewport height
  3865. * @param znear defines the near clip plane
  3866. * @param zfar defines the far clip plane
  3867. * @param result defines the target matrix
  3868. */
  3869. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  3870. /**
  3871. * Create a left-handed orthographic projection matrix
  3872. * @param left defines the viewport left coordinate
  3873. * @param right defines the viewport right coordinate
  3874. * @param bottom defines the viewport bottom coordinate
  3875. * @param top defines the viewport top coordinate
  3876. * @param znear defines the near clip plane
  3877. * @param zfar defines the far clip plane
  3878. * @returns a new matrix as a left-handed orthographic projection matrix
  3879. */
  3880. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  3881. /**
  3882. * Stores a left-handed orthographic projection into a given matrix
  3883. * @param left defines the viewport left coordinate
  3884. * @param right defines the viewport right coordinate
  3885. * @param bottom defines the viewport bottom coordinate
  3886. * @param top defines the viewport top coordinate
  3887. * @param znear defines the near clip plane
  3888. * @param zfar defines the far clip plane
  3889. * @param result defines the target matrix
  3890. */
  3891. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  3892. /**
  3893. * Creates a right-handed orthographic projection matrix
  3894. * @param left defines the viewport left coordinate
  3895. * @param right defines the viewport right coordinate
  3896. * @param bottom defines the viewport bottom coordinate
  3897. * @param top defines the viewport top coordinate
  3898. * @param znear defines the near clip plane
  3899. * @param zfar defines the far clip plane
  3900. * @returns a new matrix as a right-handed orthographic projection matrix
  3901. */
  3902. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  3903. /**
  3904. * Stores a right-handed orthographic projection into a given matrix
  3905. * @param left defines the viewport left coordinate
  3906. * @param right defines the viewport right coordinate
  3907. * @param bottom defines the viewport bottom coordinate
  3908. * @param top defines the viewport top coordinate
  3909. * @param znear defines the near clip plane
  3910. * @param zfar defines the far clip plane
  3911. * @param result defines the target matrix
  3912. */
  3913. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  3914. /**
  3915. * Creates a left-handed perspective projection matrix
  3916. * @param width defines the viewport width
  3917. * @param height defines the viewport height
  3918. * @param znear defines the near clip plane
  3919. * @param zfar defines the far clip plane
  3920. * @returns a new matrix as a left-handed perspective projection matrix
  3921. */
  3922. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  3923. /**
  3924. * Creates a left-handed perspective projection matrix
  3925. * @param fov defines the horizontal field of view
  3926. * @param aspect defines the aspect ratio
  3927. * @param znear defines the near clip plane
  3928. * @param zfar defines the far clip plane
  3929. * @returns a new matrix as a left-handed perspective projection matrix
  3930. */
  3931. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  3932. /**
  3933. * Stores a left-handed perspective projection into a given matrix
  3934. * @param fov defines the horizontal field of view
  3935. * @param aspect defines the aspect ratio
  3936. * @param znear defines the near clip plane
  3937. * @param zfar defines the far clip plane
  3938. * @param result defines the target matrix
  3939. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  3940. */
  3941. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  3942. /**
  3943. * Creates a right-handed perspective projection matrix
  3944. * @param fov defines the horizontal field of view
  3945. * @param aspect defines the aspect ratio
  3946. * @param znear defines the near clip plane
  3947. * @param zfar defines the far clip plane
  3948. * @returns a new matrix as a right-handed perspective projection matrix
  3949. */
  3950. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  3951. /**
  3952. * Stores a right-handed perspective projection into a given matrix
  3953. * @param fov defines the horizontal field of view
  3954. * @param aspect defines the aspect ratio
  3955. * @param znear defines the near clip plane
  3956. * @param zfar defines the far clip plane
  3957. * @param result defines the target matrix
  3958. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  3959. */
  3960. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  3961. /**
  3962. * Stores a perspective projection for WebVR info a given matrix
  3963. * @param fov defines the field of view
  3964. * @param znear defines the near clip plane
  3965. * @param zfar defines the far clip plane
  3966. * @param result defines the target matrix
  3967. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  3968. */
  3969. static PerspectiveFovWebVRToRef(fov: {
  3970. upDegrees: number;
  3971. downDegrees: number;
  3972. leftDegrees: number;
  3973. rightDegrees: number;
  3974. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  3975. /**
  3976. * Computes a complete transformation matrix
  3977. * @param viewport defines the viewport to use
  3978. * @param world defines the world matrix
  3979. * @param view defines the view matrix
  3980. * @param projection defines the projection matrix
  3981. * @param zmin defines the near clip plane
  3982. * @param zmax defines the far clip plane
  3983. * @returns the transformation matrix
  3984. */
  3985. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  3986. /**
  3987. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  3988. * @param matrix defines the matrix to use
  3989. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  3990. */
  3991. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  3992. /**
  3993. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  3994. * @param matrix defines the matrix to use
  3995. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  3996. */
  3997. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  3998. /**
  3999. * Compute the transpose of a given matrix
  4000. * @param matrix defines the matrix to transpose
  4001. * @returns the new matrix
  4002. */
  4003. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4004. /**
  4005. * Compute the transpose of a matrix and store it in a target matrix
  4006. * @param matrix defines the matrix to transpose
  4007. * @param result defines the target matrix
  4008. */
  4009. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4010. /**
  4011. * Computes a reflection matrix from a plane
  4012. * @param plane defines the reflection plane
  4013. * @returns a new matrix
  4014. */
  4015. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4016. /**
  4017. * Computes a reflection matrix from a plane
  4018. * @param plane defines the reflection plane
  4019. * @param result defines the target matrix
  4020. */
  4021. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4022. /**
  4023. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4024. * @param xaxis defines the value of the 1st axis
  4025. * @param yaxis defines the value of the 2nd axis
  4026. * @param zaxis defines the value of the 3rd axis
  4027. * @param result defines the target matrix
  4028. */
  4029. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4030. /**
  4031. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4032. * @param quat defines the quaternion to use
  4033. * @param result defines the target matrix
  4034. */
  4035. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4036. }
  4037. /**
  4038. * @hidden
  4039. */
  4040. export class TmpVectors {
  4041. static Vector2: Vector2[];
  4042. static Vector3: Vector3[];
  4043. static Vector4: Vector4[];
  4044. static Quaternion: Quaternion[];
  4045. static Matrix: Matrix[];
  4046. }
  4047. }
  4048. declare module "babylonjs/Engines/constants" {
  4049. /** Defines the cross module used constants to avoid circular dependncies */
  4050. export class Constants {
  4051. /** Defines that alpha blending is disabled */
  4052. static readonly ALPHA_DISABLE: number;
  4053. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  4054. static readonly ALPHA_ADD: number;
  4055. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  4056. static readonly ALPHA_COMBINE: number;
  4057. /** Defines that alpha blending to DEST - SRC * DEST */
  4058. static readonly ALPHA_SUBTRACT: number;
  4059. /** Defines that alpha blending to SRC * DEST */
  4060. static readonly ALPHA_MULTIPLY: number;
  4061. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  4062. static readonly ALPHA_MAXIMIZED: number;
  4063. /** Defines that alpha blending to SRC + DEST */
  4064. static readonly ALPHA_ONEONE: number;
  4065. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  4066. static readonly ALPHA_PREMULTIPLIED: number;
  4067. /**
  4068. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  4069. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  4070. */
  4071. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  4072. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  4073. static readonly ALPHA_INTERPOLATE: number;
  4074. /**
  4075. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  4076. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  4077. */
  4078. static readonly ALPHA_SCREENMODE: number;
  4079. /** Defines that the ressource is not delayed*/
  4080. static readonly DELAYLOADSTATE_NONE: number;
  4081. /** Defines that the ressource was successfully delay loaded */
  4082. static readonly DELAYLOADSTATE_LOADED: number;
  4083. /** Defines that the ressource is currently delay loading */
  4084. static readonly DELAYLOADSTATE_LOADING: number;
  4085. /** Defines that the ressource is delayed and has not started loading */
  4086. static readonly DELAYLOADSTATE_NOTLOADED: number;
  4087. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  4088. static readonly NEVER: number;
  4089. /** 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 */
  4090. static readonly ALWAYS: number;
  4091. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  4092. static readonly LESS: number;
  4093. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  4094. static readonly EQUAL: number;
  4095. /** 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 */
  4096. static readonly LEQUAL: number;
  4097. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  4098. static readonly GREATER: number;
  4099. /** 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 */
  4100. static readonly GEQUAL: number;
  4101. /** 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 */
  4102. static readonly NOTEQUAL: number;
  4103. /** Passed to stencilOperation to specify that stencil value must be kept */
  4104. static readonly KEEP: number;
  4105. /** Passed to stencilOperation to specify that stencil value must be replaced */
  4106. static readonly REPLACE: number;
  4107. /** Passed to stencilOperation to specify that stencil value must be incremented */
  4108. static readonly INCR: number;
  4109. /** Passed to stencilOperation to specify that stencil value must be decremented */
  4110. static readonly DECR: number;
  4111. /** Passed to stencilOperation to specify that stencil value must be inverted */
  4112. static readonly INVERT: number;
  4113. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  4114. static readonly INCR_WRAP: number;
  4115. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  4116. static readonly DECR_WRAP: number;
  4117. /** Texture is not repeating outside of 0..1 UVs */
  4118. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  4119. /** Texture is repeating outside of 0..1 UVs */
  4120. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  4121. /** Texture is repeating and mirrored */
  4122. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  4123. /** ALPHA */
  4124. static readonly TEXTUREFORMAT_ALPHA: number;
  4125. /** LUMINANCE */
  4126. static readonly TEXTUREFORMAT_LUMINANCE: number;
  4127. /** LUMINANCE_ALPHA */
  4128. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  4129. /** RGB */
  4130. static readonly TEXTUREFORMAT_RGB: number;
  4131. /** RGBA */
  4132. static readonly TEXTUREFORMAT_RGBA: number;
  4133. /** RED */
  4134. static readonly TEXTUREFORMAT_RED: number;
  4135. /** RED (2nd reference) */
  4136. static readonly TEXTUREFORMAT_R: number;
  4137. /** RG */
  4138. static readonly TEXTUREFORMAT_RG: number;
  4139. /** RED_INTEGER */
  4140. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  4141. /** RED_INTEGER (2nd reference) */
  4142. static readonly TEXTUREFORMAT_R_INTEGER: number;
  4143. /** RG_INTEGER */
  4144. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  4145. /** RGB_INTEGER */
  4146. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  4147. /** RGBA_INTEGER */
  4148. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  4149. /** UNSIGNED_BYTE */
  4150. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  4151. /** UNSIGNED_BYTE (2nd reference) */
  4152. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  4153. /** FLOAT */
  4154. static readonly TEXTURETYPE_FLOAT: number;
  4155. /** HALF_FLOAT */
  4156. static readonly TEXTURETYPE_HALF_FLOAT: number;
  4157. /** BYTE */
  4158. static readonly TEXTURETYPE_BYTE: number;
  4159. /** SHORT */
  4160. static readonly TEXTURETYPE_SHORT: number;
  4161. /** UNSIGNED_SHORT */
  4162. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  4163. /** INT */
  4164. static readonly TEXTURETYPE_INT: number;
  4165. /** UNSIGNED_INT */
  4166. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  4167. /** UNSIGNED_SHORT_4_4_4_4 */
  4168. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  4169. /** UNSIGNED_SHORT_5_5_5_1 */
  4170. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  4171. /** UNSIGNED_SHORT_5_6_5 */
  4172. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  4173. /** UNSIGNED_INT_2_10_10_10_REV */
  4174. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  4175. /** UNSIGNED_INT_24_8 */
  4176. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  4177. /** UNSIGNED_INT_10F_11F_11F_REV */
  4178. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  4179. /** UNSIGNED_INT_5_9_9_9_REV */
  4180. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  4181. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  4182. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  4183. /** nearest is mag = nearest and min = nearest and mip = linear */
  4184. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  4185. /** Bilinear is mag = linear and min = linear and mip = nearest */
  4186. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  4187. /** Trilinear is mag = linear and min = linear and mip = linear */
  4188. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  4189. /** nearest is mag = nearest and min = nearest and mip = linear */
  4190. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  4191. /** Bilinear is mag = linear and min = linear and mip = nearest */
  4192. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  4193. /** Trilinear is mag = linear and min = linear and mip = linear */
  4194. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  4195. /** mag = nearest and min = nearest and mip = nearest */
  4196. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  4197. /** mag = nearest and min = linear and mip = nearest */
  4198. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  4199. /** mag = nearest and min = linear and mip = linear */
  4200. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  4201. /** mag = nearest and min = linear and mip = none */
  4202. static readonly TEXTURE_NEAREST_LINEAR: number;
  4203. /** mag = nearest and min = nearest and mip = none */
  4204. static readonly TEXTURE_NEAREST_NEAREST: number;
  4205. /** mag = linear and min = nearest and mip = nearest */
  4206. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  4207. /** mag = linear and min = nearest and mip = linear */
  4208. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  4209. /** mag = linear and min = linear and mip = none */
  4210. static readonly TEXTURE_LINEAR_LINEAR: number;
  4211. /** mag = linear and min = nearest and mip = none */
  4212. static readonly TEXTURE_LINEAR_NEAREST: number;
  4213. /** Explicit coordinates mode */
  4214. static readonly TEXTURE_EXPLICIT_MODE: number;
  4215. /** Spherical coordinates mode */
  4216. static readonly TEXTURE_SPHERICAL_MODE: number;
  4217. /** Planar coordinates mode */
  4218. static readonly TEXTURE_PLANAR_MODE: number;
  4219. /** Cubic coordinates mode */
  4220. static readonly TEXTURE_CUBIC_MODE: number;
  4221. /** Projection coordinates mode */
  4222. static readonly TEXTURE_PROJECTION_MODE: number;
  4223. /** Skybox coordinates mode */
  4224. static readonly TEXTURE_SKYBOX_MODE: number;
  4225. /** Inverse Cubic coordinates mode */
  4226. static readonly TEXTURE_INVCUBIC_MODE: number;
  4227. /** Equirectangular coordinates mode */
  4228. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  4229. /** Equirectangular Fixed coordinates mode */
  4230. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  4231. /** Equirectangular Fixed Mirrored coordinates mode */
  4232. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  4233. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  4234. static readonly SCALEMODE_FLOOR: number;
  4235. /** Defines that texture rescaling will look for the nearest power of 2 size */
  4236. static readonly SCALEMODE_NEAREST: number;
  4237. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  4238. static readonly SCALEMODE_CEILING: number;
  4239. /**
  4240. * The dirty texture flag value
  4241. */
  4242. static readonly MATERIAL_TextureDirtyFlag: number;
  4243. /**
  4244. * The dirty light flag value
  4245. */
  4246. static readonly MATERIAL_LightDirtyFlag: number;
  4247. /**
  4248. * The dirty fresnel flag value
  4249. */
  4250. static readonly MATERIAL_FresnelDirtyFlag: number;
  4251. /**
  4252. * The dirty attribute flag value
  4253. */
  4254. static readonly MATERIAL_AttributesDirtyFlag: number;
  4255. /**
  4256. * The dirty misc flag value
  4257. */
  4258. static readonly MATERIAL_MiscDirtyFlag: number;
  4259. /**
  4260. * The all dirty flag value
  4261. */
  4262. static readonly MATERIAL_AllDirtyFlag: number;
  4263. /**
  4264. * Returns the triangle fill mode
  4265. */
  4266. static readonly MATERIAL_TriangleFillMode: number;
  4267. /**
  4268. * Returns the wireframe mode
  4269. */
  4270. static readonly MATERIAL_WireFrameFillMode: number;
  4271. /**
  4272. * Returns the point fill mode
  4273. */
  4274. static readonly MATERIAL_PointFillMode: number;
  4275. /**
  4276. * Returns the point list draw mode
  4277. */
  4278. static readonly MATERIAL_PointListDrawMode: number;
  4279. /**
  4280. * Returns the line list draw mode
  4281. */
  4282. static readonly MATERIAL_LineListDrawMode: number;
  4283. /**
  4284. * Returns the line loop draw mode
  4285. */
  4286. static readonly MATERIAL_LineLoopDrawMode: number;
  4287. /**
  4288. * Returns the line strip draw mode
  4289. */
  4290. static readonly MATERIAL_LineStripDrawMode: number;
  4291. /**
  4292. * Returns the triangle strip draw mode
  4293. */
  4294. static readonly MATERIAL_TriangleStripDrawMode: number;
  4295. /**
  4296. * Returns the triangle fan draw mode
  4297. */
  4298. static readonly MATERIAL_TriangleFanDrawMode: number;
  4299. /**
  4300. * Stores the clock-wise side orientation
  4301. */
  4302. static readonly MATERIAL_ClockWiseSideOrientation: number;
  4303. /**
  4304. * Stores the counter clock-wise side orientation
  4305. */
  4306. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  4307. /**
  4308. * Nothing
  4309. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4310. */
  4311. static readonly ACTION_NothingTrigger: number;
  4312. /**
  4313. * On pick
  4314. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4315. */
  4316. static readonly ACTION_OnPickTrigger: number;
  4317. /**
  4318. * On left pick
  4319. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4320. */
  4321. static readonly ACTION_OnLeftPickTrigger: number;
  4322. /**
  4323. * On right pick
  4324. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4325. */
  4326. static readonly ACTION_OnRightPickTrigger: number;
  4327. /**
  4328. * On center pick
  4329. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4330. */
  4331. static readonly ACTION_OnCenterPickTrigger: number;
  4332. /**
  4333. * On pick down
  4334. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4335. */
  4336. static readonly ACTION_OnPickDownTrigger: number;
  4337. /**
  4338. * On double pick
  4339. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4340. */
  4341. static readonly ACTION_OnDoublePickTrigger: number;
  4342. /**
  4343. * On pick up
  4344. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4345. */
  4346. static readonly ACTION_OnPickUpTrigger: number;
  4347. /**
  4348. * On pick out.
  4349. * This trigger will only be raised if you also declared a OnPickDown
  4350. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4351. */
  4352. static readonly ACTION_OnPickOutTrigger: number;
  4353. /**
  4354. * On long press
  4355. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4356. */
  4357. static readonly ACTION_OnLongPressTrigger: number;
  4358. /**
  4359. * On pointer over
  4360. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4361. */
  4362. static readonly ACTION_OnPointerOverTrigger: number;
  4363. /**
  4364. * On pointer out
  4365. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4366. */
  4367. static readonly ACTION_OnPointerOutTrigger: number;
  4368. /**
  4369. * On every frame
  4370. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4371. */
  4372. static readonly ACTION_OnEveryFrameTrigger: number;
  4373. /**
  4374. * On intersection enter
  4375. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4376. */
  4377. static readonly ACTION_OnIntersectionEnterTrigger: number;
  4378. /**
  4379. * On intersection exit
  4380. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4381. */
  4382. static readonly ACTION_OnIntersectionExitTrigger: number;
  4383. /**
  4384. * On key down
  4385. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4386. */
  4387. static readonly ACTION_OnKeyDownTrigger: number;
  4388. /**
  4389. * On key up
  4390. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  4391. */
  4392. static readonly ACTION_OnKeyUpTrigger: number;
  4393. /**
  4394. * Billboard mode will only apply to Y axis
  4395. */
  4396. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  4397. /**
  4398. * Billboard mode will apply to all axes
  4399. */
  4400. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  4401. /**
  4402. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  4403. */
  4404. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  4405. /**
  4406. * Gets or sets base Assets URL
  4407. */
  4408. static PARTICLES_BaseAssetsUrl: string;
  4409. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  4410. * Test order :
  4411. * Is the bounding sphere outside the frustum ?
  4412. * If not, are the bounding box vertices outside the frustum ?
  4413. * It not, then the cullable object is in the frustum.
  4414. */
  4415. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  4416. /** Culling strategy : Bounding Sphere Only.
  4417. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  4418. * It's also less accurate than the standard because some not visible objects can still be selected.
  4419. * Test : is the bounding sphere outside the frustum ?
  4420. * If not, then the cullable object is in the frustum.
  4421. */
  4422. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  4423. /** Culling strategy : Optimistic Inclusion.
  4424. * This in an inclusion test first, then the standard exclusion test.
  4425. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  4426. * 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.
  4427. * Anyway, it's as accurate as the standard strategy.
  4428. * Test :
  4429. * Is the cullable object bounding sphere center in the frustum ?
  4430. * If not, apply the default culling strategy.
  4431. */
  4432. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  4433. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  4434. * This in an inclusion test first, then the bounding sphere only exclusion test.
  4435. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  4436. * 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.
  4437. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  4438. * Test :
  4439. * Is the cullable object bounding sphere center in the frustum ?
  4440. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  4441. */
  4442. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  4443. /**
  4444. * No logging while loading
  4445. */
  4446. static readonly SCENELOADER_NO_LOGGING: number;
  4447. /**
  4448. * Minimal logging while loading
  4449. */
  4450. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  4451. /**
  4452. * Summary logging while loading
  4453. */
  4454. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  4455. /**
  4456. * Detailled logging while loading
  4457. */
  4458. static readonly SCENELOADER_DETAILED_LOGGING: number;
  4459. }
  4460. }
  4461. declare module "babylonjs/Engines/IPipelineContext" {
  4462. /**
  4463. * Class used to store and describe the pipeline context associated with an effect
  4464. */
  4465. export interface IPipelineContext {
  4466. /**
  4467. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  4468. */
  4469. isAsync: boolean;
  4470. /**
  4471. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  4472. */
  4473. isReady: boolean;
  4474. /** @hidden */
  4475. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  4476. }
  4477. }
  4478. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  4479. /** @hidden */
  4480. export interface IShaderProcessor {
  4481. attributeProcessor?: (attribute: string) => string;
  4482. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  4483. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  4484. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  4485. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  4486. lineProcessor?: (line: string, isFragment: boolean) => string;
  4487. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  4488. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  4489. }
  4490. }
  4491. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  4492. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  4493. /** @hidden */
  4494. export interface ProcessingOptions {
  4495. defines: string[];
  4496. indexParameters: any;
  4497. isFragment: boolean;
  4498. shouldUseHighPrecisionShader: boolean;
  4499. supportsUniformBuffers: boolean;
  4500. shadersRepository: string;
  4501. includesShadersStore: {
  4502. [key: string]: string;
  4503. };
  4504. processor?: IShaderProcessor;
  4505. version: string;
  4506. platformName: string;
  4507. lookForClosingBracketForUniformBuffer?: boolean;
  4508. }
  4509. }
  4510. declare module "babylonjs/Misc/stringTools" {
  4511. /**
  4512. * Helper to manipulate strings
  4513. */
  4514. export class StringTools {
  4515. /**
  4516. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  4517. * @param str Source string
  4518. * @param suffix Suffix to search for in the source string
  4519. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  4520. */
  4521. static EndsWith(str: string, suffix: string): boolean;
  4522. /**
  4523. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  4524. * @param str Source string
  4525. * @param suffix Suffix to search for in the source string
  4526. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  4527. */
  4528. static StartsWith(str: string, suffix: string): boolean;
  4529. }
  4530. }
  4531. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  4532. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  4533. /** @hidden */
  4534. export class ShaderCodeNode {
  4535. line: string;
  4536. children: ShaderCodeNode[];
  4537. additionalDefineKey?: string;
  4538. additionalDefineValue?: string;
  4539. isValid(preprocessors: {
  4540. [key: string]: string;
  4541. }): boolean;
  4542. process(preprocessors: {
  4543. [key: string]: string;
  4544. }, options: ProcessingOptions): string;
  4545. }
  4546. }
  4547. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  4548. /** @hidden */
  4549. export class ShaderCodeCursor {
  4550. private _lines;
  4551. lineIndex: number;
  4552. readonly currentLine: string;
  4553. readonly canRead: boolean;
  4554. lines: string[];
  4555. }
  4556. }
  4557. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  4558. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  4559. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  4560. /** @hidden */
  4561. export class ShaderCodeConditionNode extends ShaderCodeNode {
  4562. process(preprocessors: {
  4563. [key: string]: string;
  4564. }, options: ProcessingOptions): string;
  4565. }
  4566. }
  4567. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  4568. /** @hidden */
  4569. export class ShaderDefineExpression {
  4570. isTrue(preprocessors: {
  4571. [key: string]: string;
  4572. }): boolean;
  4573. }
  4574. }
  4575. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  4576. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  4577. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4578. /** @hidden */
  4579. export class ShaderCodeTestNode extends ShaderCodeNode {
  4580. testExpression: ShaderDefineExpression;
  4581. isValid(preprocessors: {
  4582. [key: string]: string;
  4583. }): boolean;
  4584. }
  4585. }
  4586. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  4587. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4588. /** @hidden */
  4589. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  4590. define: string;
  4591. not: boolean;
  4592. constructor(define: string, not?: boolean);
  4593. isTrue(preprocessors: {
  4594. [key: string]: string;
  4595. }): boolean;
  4596. }
  4597. }
  4598. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  4599. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4600. /** @hidden */
  4601. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  4602. leftOperand: ShaderDefineExpression;
  4603. rightOperand: ShaderDefineExpression;
  4604. isTrue(preprocessors: {
  4605. [key: string]: string;
  4606. }): boolean;
  4607. }
  4608. }
  4609. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  4610. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4611. /** @hidden */
  4612. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  4613. leftOperand: ShaderDefineExpression;
  4614. rightOperand: ShaderDefineExpression;
  4615. isTrue(preprocessors: {
  4616. [key: string]: string;
  4617. }): boolean;
  4618. }
  4619. }
  4620. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  4621. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  4622. /** @hidden */
  4623. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  4624. define: string;
  4625. operand: string;
  4626. testValue: string;
  4627. constructor(define: string, operand: string, testValue: string);
  4628. isTrue(preprocessors: {
  4629. [key: string]: string;
  4630. }): boolean;
  4631. }
  4632. }
  4633. declare module "babylonjs/Misc/loadFileError" {
  4634. import { WebRequest } from "babylonjs/Misc/webRequest";
  4635. /**
  4636. * @ignore
  4637. * Application error to support additional information when loading a file
  4638. */
  4639. export class LoadFileError extends Error {
  4640. /** defines the optional web request */
  4641. request?: WebRequest | undefined;
  4642. private static _setPrototypeOf;
  4643. /**
  4644. * Creates a new LoadFileError
  4645. * @param message defines the message of the error
  4646. * @param request defines the optional web request
  4647. */
  4648. constructor(message: string,
  4649. /** defines the optional web request */
  4650. request?: WebRequest | undefined);
  4651. }
  4652. }
  4653. declare module "babylonjs/Offline/IOfflineProvider" {
  4654. /**
  4655. * Class used to enable access to offline support
  4656. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  4657. */
  4658. export interface IOfflineProvider {
  4659. /**
  4660. * Gets a boolean indicating if scene must be saved in the database
  4661. */
  4662. enableSceneOffline: boolean;
  4663. /**
  4664. * Gets a boolean indicating if textures must be saved in the database
  4665. */
  4666. enableTexturesOffline: boolean;
  4667. /**
  4668. * Open the offline support and make it available
  4669. * @param successCallback defines the callback to call on success
  4670. * @param errorCallback defines the callback to call on error
  4671. */
  4672. open(successCallback: () => void, errorCallback: () => void): void;
  4673. /**
  4674. * Loads an image from the offline support
  4675. * @param url defines the url to load from
  4676. * @param image defines the target DOM image
  4677. */
  4678. loadImage(url: string, image: HTMLImageElement): void;
  4679. /**
  4680. * Loads a file from offline support
  4681. * @param url defines the URL to load from
  4682. * @param sceneLoaded defines a callback to call on success
  4683. * @param progressCallBack defines a callback to call when progress changed
  4684. * @param errorCallback defines a callback to call on error
  4685. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  4686. */
  4687. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  4688. }
  4689. }
  4690. declare module "babylonjs/Misc/filesInputStore" {
  4691. /**
  4692. * Class used to help managing file picking and drag'n'drop
  4693. * File Storage
  4694. */
  4695. export class FilesInputStore {
  4696. /**
  4697. * List of files ready to be loaded
  4698. */
  4699. static FilesToLoad: {
  4700. [key: string]: File;
  4701. };
  4702. }
  4703. }
  4704. declare module "babylonjs/Misc/retryStrategy" {
  4705. import { WebRequest } from "babylonjs/Misc/webRequest";
  4706. /**
  4707. * Class used to define a retry strategy when error happens while loading assets
  4708. */
  4709. export class RetryStrategy {
  4710. /**
  4711. * Function used to defines an exponential back off strategy
  4712. * @param maxRetries defines the maximum number of retries (3 by default)
  4713. * @param baseInterval defines the interval between retries
  4714. * @returns the strategy function to use
  4715. */
  4716. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  4717. }
  4718. }
  4719. declare module "babylonjs/Misc/fileTools" {
  4720. import { WebRequest } from "babylonjs/Misc/webRequest";
  4721. import { Nullable } from "babylonjs/types";
  4722. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  4723. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  4724. /**
  4725. * @hidden
  4726. */
  4727. export class FileTools {
  4728. /**
  4729. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  4730. */
  4731. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  4732. /**
  4733. * Gets or sets the base URL to use to load assets
  4734. */
  4735. static BaseUrl: string;
  4736. /**
  4737. * Default behaviour for cors in the application.
  4738. * It can be a string if the expected behavior is identical in the entire app.
  4739. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  4740. */
  4741. static CorsBehavior: string | ((url: string | string[]) => string);
  4742. /**
  4743. * Gets or sets a function used to pre-process url before using them to load assets
  4744. */
  4745. static PreprocessUrl: (url: string) => string;
  4746. /**
  4747. * Removes unwanted characters from an url
  4748. * @param url defines the url to clean
  4749. * @returns the cleaned url
  4750. */
  4751. private static _CleanUrl;
  4752. /**
  4753. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  4754. * @param url define the url we are trying
  4755. * @param element define the dom element where to configure the cors policy
  4756. */
  4757. static SetCorsBehavior(url: string | string[], element: {
  4758. crossOrigin: string | null;
  4759. }): void;
  4760. /**
  4761. * Loads an image as an HTMLImageElement.
  4762. * @param input url string, ArrayBuffer, or Blob to load
  4763. * @param onLoad callback called when the image successfully loads
  4764. * @param onError callback called when the image fails to load
  4765. * @param offlineProvider offline provider for caching
  4766. * @returns the HTMLImageElement of the loaded image
  4767. */
  4768. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  4769. /**
  4770. * Loads a file
  4771. * @param fileToLoad defines the file to load
  4772. * @param callback defines the callback to call when data is loaded
  4773. * @param progressCallBack defines the callback to call during loading process
  4774. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  4775. * @returns a file request object
  4776. */
  4777. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  4778. /**
  4779. * Loads a file
  4780. * @param url url string, ArrayBuffer, or Blob to load
  4781. * @param onSuccess callback called when the file successfully loads
  4782. * @param onProgress callback called while file is loading (if the server supports this mode)
  4783. * @param offlineProvider defines the offline provider for caching
  4784. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  4785. * @param onError callback called when the file fails to load
  4786. * @returns a file request object
  4787. */
  4788. 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;
  4789. /**
  4790. * Checks if the loaded document was accessed via `file:`-Protocol.
  4791. * @returns boolean
  4792. */
  4793. static IsFileURL(): boolean;
  4794. }
  4795. }
  4796. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  4797. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  4798. /** @hidden */
  4799. export class ShaderProcessor {
  4800. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  4801. private static _ProcessPrecision;
  4802. private static _ExtractOperation;
  4803. private static _BuildSubExpression;
  4804. private static _BuildExpression;
  4805. private static _MoveCursorWithinIf;
  4806. private static _MoveCursor;
  4807. private static _EvaluatePreProcessors;
  4808. private static _PreparePreProcessors;
  4809. private static _ProcessShaderConversion;
  4810. private static _ProcessIncludes;
  4811. }
  4812. }
  4813. declare module "babylonjs/Maths/math.color" {
  4814. import { DeepImmutable, FloatArray } from "babylonjs/types";
  4815. /**
  4816. * Class used to hold a RBG color
  4817. */
  4818. export class Color3 {
  4819. /**
  4820. * Defines the red component (between 0 and 1, default is 0)
  4821. */
  4822. r: number;
  4823. /**
  4824. * Defines the green component (between 0 and 1, default is 0)
  4825. */
  4826. g: number;
  4827. /**
  4828. * Defines the blue component (between 0 and 1, default is 0)
  4829. */
  4830. b: number;
  4831. /**
  4832. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  4833. * @param r defines the red component (between 0 and 1, default is 0)
  4834. * @param g defines the green component (between 0 and 1, default is 0)
  4835. * @param b defines the blue component (between 0 and 1, default is 0)
  4836. */
  4837. constructor(
  4838. /**
  4839. * Defines the red component (between 0 and 1, default is 0)
  4840. */
  4841. r?: number,
  4842. /**
  4843. * Defines the green component (between 0 and 1, default is 0)
  4844. */
  4845. g?: number,
  4846. /**
  4847. * Defines the blue component (between 0 and 1, default is 0)
  4848. */
  4849. b?: number);
  4850. /**
  4851. * Creates a string with the Color3 current values
  4852. * @returns the string representation of the Color3 object
  4853. */
  4854. toString(): string;
  4855. /**
  4856. * Returns the string "Color3"
  4857. * @returns "Color3"
  4858. */
  4859. getClassName(): string;
  4860. /**
  4861. * Compute the Color3 hash code
  4862. * @returns an unique number that can be used to hash Color3 objects
  4863. */
  4864. getHashCode(): number;
  4865. /**
  4866. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  4867. * @param array defines the array where to store the r,g,b components
  4868. * @param index defines an optional index in the target array to define where to start storing values
  4869. * @returns the current Color3 object
  4870. */
  4871. toArray(array: FloatArray, index?: number): Color3;
  4872. /**
  4873. * Returns a new Color4 object from the current Color3 and the given alpha
  4874. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  4875. * @returns a new Color4 object
  4876. */
  4877. toColor4(alpha?: number): Color4;
  4878. /**
  4879. * Returns a new array populated with 3 numeric elements : red, green and blue values
  4880. * @returns the new array
  4881. */
  4882. asArray(): number[];
  4883. /**
  4884. * Returns the luminance value
  4885. * @returns a float value
  4886. */
  4887. toLuminance(): number;
  4888. /**
  4889. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  4890. * @param otherColor defines the second operand
  4891. * @returns the new Color3 object
  4892. */
  4893. multiply(otherColor: DeepImmutable<Color3>): Color3;
  4894. /**
  4895. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  4896. * @param otherColor defines the second operand
  4897. * @param result defines the Color3 object where to store the result
  4898. * @returns the current Color3
  4899. */
  4900. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  4901. /**
  4902. * Determines equality between Color3 objects
  4903. * @param otherColor defines the second operand
  4904. * @returns true if the rgb values are equal to the given ones
  4905. */
  4906. equals(otherColor: DeepImmutable<Color3>): boolean;
  4907. /**
  4908. * Determines equality between the current Color3 object and a set of r,b,g values
  4909. * @param r defines the red component to check
  4910. * @param g defines the green component to check
  4911. * @param b defines the blue component to check
  4912. * @returns true if the rgb values are equal to the given ones
  4913. */
  4914. equalsFloats(r: number, g: number, b: number): boolean;
  4915. /**
  4916. * Multiplies in place each rgb value by scale
  4917. * @param scale defines the scaling factor
  4918. * @returns the updated Color3
  4919. */
  4920. scale(scale: number): Color3;
  4921. /**
  4922. * Multiplies the rgb values by scale and stores the result into "result"
  4923. * @param scale defines the scaling factor
  4924. * @param result defines the Color3 object where to store the result
  4925. * @returns the unmodified current Color3
  4926. */
  4927. scaleToRef(scale: number, result: Color3): Color3;
  4928. /**
  4929. * Scale the current Color3 values by a factor and add the result to a given Color3
  4930. * @param scale defines the scale factor
  4931. * @param result defines color to store the result into
  4932. * @returns the unmodified current Color3
  4933. */
  4934. scaleAndAddToRef(scale: number, result: Color3): Color3;
  4935. /**
  4936. * Clamps the rgb values by the min and max values and stores the result into "result"
  4937. * @param min defines minimum clamping value (default is 0)
  4938. * @param max defines maximum clamping value (default is 1)
  4939. * @param result defines color to store the result into
  4940. * @returns the original Color3
  4941. */
  4942. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  4943. /**
  4944. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  4945. * @param otherColor defines the second operand
  4946. * @returns the new Color3
  4947. */
  4948. add(otherColor: DeepImmutable<Color3>): Color3;
  4949. /**
  4950. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  4951. * @param otherColor defines the second operand
  4952. * @param result defines Color3 object to store the result into
  4953. * @returns the unmodified current Color3
  4954. */
  4955. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  4956. /**
  4957. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  4958. * @param otherColor defines the second operand
  4959. * @returns the new Color3
  4960. */
  4961. subtract(otherColor: DeepImmutable<Color3>): Color3;
  4962. /**
  4963. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  4964. * @param otherColor defines the second operand
  4965. * @param result defines Color3 object to store the result into
  4966. * @returns the unmodified current Color3
  4967. */
  4968. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  4969. /**
  4970. * Copy the current object
  4971. * @returns a new Color3 copied the current one
  4972. */
  4973. clone(): Color3;
  4974. /**
  4975. * Copies the rgb values from the source in the current Color3
  4976. * @param source defines the source Color3 object
  4977. * @returns the updated Color3 object
  4978. */
  4979. copyFrom(source: DeepImmutable<Color3>): Color3;
  4980. /**
  4981. * Updates the Color3 rgb values from the given floats
  4982. * @param r defines the red component to read from
  4983. * @param g defines the green component to read from
  4984. * @param b defines the blue component to read from
  4985. * @returns the current Color3 object
  4986. */
  4987. copyFromFloats(r: number, g: number, b: number): Color3;
  4988. /**
  4989. * Updates the Color3 rgb values from the given floats
  4990. * @param r defines the red component to read from
  4991. * @param g defines the green component to read from
  4992. * @param b defines the blue component to read from
  4993. * @returns the current Color3 object
  4994. */
  4995. set(r: number, g: number, b: number): Color3;
  4996. /**
  4997. * Compute the Color3 hexadecimal code as a string
  4998. * @returns a string containing the hexadecimal representation of the Color3 object
  4999. */
  5000. toHexString(): string;
  5001. /**
  5002. * Computes a new Color3 converted from the current one to linear space
  5003. * @returns a new Color3 object
  5004. */
  5005. toLinearSpace(): Color3;
  5006. /**
  5007. * Converts current color in rgb space to HSV values
  5008. * @returns a new color3 representing the HSV values
  5009. */
  5010. toHSV(): Color3;
  5011. /**
  5012. * Converts current color in rgb space to HSV values
  5013. * @param result defines the Color3 where to store the HSV values
  5014. */
  5015. toHSVToRef(result: Color3): void;
  5016. /**
  5017. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5018. * @param convertedColor defines the Color3 object where to store the linear space version
  5019. * @returns the unmodified Color3
  5020. */
  5021. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5022. /**
  5023. * Computes a new Color3 converted from the current one to gamma space
  5024. * @returns a new Color3 object
  5025. */
  5026. toGammaSpace(): Color3;
  5027. /**
  5028. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5029. * @param convertedColor defines the Color3 object where to store the gamma space version
  5030. * @returns the unmodified Color3
  5031. */
  5032. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5033. private static _BlackReadOnly;
  5034. /**
  5035. * Convert Hue, saturation and value to a Color3 (RGB)
  5036. * @param hue defines the hue
  5037. * @param saturation defines the saturation
  5038. * @param value defines the value
  5039. * @param result defines the Color3 where to store the RGB values
  5040. */
  5041. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5042. /**
  5043. * Creates a new Color3 from the string containing valid hexadecimal values
  5044. * @param hex defines a string containing valid hexadecimal values
  5045. * @returns a new Color3 object
  5046. */
  5047. static FromHexString(hex: string): Color3;
  5048. /**
  5049. * Creates a new Color3 from the starting index of the given array
  5050. * @param array defines the source array
  5051. * @param offset defines an offset in the source array
  5052. * @returns a new Color3 object
  5053. */
  5054. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5055. /**
  5056. * Creates a new Color3 from integer values (< 256)
  5057. * @param r defines the red component to read from (value between 0 and 255)
  5058. * @param g defines the green component to read from (value between 0 and 255)
  5059. * @param b defines the blue component to read from (value between 0 and 255)
  5060. * @returns a new Color3 object
  5061. */
  5062. static FromInts(r: number, g: number, b: number): Color3;
  5063. /**
  5064. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5065. * @param start defines the start Color3 value
  5066. * @param end defines the end Color3 value
  5067. * @param amount defines the gradient value between start and end
  5068. * @returns a new Color3 object
  5069. */
  5070. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5071. /**
  5072. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5073. * @param left defines the start value
  5074. * @param right defines the end value
  5075. * @param amount defines the gradient factor
  5076. * @param result defines the Color3 object where to store the result
  5077. */
  5078. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5079. /**
  5080. * Returns a Color3 value containing a red color
  5081. * @returns a new Color3 object
  5082. */
  5083. static Red(): Color3;
  5084. /**
  5085. * Returns a Color3 value containing a green color
  5086. * @returns a new Color3 object
  5087. */
  5088. static Green(): Color3;
  5089. /**
  5090. * Returns a Color3 value containing a blue color
  5091. * @returns a new Color3 object
  5092. */
  5093. static Blue(): Color3;
  5094. /**
  5095. * Returns a Color3 value containing a black color
  5096. * @returns a new Color3 object
  5097. */
  5098. static Black(): Color3;
  5099. /**
  5100. * Gets a Color3 value containing a black color that must not be updated
  5101. */
  5102. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5103. /**
  5104. * Returns a Color3 value containing a white color
  5105. * @returns a new Color3 object
  5106. */
  5107. static White(): Color3;
  5108. /**
  5109. * Returns a Color3 value containing a purple color
  5110. * @returns a new Color3 object
  5111. */
  5112. static Purple(): Color3;
  5113. /**
  5114. * Returns a Color3 value containing a magenta color
  5115. * @returns a new Color3 object
  5116. */
  5117. static Magenta(): Color3;
  5118. /**
  5119. * Returns a Color3 value containing a yellow color
  5120. * @returns a new Color3 object
  5121. */
  5122. static Yellow(): Color3;
  5123. /**
  5124. * Returns a Color3 value containing a gray color
  5125. * @returns a new Color3 object
  5126. */
  5127. static Gray(): Color3;
  5128. /**
  5129. * Returns a Color3 value containing a teal color
  5130. * @returns a new Color3 object
  5131. */
  5132. static Teal(): Color3;
  5133. /**
  5134. * Returns a Color3 value containing a random color
  5135. * @returns a new Color3 object
  5136. */
  5137. static Random(): Color3;
  5138. }
  5139. /**
  5140. * Class used to hold a RBGA color
  5141. */
  5142. export class Color4 {
  5143. /**
  5144. * Defines the red component (between 0 and 1, default is 0)
  5145. */
  5146. r: number;
  5147. /**
  5148. * Defines the green component (between 0 and 1, default is 0)
  5149. */
  5150. g: number;
  5151. /**
  5152. * Defines the blue component (between 0 and 1, default is 0)
  5153. */
  5154. b: number;
  5155. /**
  5156. * Defines the alpha component (between 0 and 1, default is 1)
  5157. */
  5158. a: number;
  5159. /**
  5160. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5161. * @param r defines the red component (between 0 and 1, default is 0)
  5162. * @param g defines the green component (between 0 and 1, default is 0)
  5163. * @param b defines the blue component (between 0 and 1, default is 0)
  5164. * @param a defines the alpha component (between 0 and 1, default is 1)
  5165. */
  5166. constructor(
  5167. /**
  5168. * Defines the red component (between 0 and 1, default is 0)
  5169. */
  5170. r?: number,
  5171. /**
  5172. * Defines the green component (between 0 and 1, default is 0)
  5173. */
  5174. g?: number,
  5175. /**
  5176. * Defines the blue component (between 0 and 1, default is 0)
  5177. */
  5178. b?: number,
  5179. /**
  5180. * Defines the alpha component (between 0 and 1, default is 1)
  5181. */
  5182. a?: number);
  5183. /**
  5184. * Adds in place the given Color4 values to the current Color4 object
  5185. * @param right defines the second operand
  5186. * @returns the current updated Color4 object
  5187. */
  5188. addInPlace(right: DeepImmutable<Color4>): Color4;
  5189. /**
  5190. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5191. * @returns the new array
  5192. */
  5193. asArray(): number[];
  5194. /**
  5195. * Stores from the starting index in the given array the Color4 successive values
  5196. * @param array defines the array where to store the r,g,b components
  5197. * @param index defines an optional index in the target array to define where to start storing values
  5198. * @returns the current Color4 object
  5199. */
  5200. toArray(array: number[], index?: number): Color4;
  5201. /**
  5202. * Determines equality between Color4 objects
  5203. * @param otherColor defines the second operand
  5204. * @returns true if the rgba values are equal to the given ones
  5205. */
  5206. equals(otherColor: DeepImmutable<Color4>): boolean;
  5207. /**
  5208. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5209. * @param right defines the second operand
  5210. * @returns a new Color4 object
  5211. */
  5212. add(right: DeepImmutable<Color4>): Color4;
  5213. /**
  5214. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5215. * @param right defines the second operand
  5216. * @returns a new Color4 object
  5217. */
  5218. subtract(right: DeepImmutable<Color4>): Color4;
  5219. /**
  5220. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5221. * @param right defines the second operand
  5222. * @param result defines the Color4 object where to store the result
  5223. * @returns the current Color4 object
  5224. */
  5225. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5226. /**
  5227. * Creates a new Color4 with the current Color4 values multiplied by scale
  5228. * @param scale defines the scaling factor to apply
  5229. * @returns a new Color4 object
  5230. */
  5231. scale(scale: number): Color4;
  5232. /**
  5233. * Multiplies the current Color4 values by scale and stores the result in "result"
  5234. * @param scale defines the scaling factor to apply
  5235. * @param result defines the Color4 object where to store the result
  5236. * @returns the current unmodified Color4
  5237. */
  5238. scaleToRef(scale: number, result: Color4): Color4;
  5239. /**
  5240. * Scale the current Color4 values by a factor and add the result to a given Color4
  5241. * @param scale defines the scale factor
  5242. * @param result defines the Color4 object where to store the result
  5243. * @returns the unmodified current Color4
  5244. */
  5245. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5246. /**
  5247. * Clamps the rgb values by the min and max values and stores the result into "result"
  5248. * @param min defines minimum clamping value (default is 0)
  5249. * @param max defines maximum clamping value (default is 1)
  5250. * @param result defines color to store the result into.
  5251. * @returns the cuurent Color4
  5252. */
  5253. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5254. /**
  5255. * Multipy an Color4 value by another and return a new Color4 object
  5256. * @param color defines the Color4 value to multiply by
  5257. * @returns a new Color4 object
  5258. */
  5259. multiply(color: Color4): Color4;
  5260. /**
  5261. * Multipy a Color4 value by another and push the result in a reference value
  5262. * @param color defines the Color4 value to multiply by
  5263. * @param result defines the Color4 to fill the result in
  5264. * @returns the result Color4
  5265. */
  5266. multiplyToRef(color: Color4, result: Color4): Color4;
  5267. /**
  5268. * Creates a string with the Color4 current values
  5269. * @returns the string representation of the Color4 object
  5270. */
  5271. toString(): string;
  5272. /**
  5273. * Returns the string "Color4"
  5274. * @returns "Color4"
  5275. */
  5276. getClassName(): string;
  5277. /**
  5278. * Compute the Color4 hash code
  5279. * @returns an unique number that can be used to hash Color4 objects
  5280. */
  5281. getHashCode(): number;
  5282. /**
  5283. * Creates a new Color4 copied from the current one
  5284. * @returns a new Color4 object
  5285. */
  5286. clone(): Color4;
  5287. /**
  5288. * Copies the given Color4 values into the current one
  5289. * @param source defines the source Color4 object
  5290. * @returns the current updated Color4 object
  5291. */
  5292. copyFrom(source: Color4): Color4;
  5293. /**
  5294. * Copies the given float values into the current one
  5295. * @param r defines the red component to read from
  5296. * @param g defines the green component to read from
  5297. * @param b defines the blue component to read from
  5298. * @param a defines the alpha component to read from
  5299. * @returns the current updated Color4 object
  5300. */
  5301. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5302. /**
  5303. * Copies the given float values into the current one
  5304. * @param r defines the red component to read from
  5305. * @param g defines the green component to read from
  5306. * @param b defines the blue component to read from
  5307. * @param a defines the alpha component to read from
  5308. * @returns the current updated Color4 object
  5309. */
  5310. set(r: number, g: number, b: number, a: number): Color4;
  5311. /**
  5312. * Compute the Color4 hexadecimal code as a string
  5313. * @returns a string containing the hexadecimal representation of the Color4 object
  5314. */
  5315. toHexString(): string;
  5316. /**
  5317. * Computes a new Color4 converted from the current one to linear space
  5318. * @returns a new Color4 object
  5319. */
  5320. toLinearSpace(): Color4;
  5321. /**
  5322. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5323. * @param convertedColor defines the Color4 object where to store the linear space version
  5324. * @returns the unmodified Color4
  5325. */
  5326. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5327. /**
  5328. * Computes a new Color4 converted from the current one to gamma space
  5329. * @returns a new Color4 object
  5330. */
  5331. toGammaSpace(): Color4;
  5332. /**
  5333. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5334. * @param convertedColor defines the Color4 object where to store the gamma space version
  5335. * @returns the unmodified Color4
  5336. */
  5337. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5338. /**
  5339. * Creates a new Color4 from the string containing valid hexadecimal values
  5340. * @param hex defines a string containing valid hexadecimal values
  5341. * @returns a new Color4 object
  5342. */
  5343. static FromHexString(hex: string): Color4;
  5344. /**
  5345. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5346. * @param left defines the start value
  5347. * @param right defines the end value
  5348. * @param amount defines the gradient factor
  5349. * @returns a new Color4 object
  5350. */
  5351. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5352. /**
  5353. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5354. * @param left defines the start value
  5355. * @param right defines the end value
  5356. * @param amount defines the gradient factor
  5357. * @param result defines the Color4 object where to store data
  5358. */
  5359. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5360. /**
  5361. * Creates a new Color4 from a Color3 and an alpha value
  5362. * @param color3 defines the source Color3 to read from
  5363. * @param alpha defines the alpha component (1.0 by default)
  5364. * @returns a new Color4 object
  5365. */
  5366. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5367. /**
  5368. * Creates a new Color4 from the starting index element of the given array
  5369. * @param array defines the source array to read from
  5370. * @param offset defines the offset in the source array
  5371. * @returns a new Color4 object
  5372. */
  5373. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5374. /**
  5375. * Creates a new Color3 from integer values (< 256)
  5376. * @param r defines the red component to read from (value between 0 and 255)
  5377. * @param g defines the green component to read from (value between 0 and 255)
  5378. * @param b defines the blue component to read from (value between 0 and 255)
  5379. * @param a defines the alpha component to read from (value between 0 and 255)
  5380. * @returns a new Color3 object
  5381. */
  5382. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5383. /**
  5384. * Check the content of a given array and convert it to an array containing RGBA data
  5385. * If the original array was already containing count * 4 values then it is returned directly
  5386. * @param colors defines the array to check
  5387. * @param count defines the number of RGBA data to expect
  5388. * @returns an array containing count * 4 values (RGBA)
  5389. */
  5390. static CheckColors4(colors: number[], count: number): number[];
  5391. }
  5392. /**
  5393. * @hidden
  5394. */
  5395. export class TmpColors {
  5396. static Color3: Color3[];
  5397. static Color4: Color4[];
  5398. }
  5399. }
  5400. declare module "babylonjs/Maths/sphericalPolynomial" {
  5401. import { Vector3 } from "babylonjs/Maths/math.vector";
  5402. import { Color3 } from "babylonjs/Maths/math.color";
  5403. /**
  5404. * Class representing spherical harmonics coefficients to the 3rd degree
  5405. */
  5406. export class SphericalHarmonics {
  5407. /**
  5408. * Defines whether or not the harmonics have been prescaled for rendering.
  5409. */
  5410. preScaled: boolean;
  5411. /**
  5412. * The l0,0 coefficients of the spherical harmonics
  5413. */
  5414. l00: Vector3;
  5415. /**
  5416. * The l1,-1 coefficients of the spherical harmonics
  5417. */
  5418. l1_1: Vector3;
  5419. /**
  5420. * The l1,0 coefficients of the spherical harmonics
  5421. */
  5422. l10: Vector3;
  5423. /**
  5424. * The l1,1 coefficients of the spherical harmonics
  5425. */
  5426. l11: Vector3;
  5427. /**
  5428. * The l2,-2 coefficients of the spherical harmonics
  5429. */
  5430. l2_2: Vector3;
  5431. /**
  5432. * The l2,-1 coefficients of the spherical harmonics
  5433. */
  5434. l2_1: Vector3;
  5435. /**
  5436. * The l2,0 coefficients of the spherical harmonics
  5437. */
  5438. l20: Vector3;
  5439. /**
  5440. * The l2,1 coefficients of the spherical harmonics
  5441. */
  5442. l21: Vector3;
  5443. /**
  5444. * The l2,2 coefficients of the spherical harmonics
  5445. */
  5446. l22: Vector3;
  5447. /**
  5448. * Adds a light to the spherical harmonics
  5449. * @param direction the direction of the light
  5450. * @param color the color of the light
  5451. * @param deltaSolidAngle the delta solid angle of the light
  5452. */
  5453. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  5454. /**
  5455. * Scales the spherical harmonics by the given amount
  5456. * @param scale the amount to scale
  5457. */
  5458. scaleInPlace(scale: number): void;
  5459. /**
  5460. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  5461. *
  5462. * ```
  5463. * E_lm = A_l * L_lm
  5464. * ```
  5465. *
  5466. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  5467. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  5468. * the scaling factors are given in equation 9.
  5469. */
  5470. convertIncidentRadianceToIrradiance(): void;
  5471. /**
  5472. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  5473. *
  5474. * ```
  5475. * L = (1/pi) * E * rho
  5476. * ```
  5477. *
  5478. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  5479. */
  5480. convertIrradianceToLambertianRadiance(): void;
  5481. /**
  5482. * Integrates the reconstruction coefficients directly in to the SH preventing further
  5483. * required operations at run time.
  5484. *
  5485. * This is simply done by scaling back the SH with Ylm constants parameter.
  5486. * The trigonometric part being applied by the shader at run time.
  5487. */
  5488. preScaleForRendering(): void;
  5489. /**
  5490. * Constructs a spherical harmonics from an array.
  5491. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  5492. * @returns the spherical harmonics
  5493. */
  5494. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  5495. /**
  5496. * Gets the spherical harmonics from polynomial
  5497. * @param polynomial the spherical polynomial
  5498. * @returns the spherical harmonics
  5499. */
  5500. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  5501. }
  5502. /**
  5503. * Class representing spherical polynomial coefficients to the 3rd degree
  5504. */
  5505. export class SphericalPolynomial {
  5506. private _harmonics;
  5507. /**
  5508. * The spherical harmonics used to create the polynomials.
  5509. */
  5510. readonly preScaledHarmonics: SphericalHarmonics;
  5511. /**
  5512. * The x coefficients of the spherical polynomial
  5513. */
  5514. x: Vector3;
  5515. /**
  5516. * The y coefficients of the spherical polynomial
  5517. */
  5518. y: Vector3;
  5519. /**
  5520. * The z coefficients of the spherical polynomial
  5521. */
  5522. z: Vector3;
  5523. /**
  5524. * The xx coefficients of the spherical polynomial
  5525. */
  5526. xx: Vector3;
  5527. /**
  5528. * The yy coefficients of the spherical polynomial
  5529. */
  5530. yy: Vector3;
  5531. /**
  5532. * The zz coefficients of the spherical polynomial
  5533. */
  5534. zz: Vector3;
  5535. /**
  5536. * The xy coefficients of the spherical polynomial
  5537. */
  5538. xy: Vector3;
  5539. /**
  5540. * The yz coefficients of the spherical polynomial
  5541. */
  5542. yz: Vector3;
  5543. /**
  5544. * The zx coefficients of the spherical polynomial
  5545. */
  5546. zx: Vector3;
  5547. /**
  5548. * Adds an ambient color to the spherical polynomial
  5549. * @param color the color to add
  5550. */
  5551. addAmbient(color: Color3): void;
  5552. /**
  5553. * Scales the spherical polynomial by the given amount
  5554. * @param scale the amount to scale
  5555. */
  5556. scaleInPlace(scale: number): void;
  5557. /**
  5558. * Gets the spherical polynomial from harmonics
  5559. * @param harmonics the spherical harmonics
  5560. * @returns the spherical polynomial
  5561. */
  5562. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  5563. /**
  5564. * Constructs a spherical polynomial from an array.
  5565. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  5566. * @returns the spherical polynomial
  5567. */
  5568. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  5569. }
  5570. }
  5571. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  5572. /**
  5573. * Define options used to create a render target texture
  5574. */
  5575. export class RenderTargetCreationOptions {
  5576. /**
  5577. * Specifies is mipmaps must be generated
  5578. */
  5579. generateMipMaps?: boolean;
  5580. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  5581. generateDepthBuffer?: boolean;
  5582. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  5583. generateStencilBuffer?: boolean;
  5584. /** Defines texture type (int by default) */
  5585. type?: number;
  5586. /** Defines sampling mode (trilinear by default) */
  5587. samplingMode?: number;
  5588. /** Defines format (RGBA by default) */
  5589. format?: number;
  5590. }
  5591. }
  5592. declare module "babylonjs/States/alphaCullingState" {
  5593. /**
  5594. * @hidden
  5595. **/
  5596. export class _AlphaState {
  5597. private _isAlphaBlendDirty;
  5598. private _isBlendFunctionParametersDirty;
  5599. private _isBlendEquationParametersDirty;
  5600. private _isBlendConstantsDirty;
  5601. private _alphaBlend;
  5602. private _blendFunctionParameters;
  5603. private _blendEquationParameters;
  5604. private _blendConstants;
  5605. /**
  5606. * Initializes the state.
  5607. */
  5608. constructor();
  5609. readonly isDirty: boolean;
  5610. alphaBlend: boolean;
  5611. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  5612. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  5613. setAlphaEquationParameters(rgb: number, alpha: number): void;
  5614. reset(): void;
  5615. apply(gl: WebGLRenderingContext): void;
  5616. }
  5617. }
  5618. declare module "babylonjs/States/depthCullingState" {
  5619. import { Nullable } from "babylonjs/types";
  5620. /**
  5621. * @hidden
  5622. **/
  5623. export class _DepthCullingState {
  5624. private _isDepthTestDirty;
  5625. private _isDepthMaskDirty;
  5626. private _isDepthFuncDirty;
  5627. private _isCullFaceDirty;
  5628. private _isCullDirty;
  5629. private _isZOffsetDirty;
  5630. private _isFrontFaceDirty;
  5631. private _depthTest;
  5632. private _depthMask;
  5633. private _depthFunc;
  5634. private _cull;
  5635. private _cullFace;
  5636. private _zOffset;
  5637. private _frontFace;
  5638. /**
  5639. * Initializes the state.
  5640. */
  5641. constructor();
  5642. readonly isDirty: boolean;
  5643. zOffset: number;
  5644. cullFace: Nullable<number>;
  5645. cull: Nullable<boolean>;
  5646. depthFunc: Nullable<number>;
  5647. depthMask: boolean;
  5648. depthTest: boolean;
  5649. frontFace: Nullable<number>;
  5650. reset(): void;
  5651. apply(gl: WebGLRenderingContext): void;
  5652. }
  5653. }
  5654. declare module "babylonjs/States/stencilState" {
  5655. /**
  5656. * @hidden
  5657. **/
  5658. export class _StencilState {
  5659. /** 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 */
  5660. static readonly ALWAYS: number;
  5661. /** Passed to stencilOperation to specify that stencil value must be kept */
  5662. static readonly KEEP: number;
  5663. /** Passed to stencilOperation to specify that stencil value must be replaced */
  5664. static readonly REPLACE: number;
  5665. private _isStencilTestDirty;
  5666. private _isStencilMaskDirty;
  5667. private _isStencilFuncDirty;
  5668. private _isStencilOpDirty;
  5669. private _stencilTest;
  5670. private _stencilMask;
  5671. private _stencilFunc;
  5672. private _stencilFuncRef;
  5673. private _stencilFuncMask;
  5674. private _stencilOpStencilFail;
  5675. private _stencilOpDepthFail;
  5676. private _stencilOpStencilDepthPass;
  5677. readonly isDirty: boolean;
  5678. stencilFunc: number;
  5679. stencilFuncRef: number;
  5680. stencilFuncMask: number;
  5681. stencilOpStencilFail: number;
  5682. stencilOpDepthFail: number;
  5683. stencilOpStencilDepthPass: number;
  5684. stencilMask: number;
  5685. stencilTest: boolean;
  5686. constructor();
  5687. reset(): void;
  5688. apply(gl: WebGLRenderingContext): void;
  5689. }
  5690. }
  5691. declare module "babylonjs/States/index" {
  5692. export * from "babylonjs/States/alphaCullingState";
  5693. export * from "babylonjs/States/depthCullingState";
  5694. export * from "babylonjs/States/stencilState";
  5695. }
  5696. declare module "babylonjs/Instrumentation/timeToken" {
  5697. import { Nullable } from "babylonjs/types";
  5698. /**
  5699. * @hidden
  5700. **/
  5701. export class _TimeToken {
  5702. _startTimeQuery: Nullable<WebGLQuery>;
  5703. _endTimeQuery: Nullable<WebGLQuery>;
  5704. _timeElapsedQuery: Nullable<WebGLQuery>;
  5705. _timeElapsedQueryEnded: boolean;
  5706. }
  5707. }
  5708. declare module "babylonjs/Misc/andOrNotEvaluator" {
  5709. /**
  5710. * Class used to evalaute queries containing `and` and `or` operators
  5711. */
  5712. export class AndOrNotEvaluator {
  5713. /**
  5714. * Evaluate a query
  5715. * @param query defines the query to evaluate
  5716. * @param evaluateCallback defines the callback used to filter result
  5717. * @returns true if the query matches
  5718. */
  5719. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  5720. private static _HandleParenthesisContent;
  5721. private static _SimplifyNegation;
  5722. }
  5723. }
  5724. declare module "babylonjs/Misc/tags" {
  5725. /**
  5726. * Class used to store custom tags
  5727. */
  5728. export class Tags {
  5729. /**
  5730. * Adds support for tags on the given object
  5731. * @param obj defines the object to use
  5732. */
  5733. static EnableFor(obj: any): void;
  5734. /**
  5735. * Removes tags support
  5736. * @param obj defines the object to use
  5737. */
  5738. static DisableFor(obj: any): void;
  5739. /**
  5740. * Gets a boolean indicating if the given object has tags
  5741. * @param obj defines the object to use
  5742. * @returns a boolean
  5743. */
  5744. static HasTags(obj: any): boolean;
  5745. /**
  5746. * Gets the tags available on a given object
  5747. * @param obj defines the object to use
  5748. * @param asString defines if the tags must be returned as a string instead of an array of strings
  5749. * @returns the tags
  5750. */
  5751. static GetTags(obj: any, asString?: boolean): any;
  5752. /**
  5753. * Adds tags to an object
  5754. * @param obj defines the object to use
  5755. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  5756. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  5757. */
  5758. static AddTagsTo(obj: any, tagsString: string): void;
  5759. /**
  5760. * @hidden
  5761. */
  5762. static _AddTagTo(obj: any, tag: string): void;
  5763. /**
  5764. * Removes specific tags from a specific object
  5765. * @param obj defines the object to use
  5766. * @param tagsString defines the tags to remove
  5767. */
  5768. static RemoveTagsFrom(obj: any, tagsString: string): void;
  5769. /**
  5770. * @hidden
  5771. */
  5772. static _RemoveTagFrom(obj: any, tag: string): void;
  5773. /**
  5774. * Defines if tags hosted on an object match a given query
  5775. * @param obj defines the object to use
  5776. * @param tagsQuery defines the tag query
  5777. * @returns a boolean
  5778. */
  5779. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  5780. }
  5781. }
  5782. declare module "babylonjs/Maths/math.path" {
  5783. import { DeepImmutable, Nullable } from "babylonjs/types";
  5784. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  5785. /**
  5786. * Defines potential orientation for back face culling
  5787. */
  5788. export enum Orientation {
  5789. /**
  5790. * Clockwise
  5791. */
  5792. CW = 0,
  5793. /** Counter clockwise */
  5794. CCW = 1
  5795. }
  5796. /** Class used to represent a Bezier curve */
  5797. export class BezierCurve {
  5798. /**
  5799. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  5800. * @param t defines the time
  5801. * @param x1 defines the left coordinate on X axis
  5802. * @param y1 defines the left coordinate on Y axis
  5803. * @param x2 defines the right coordinate on X axis
  5804. * @param y2 defines the right coordinate on Y axis
  5805. * @returns the interpolated value
  5806. */
  5807. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  5808. }
  5809. /**
  5810. * Defines angle representation
  5811. */
  5812. export class Angle {
  5813. private _radians;
  5814. /**
  5815. * Creates an Angle object of "radians" radians (float).
  5816. * @param radians the angle in radians
  5817. */
  5818. constructor(radians: number);
  5819. /**
  5820. * Get value in degrees
  5821. * @returns the Angle value in degrees (float)
  5822. */
  5823. degrees(): number;
  5824. /**
  5825. * Get value in radians
  5826. * @returns the Angle value in radians (float)
  5827. */
  5828. radians(): number;
  5829. /**
  5830. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  5831. * @param a defines first vector
  5832. * @param b defines second vector
  5833. * @returns a new Angle
  5834. */
  5835. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  5836. /**
  5837. * Gets a new Angle object from the given float in radians
  5838. * @param radians defines the angle value in radians
  5839. * @returns a new Angle
  5840. */
  5841. static FromRadians(radians: number): Angle;
  5842. /**
  5843. * Gets a new Angle object from the given float in degrees
  5844. * @param degrees defines the angle value in degrees
  5845. * @returns a new Angle
  5846. */
  5847. static FromDegrees(degrees: number): Angle;
  5848. }
  5849. /**
  5850. * This represents an arc in a 2d space.
  5851. */
  5852. export class Arc2 {
  5853. /** Defines the start point of the arc */
  5854. startPoint: Vector2;
  5855. /** Defines the mid point of the arc */
  5856. midPoint: Vector2;
  5857. /** Defines the end point of the arc */
  5858. endPoint: Vector2;
  5859. /**
  5860. * Defines the center point of the arc.
  5861. */
  5862. centerPoint: Vector2;
  5863. /**
  5864. * Defines the radius of the arc.
  5865. */
  5866. radius: number;
  5867. /**
  5868. * Defines the angle of the arc (from mid point to end point).
  5869. */
  5870. angle: Angle;
  5871. /**
  5872. * Defines the start angle of the arc (from start point to middle point).
  5873. */
  5874. startAngle: Angle;
  5875. /**
  5876. * Defines the orientation of the arc (clock wise/counter clock wise).
  5877. */
  5878. orientation: Orientation;
  5879. /**
  5880. * Creates an Arc object from the three given points : start, middle and end.
  5881. * @param startPoint Defines the start point of the arc
  5882. * @param midPoint Defines the midlle point of the arc
  5883. * @param endPoint Defines the end point of the arc
  5884. */
  5885. constructor(
  5886. /** Defines the start point of the arc */
  5887. startPoint: Vector2,
  5888. /** Defines the mid point of the arc */
  5889. midPoint: Vector2,
  5890. /** Defines the end point of the arc */
  5891. endPoint: Vector2);
  5892. }
  5893. /**
  5894. * Represents a 2D path made up of multiple 2D points
  5895. */
  5896. export class Path2 {
  5897. private _points;
  5898. private _length;
  5899. /**
  5900. * If the path start and end point are the same
  5901. */
  5902. closed: boolean;
  5903. /**
  5904. * Creates a Path2 object from the starting 2D coordinates x and y.
  5905. * @param x the starting points x value
  5906. * @param y the starting points y value
  5907. */
  5908. constructor(x: number, y: number);
  5909. /**
  5910. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  5911. * @param x the added points x value
  5912. * @param y the added points y value
  5913. * @returns the updated Path2.
  5914. */
  5915. addLineTo(x: number, y: number): Path2;
  5916. /**
  5917. * 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.
  5918. * @param midX middle point x value
  5919. * @param midY middle point y value
  5920. * @param endX end point x value
  5921. * @param endY end point y value
  5922. * @param numberOfSegments (default: 36)
  5923. * @returns the updated Path2.
  5924. */
  5925. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5926. /**
  5927. * Closes the Path2.
  5928. * @returns the Path2.
  5929. */
  5930. close(): Path2;
  5931. /**
  5932. * Gets the sum of the distance between each sequential point in the path
  5933. * @returns the Path2 total length (float).
  5934. */
  5935. length(): number;
  5936. /**
  5937. * Gets the points which construct the path
  5938. * @returns the Path2 internal array of points.
  5939. */
  5940. getPoints(): Vector2[];
  5941. /**
  5942. * Retreives the point at the distance aways from the starting point
  5943. * @param normalizedLengthPosition the length along the path to retreive the point from
  5944. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5945. */
  5946. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5947. /**
  5948. * Creates a new path starting from an x and y position
  5949. * @param x starting x value
  5950. * @param y starting y value
  5951. * @returns a new Path2 starting at the coordinates (x, y).
  5952. */
  5953. static StartingAt(x: number, y: number): Path2;
  5954. }
  5955. /**
  5956. * Represents a 3D path made up of multiple 3D points
  5957. */
  5958. export class Path3D {
  5959. /**
  5960. * an array of Vector3, the curve axis of the Path3D
  5961. */
  5962. path: Vector3[];
  5963. private _curve;
  5964. private _distances;
  5965. private _tangents;
  5966. private _normals;
  5967. private _binormals;
  5968. private _raw;
  5969. /**
  5970. * new Path3D(path, normal, raw)
  5971. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5972. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5973. * @param path an array of Vector3, the curve axis of the Path3D
  5974. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5975. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5976. */
  5977. constructor(
  5978. /**
  5979. * an array of Vector3, the curve axis of the Path3D
  5980. */
  5981. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  5982. /**
  5983. * Returns the Path3D array of successive Vector3 designing its curve.
  5984. * @returns the Path3D array of successive Vector3 designing its curve.
  5985. */
  5986. getCurve(): Vector3[];
  5987. /**
  5988. * Returns an array populated with tangent vectors on each Path3D curve point.
  5989. * @returns an array populated with tangent vectors on each Path3D curve point.
  5990. */
  5991. getTangents(): Vector3[];
  5992. /**
  5993. * Returns an array populated with normal vectors on each Path3D curve point.
  5994. * @returns an array populated with normal vectors on each Path3D curve point.
  5995. */
  5996. getNormals(): Vector3[];
  5997. /**
  5998. * Returns an array populated with binormal vectors on each Path3D curve point.
  5999. * @returns an array populated with binormal vectors on each Path3D curve point.
  6000. */
  6001. getBinormals(): Vector3[];
  6002. /**
  6003. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  6004. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  6005. */
  6006. getDistances(): number[];
  6007. /**
  6008. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  6009. * @param path path which all values are copied into the curves points
  6010. * @param firstNormal which should be projected onto the curve
  6011. * @returns the same object updated.
  6012. */
  6013. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  6014. private _compute;
  6015. private _getFirstNonNullVector;
  6016. private _getLastNonNullVector;
  6017. private _normalVector;
  6018. }
  6019. /**
  6020. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  6021. * A Curve3 is designed from a series of successive Vector3.
  6022. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  6023. */
  6024. export class Curve3 {
  6025. private _points;
  6026. private _length;
  6027. /**
  6028. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  6029. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  6030. * @param v1 (Vector3) the control point
  6031. * @param v2 (Vector3) the end point of the Quadratic Bezier
  6032. * @param nbPoints (integer) the wanted number of points in the curve
  6033. * @returns the created Curve3
  6034. */
  6035. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  6036. /**
  6037. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  6038. * @param v0 (Vector3) the origin point of the Cubic Bezier
  6039. * @param v1 (Vector3) the first control point
  6040. * @param v2 (Vector3) the second control point
  6041. * @param v3 (Vector3) the end point of the Cubic Bezier
  6042. * @param nbPoints (integer) the wanted number of points in the curve
  6043. * @returns the created Curve3
  6044. */
  6045. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  6046. /**
  6047. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  6048. * @param p1 (Vector3) the origin point of the Hermite Spline
  6049. * @param t1 (Vector3) the tangent vector at the origin point
  6050. * @param p2 (Vector3) the end point of the Hermite Spline
  6051. * @param t2 (Vector3) the tangent vector at the end point
  6052. * @param nbPoints (integer) the wanted number of points in the curve
  6053. * @returns the created Curve3
  6054. */
  6055. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  6056. /**
  6057. * Returns a Curve3 object along a CatmullRom Spline curve :
  6058. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  6059. * @param nbPoints (integer) the wanted number of points between each curve control points
  6060. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  6061. * @returns the created Curve3
  6062. */
  6063. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  6064. /**
  6065. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  6066. * A Curve3 is designed from a series of successive Vector3.
  6067. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  6068. * @param points points which make up the curve
  6069. */
  6070. constructor(points: Vector3[]);
  6071. /**
  6072. * @returns the Curve3 stored array of successive Vector3
  6073. */
  6074. getPoints(): Vector3[];
  6075. /**
  6076. * @returns the computed length (float) of the curve.
  6077. */
  6078. length(): number;
  6079. /**
  6080. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  6081. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  6082. * curveA and curveB keep unchanged.
  6083. * @param curve the curve to continue from this curve
  6084. * @returns the newly constructed curve
  6085. */
  6086. continue(curve: DeepImmutable<Curve3>): Curve3;
  6087. private _computeLength;
  6088. }
  6089. }
  6090. declare module "babylonjs/Animations/easing" {
  6091. /**
  6092. * This represents the main contract an easing function should follow.
  6093. * Easing functions are used throughout the animation system.
  6094. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6095. */
  6096. export interface IEasingFunction {
  6097. /**
  6098. * Given an input gradient between 0 and 1, this returns the corrseponding value
  6099. * of the easing function.
  6100. * The link below provides some of the most common examples of easing functions.
  6101. * @see https://easings.net/
  6102. * @param gradient Defines the value between 0 and 1 we want the easing value for
  6103. * @returns the corresponding value on the curve defined by the easing function
  6104. */
  6105. ease(gradient: number): number;
  6106. }
  6107. /**
  6108. * Base class used for every default easing function.
  6109. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6110. */
  6111. export class EasingFunction implements IEasingFunction {
  6112. /**
  6113. * Interpolation follows the mathematical formula associated with the easing function.
  6114. */
  6115. static readonly EASINGMODE_EASEIN: number;
  6116. /**
  6117. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  6118. */
  6119. static readonly EASINGMODE_EASEOUT: number;
  6120. /**
  6121. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  6122. */
  6123. static readonly EASINGMODE_EASEINOUT: number;
  6124. private _easingMode;
  6125. /**
  6126. * Sets the easing mode of the current function.
  6127. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  6128. */
  6129. setEasingMode(easingMode: number): void;
  6130. /**
  6131. * Gets the current easing mode.
  6132. * @returns the easing mode
  6133. */
  6134. getEasingMode(): number;
  6135. /**
  6136. * @hidden
  6137. */
  6138. easeInCore(gradient: number): number;
  6139. /**
  6140. * Given an input gradient between 0 and 1, this returns the corresponding value
  6141. * of the easing function.
  6142. * @param gradient Defines the value between 0 and 1 we want the easing value for
  6143. * @returns the corresponding value on the curve defined by the easing function
  6144. */
  6145. ease(gradient: number): number;
  6146. }
  6147. /**
  6148. * Easing function with a circle shape (see link below).
  6149. * @see https://easings.net/#easeInCirc
  6150. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6151. */
  6152. export class CircleEase extends EasingFunction implements IEasingFunction {
  6153. /** @hidden */
  6154. easeInCore(gradient: number): number;
  6155. }
  6156. /**
  6157. * Easing function with a ease back shape (see link below).
  6158. * @see https://easings.net/#easeInBack
  6159. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6160. */
  6161. export class BackEase extends EasingFunction implements IEasingFunction {
  6162. /** Defines the amplitude of the function */
  6163. amplitude: number;
  6164. /**
  6165. * Instantiates a back ease easing
  6166. * @see https://easings.net/#easeInBack
  6167. * @param amplitude Defines the amplitude of the function
  6168. */
  6169. constructor(
  6170. /** Defines the amplitude of the function */
  6171. amplitude?: number);
  6172. /** @hidden */
  6173. easeInCore(gradient: number): number;
  6174. }
  6175. /**
  6176. * Easing function with a bouncing shape (see link below).
  6177. * @see https://easings.net/#easeInBounce
  6178. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6179. */
  6180. export class BounceEase extends EasingFunction implements IEasingFunction {
  6181. /** Defines the number of bounces */
  6182. bounces: number;
  6183. /** Defines the amplitude of the bounce */
  6184. bounciness: number;
  6185. /**
  6186. * Instantiates a bounce easing
  6187. * @see https://easings.net/#easeInBounce
  6188. * @param bounces Defines the number of bounces
  6189. * @param bounciness Defines the amplitude of the bounce
  6190. */
  6191. constructor(
  6192. /** Defines the number of bounces */
  6193. bounces?: number,
  6194. /** Defines the amplitude of the bounce */
  6195. bounciness?: number);
  6196. /** @hidden */
  6197. easeInCore(gradient: number): number;
  6198. }
  6199. /**
  6200. * Easing function with a power of 3 shape (see link below).
  6201. * @see https://easings.net/#easeInCubic
  6202. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6203. */
  6204. export class CubicEase extends EasingFunction implements IEasingFunction {
  6205. /** @hidden */
  6206. easeInCore(gradient: number): number;
  6207. }
  6208. /**
  6209. * Easing function with an elastic shape (see link below).
  6210. * @see https://easings.net/#easeInElastic
  6211. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6212. */
  6213. export class ElasticEase extends EasingFunction implements IEasingFunction {
  6214. /** Defines the number of oscillations*/
  6215. oscillations: number;
  6216. /** Defines the amplitude of the oscillations*/
  6217. springiness: number;
  6218. /**
  6219. * Instantiates an elastic easing function
  6220. * @see https://easings.net/#easeInElastic
  6221. * @param oscillations Defines the number of oscillations
  6222. * @param springiness Defines the amplitude of the oscillations
  6223. */
  6224. constructor(
  6225. /** Defines the number of oscillations*/
  6226. oscillations?: number,
  6227. /** Defines the amplitude of the oscillations*/
  6228. springiness?: number);
  6229. /** @hidden */
  6230. easeInCore(gradient: number): number;
  6231. }
  6232. /**
  6233. * Easing function with an exponential shape (see link below).
  6234. * @see https://easings.net/#easeInExpo
  6235. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6236. */
  6237. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  6238. /** Defines the exponent of the function */
  6239. exponent: number;
  6240. /**
  6241. * Instantiates an exponential easing function
  6242. * @see https://easings.net/#easeInExpo
  6243. * @param exponent Defines the exponent of the function
  6244. */
  6245. constructor(
  6246. /** Defines the exponent of the function */
  6247. exponent?: number);
  6248. /** @hidden */
  6249. easeInCore(gradient: number): number;
  6250. }
  6251. /**
  6252. * Easing function with a power shape (see link below).
  6253. * @see https://easings.net/#easeInQuad
  6254. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6255. */
  6256. export class PowerEase extends EasingFunction implements IEasingFunction {
  6257. /** Defines the power of the function */
  6258. power: number;
  6259. /**
  6260. * Instantiates an power base easing function
  6261. * @see https://easings.net/#easeInQuad
  6262. * @param power Defines the power of the function
  6263. */
  6264. constructor(
  6265. /** Defines the power of the function */
  6266. power?: number);
  6267. /** @hidden */
  6268. easeInCore(gradient: number): number;
  6269. }
  6270. /**
  6271. * Easing function with a power of 2 shape (see link below).
  6272. * @see https://easings.net/#easeInQuad
  6273. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6274. */
  6275. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  6276. /** @hidden */
  6277. easeInCore(gradient: number): number;
  6278. }
  6279. /**
  6280. * Easing function with a power of 4 shape (see link below).
  6281. * @see https://easings.net/#easeInQuart
  6282. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6283. */
  6284. export class QuarticEase extends EasingFunction implements IEasingFunction {
  6285. /** @hidden */
  6286. easeInCore(gradient: number): number;
  6287. }
  6288. /**
  6289. * Easing function with a power of 5 shape (see link below).
  6290. * @see https://easings.net/#easeInQuint
  6291. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6292. */
  6293. export class QuinticEase extends EasingFunction implements IEasingFunction {
  6294. /** @hidden */
  6295. easeInCore(gradient: number): number;
  6296. }
  6297. /**
  6298. * Easing function with a sin shape (see link below).
  6299. * @see https://easings.net/#easeInSine
  6300. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6301. */
  6302. export class SineEase extends EasingFunction implements IEasingFunction {
  6303. /** @hidden */
  6304. easeInCore(gradient: number): number;
  6305. }
  6306. /**
  6307. * Easing function with a bezier shape (see link below).
  6308. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  6309. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  6310. */
  6311. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  6312. /** Defines the x component of the start tangent in the bezier curve */
  6313. x1: number;
  6314. /** Defines the y component of the start tangent in the bezier curve */
  6315. y1: number;
  6316. /** Defines the x component of the end tangent in the bezier curve */
  6317. x2: number;
  6318. /** Defines the y component of the end tangent in the bezier curve */
  6319. y2: number;
  6320. /**
  6321. * Instantiates a bezier function
  6322. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  6323. * @param x1 Defines the x component of the start tangent in the bezier curve
  6324. * @param y1 Defines the y component of the start tangent in the bezier curve
  6325. * @param x2 Defines the x component of the end tangent in the bezier curve
  6326. * @param y2 Defines the y component of the end tangent in the bezier curve
  6327. */
  6328. constructor(
  6329. /** Defines the x component of the start tangent in the bezier curve */
  6330. x1?: number,
  6331. /** Defines the y component of the start tangent in the bezier curve */
  6332. y1?: number,
  6333. /** Defines the x component of the end tangent in the bezier curve */
  6334. x2?: number,
  6335. /** Defines the y component of the end tangent in the bezier curve */
  6336. y2?: number);
  6337. /** @hidden */
  6338. easeInCore(gradient: number): number;
  6339. }
  6340. }
  6341. declare module "babylonjs/Animations/animationKey" {
  6342. /**
  6343. * Defines an interface which represents an animation key frame
  6344. */
  6345. export interface IAnimationKey {
  6346. /**
  6347. * Frame of the key frame
  6348. */
  6349. frame: number;
  6350. /**
  6351. * Value at the specifies key frame
  6352. */
  6353. value: any;
  6354. /**
  6355. * The input tangent for the cubic hermite spline
  6356. */
  6357. inTangent?: any;
  6358. /**
  6359. * The output tangent for the cubic hermite spline
  6360. */
  6361. outTangent?: any;
  6362. /**
  6363. * The animation interpolation type
  6364. */
  6365. interpolation?: AnimationKeyInterpolation;
  6366. }
  6367. /**
  6368. * Enum for the animation key frame interpolation type
  6369. */
  6370. export enum AnimationKeyInterpolation {
  6371. /**
  6372. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6373. */
  6374. STEP = 1
  6375. }
  6376. }
  6377. declare module "babylonjs/Animations/animationRange" {
  6378. /**
  6379. * Represents the range of an animation
  6380. */
  6381. export class AnimationRange {
  6382. /**The name of the animation range**/
  6383. name: string;
  6384. /**The starting frame of the animation */
  6385. from: number;
  6386. /**The ending frame of the animation*/
  6387. to: number;
  6388. /**
  6389. * Initializes the range of an animation
  6390. * @param name The name of the animation range
  6391. * @param from The starting frame of the animation
  6392. * @param to The ending frame of the animation
  6393. */
  6394. constructor(
  6395. /**The name of the animation range**/
  6396. name: string,
  6397. /**The starting frame of the animation */
  6398. from: number,
  6399. /**The ending frame of the animation*/
  6400. to: number);
  6401. /**
  6402. * Makes a copy of the animation range
  6403. * @returns A copy of the animation range
  6404. */
  6405. clone(): AnimationRange;
  6406. }
  6407. }
  6408. declare module "babylonjs/Animations/animationEvent" {
  6409. /**
  6410. * Composed of a frame, and an action function
  6411. */
  6412. export class AnimationEvent {
  6413. /** The frame for which the event is triggered **/
  6414. frame: number;
  6415. /** The event to perform when triggered **/
  6416. action: (currentFrame: number) => void;
  6417. /** Specifies if the event should be triggered only once**/
  6418. onlyOnce?: boolean | undefined;
  6419. /**
  6420. * Specifies if the animation event is done
  6421. */
  6422. isDone: boolean;
  6423. /**
  6424. * Initializes the animation event
  6425. * @param frame The frame for which the event is triggered
  6426. * @param action The event to perform when triggered
  6427. * @param onlyOnce Specifies if the event should be triggered only once
  6428. */
  6429. constructor(
  6430. /** The frame for which the event is triggered **/
  6431. frame: number,
  6432. /** The event to perform when triggered **/
  6433. action: (currentFrame: number) => void,
  6434. /** Specifies if the event should be triggered only once**/
  6435. onlyOnce?: boolean | undefined);
  6436. /** @hidden */
  6437. _clone(): AnimationEvent;
  6438. }
  6439. }
  6440. declare module "babylonjs/Behaviors/behavior" {
  6441. import { Nullable } from "babylonjs/types";
  6442. /**
  6443. * Interface used to define a behavior
  6444. */
  6445. export interface Behavior<T> {
  6446. /** gets or sets behavior's name */
  6447. name: string;
  6448. /**
  6449. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6450. */
  6451. init(): void;
  6452. /**
  6453. * Called when the behavior is attached to a target
  6454. * @param target defines the target where the behavior is attached to
  6455. */
  6456. attach(target: T): void;
  6457. /**
  6458. * Called when the behavior is detached from its target
  6459. */
  6460. detach(): void;
  6461. }
  6462. /**
  6463. * Interface implemented by classes supporting behaviors
  6464. */
  6465. export interface IBehaviorAware<T> {
  6466. /**
  6467. * Attach a behavior
  6468. * @param behavior defines the behavior to attach
  6469. * @returns the current host
  6470. */
  6471. addBehavior(behavior: Behavior<T>): T;
  6472. /**
  6473. * Remove a behavior from the current object
  6474. * @param behavior defines the behavior to detach
  6475. * @returns the current host
  6476. */
  6477. removeBehavior(behavior: Behavior<T>): T;
  6478. /**
  6479. * Gets a behavior using its name to search
  6480. * @param name defines the name to search
  6481. * @returns the behavior or null if not found
  6482. */
  6483. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6484. }
  6485. }
  6486. declare module "babylonjs/Misc/smartArray" {
  6487. /**
  6488. * Defines an array and its length.
  6489. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6490. */
  6491. export interface ISmartArrayLike<T> {
  6492. /**
  6493. * The data of the array.
  6494. */
  6495. data: Array<T>;
  6496. /**
  6497. * The active length of the array.
  6498. */
  6499. length: number;
  6500. }
  6501. /**
  6502. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6503. */
  6504. export class SmartArray<T> implements ISmartArrayLike<T> {
  6505. /**
  6506. * The full set of data from the array.
  6507. */
  6508. data: Array<T>;
  6509. /**
  6510. * The active length of the array.
  6511. */
  6512. length: number;
  6513. protected _id: number;
  6514. /**
  6515. * Instantiates a Smart Array.
  6516. * @param capacity defines the default capacity of the array.
  6517. */
  6518. constructor(capacity: number);
  6519. /**
  6520. * Pushes a value at the end of the active data.
  6521. * @param value defines the object to push in the array.
  6522. */
  6523. push(value: T): void;
  6524. /**
  6525. * Iterates over the active data and apply the lambda to them.
  6526. * @param func defines the action to apply on each value.
  6527. */
  6528. forEach(func: (content: T) => void): void;
  6529. /**
  6530. * Sorts the full sets of data.
  6531. * @param compareFn defines the comparison function to apply.
  6532. */
  6533. sort(compareFn: (a: T, b: T) => number): void;
  6534. /**
  6535. * Resets the active data to an empty array.
  6536. */
  6537. reset(): void;
  6538. /**
  6539. * Releases all the data from the array as well as the array.
  6540. */
  6541. dispose(): void;
  6542. /**
  6543. * Concats the active data with a given array.
  6544. * @param array defines the data to concatenate with.
  6545. */
  6546. concat(array: any): void;
  6547. /**
  6548. * Returns the position of a value in the active data.
  6549. * @param value defines the value to find the index for
  6550. * @returns the index if found in the active data otherwise -1
  6551. */
  6552. indexOf(value: T): number;
  6553. /**
  6554. * Returns whether an element is part of the active data.
  6555. * @param value defines the value to look for
  6556. * @returns true if found in the active data otherwise false
  6557. */
  6558. contains(value: T): boolean;
  6559. private static _GlobalId;
  6560. }
  6561. /**
  6562. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6563. * The data in this array can only be present once
  6564. */
  6565. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6566. private _duplicateId;
  6567. /**
  6568. * Pushes a value at the end of the active data.
  6569. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6570. * @param value defines the object to push in the array.
  6571. */
  6572. push(value: T): void;
  6573. /**
  6574. * Pushes a value at the end of the active data.
  6575. * If the data is already present, it won t be added again
  6576. * @param value defines the object to push in the array.
  6577. * @returns true if added false if it was already present
  6578. */
  6579. pushNoDuplicate(value: T): boolean;
  6580. /**
  6581. * Resets the active data to an empty array.
  6582. */
  6583. reset(): void;
  6584. /**
  6585. * Concats the active data with a given array.
  6586. * This ensures no dupplicate will be present in the result.
  6587. * @param array defines the data to concatenate with.
  6588. */
  6589. concatWithNoDuplicate(array: any): void;
  6590. }
  6591. }
  6592. declare module "babylonjs/Cameras/cameraInputsManager" {
  6593. import { Nullable } from "babylonjs/types";
  6594. import { Camera } from "babylonjs/Cameras/camera";
  6595. /**
  6596. * @ignore
  6597. * This is a list of all the different input types that are available in the application.
  6598. * Fo instance: ArcRotateCameraGamepadInput...
  6599. */
  6600. export var CameraInputTypes: {};
  6601. /**
  6602. * This is the contract to implement in order to create a new input class.
  6603. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6604. */
  6605. export interface ICameraInput<TCamera extends Camera> {
  6606. /**
  6607. * Defines the camera the input is attached to.
  6608. */
  6609. camera: Nullable<TCamera>;
  6610. /**
  6611. * Gets the class name of the current intput.
  6612. * @returns the class name
  6613. */
  6614. getClassName(): string;
  6615. /**
  6616. * Get the friendly name associated with the input class.
  6617. * @returns the input friendly name
  6618. */
  6619. getSimpleName(): string;
  6620. /**
  6621. * Attach the input controls to a specific dom element to get the input from.
  6622. * @param element Defines the element the controls should be listened from
  6623. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6624. */
  6625. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6626. /**
  6627. * Detach the current controls from the specified dom element.
  6628. * @param element Defines the element to stop listening the inputs from
  6629. */
  6630. detachControl(element: Nullable<HTMLElement>): void;
  6631. /**
  6632. * Update the current camera state depending on the inputs that have been used this frame.
  6633. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6634. */
  6635. checkInputs?: () => void;
  6636. }
  6637. /**
  6638. * Represents a map of input types to input instance or input index to input instance.
  6639. */
  6640. export interface CameraInputsMap<TCamera extends Camera> {
  6641. /**
  6642. * Accessor to the input by input type.
  6643. */
  6644. [name: string]: ICameraInput<TCamera>;
  6645. /**
  6646. * Accessor to the input by input index.
  6647. */
  6648. [idx: number]: ICameraInput<TCamera>;
  6649. }
  6650. /**
  6651. * This represents the input manager used within a camera.
  6652. * It helps dealing with all the different kind of input attached to a camera.
  6653. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6654. */
  6655. export class CameraInputsManager<TCamera extends Camera> {
  6656. /**
  6657. * Defines the list of inputs attahed to the camera.
  6658. */
  6659. attached: CameraInputsMap<TCamera>;
  6660. /**
  6661. * Defines the dom element the camera is collecting inputs from.
  6662. * This is null if the controls have not been attached.
  6663. */
  6664. attachedElement: Nullable<HTMLElement>;
  6665. /**
  6666. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6667. */
  6668. noPreventDefault: boolean;
  6669. /**
  6670. * Defined the camera the input manager belongs to.
  6671. */
  6672. camera: TCamera;
  6673. /**
  6674. * Update the current camera state depending on the inputs that have been used this frame.
  6675. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6676. */
  6677. checkInputs: () => void;
  6678. /**
  6679. * Instantiate a new Camera Input Manager.
  6680. * @param camera Defines the camera the input manager blongs to
  6681. */
  6682. constructor(camera: TCamera);
  6683. /**
  6684. * Add an input method to a camera
  6685. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6686. * @param input camera input method
  6687. */
  6688. add(input: ICameraInput<TCamera>): void;
  6689. /**
  6690. * Remove a specific input method from a camera
  6691. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6692. * @param inputToRemove camera input method
  6693. */
  6694. remove(inputToRemove: ICameraInput<TCamera>): void;
  6695. /**
  6696. * Remove a specific input type from a camera
  6697. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6698. * @param inputType the type of the input to remove
  6699. */
  6700. removeByType(inputType: string): void;
  6701. private _addCheckInputs;
  6702. /**
  6703. * Attach the input controls to the currently attached dom element to listen the events from.
  6704. * @param input Defines the input to attach
  6705. */
  6706. attachInput(input: ICameraInput<TCamera>): void;
  6707. /**
  6708. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6709. * @param element Defines the dom element to collect the events from
  6710. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6711. */
  6712. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6713. /**
  6714. * Detach the current manager inputs controls from a specific dom element.
  6715. * @param element Defines the dom element to collect the events from
  6716. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6717. */
  6718. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6719. /**
  6720. * Rebuild the dynamic inputCheck function from the current list of
  6721. * defined inputs in the manager.
  6722. */
  6723. rebuildInputCheck(): void;
  6724. /**
  6725. * Remove all attached input methods from a camera
  6726. */
  6727. clear(): void;
  6728. /**
  6729. * Serialize the current input manager attached to a camera.
  6730. * This ensures than once parsed,
  6731. * the input associated to the camera will be identical to the current ones
  6732. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6733. */
  6734. serialize(serializedCamera: any): void;
  6735. /**
  6736. * Parses an input manager serialized JSON to restore the previous list of inputs
  6737. * and states associated to a camera.
  6738. * @param parsedCamera Defines the JSON to parse
  6739. */
  6740. parse(parsedCamera: any): void;
  6741. }
  6742. }
  6743. declare module "babylonjs/Collisions/intersectionInfo" {
  6744. import { Nullable } from "babylonjs/types";
  6745. /**
  6746. * @hidden
  6747. */
  6748. export class IntersectionInfo {
  6749. bu: Nullable<number>;
  6750. bv: Nullable<number>;
  6751. distance: number;
  6752. faceId: number;
  6753. subMeshId: number;
  6754. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6755. }
  6756. }
  6757. declare module "babylonjs/Maths/math.plane" {
  6758. import { DeepImmutable } from "babylonjs/types";
  6759. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6760. /**
  6761. * Represens a plane by the equation ax + by + cz + d = 0
  6762. */
  6763. export class Plane {
  6764. private static _TmpMatrix;
  6765. /**
  6766. * Normal of the plane (a,b,c)
  6767. */
  6768. normal: Vector3;
  6769. /**
  6770. * d component of the plane
  6771. */
  6772. d: number;
  6773. /**
  6774. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6775. * @param a a component of the plane
  6776. * @param b b component of the plane
  6777. * @param c c component of the plane
  6778. * @param d d component of the plane
  6779. */
  6780. constructor(a: number, b: number, c: number, d: number);
  6781. /**
  6782. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6783. */
  6784. asArray(): number[];
  6785. /**
  6786. * @returns a new plane copied from the current Plane.
  6787. */
  6788. clone(): Plane;
  6789. /**
  6790. * @returns the string "Plane".
  6791. */
  6792. getClassName(): string;
  6793. /**
  6794. * @returns the Plane hash code.
  6795. */
  6796. getHashCode(): number;
  6797. /**
  6798. * Normalize the current Plane in place.
  6799. * @returns the updated Plane.
  6800. */
  6801. normalize(): Plane;
  6802. /**
  6803. * Applies a transformation the plane and returns the result
  6804. * @param transformation the transformation matrix to be applied to the plane
  6805. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6806. */
  6807. transform(transformation: DeepImmutable<Matrix>): Plane;
  6808. /**
  6809. * Calcualtte the dot product between the point and the plane normal
  6810. * @param point point to calculate the dot product with
  6811. * @returns the dot product (float) of the point coordinates and the plane normal.
  6812. */
  6813. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6814. /**
  6815. * Updates the current Plane from the plane defined by the three given points.
  6816. * @param point1 one of the points used to contruct the plane
  6817. * @param point2 one of the points used to contruct the plane
  6818. * @param point3 one of the points used to contruct the plane
  6819. * @returns the updated Plane.
  6820. */
  6821. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6822. /**
  6823. * Checks if the plane is facing a given direction
  6824. * @param direction the direction to check if the plane is facing
  6825. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6826. * @returns True is the vector "direction" is the same side than the plane normal.
  6827. */
  6828. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6829. /**
  6830. * Calculates the distance to a point
  6831. * @param point point to calculate distance to
  6832. * @returns the signed distance (float) from the given point to the Plane.
  6833. */
  6834. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6835. /**
  6836. * Creates a plane from an array
  6837. * @param array the array to create a plane from
  6838. * @returns a new Plane from the given array.
  6839. */
  6840. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6841. /**
  6842. * Creates a plane from three points
  6843. * @param point1 point used to create the plane
  6844. * @param point2 point used to create the plane
  6845. * @param point3 point used to create the plane
  6846. * @returns a new Plane defined by the three given points.
  6847. */
  6848. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6849. /**
  6850. * Creates a plane from an origin point and a normal
  6851. * @param origin origin of the plane to be constructed
  6852. * @param normal normal of the plane to be constructed
  6853. * @returns a new Plane the normal vector to this plane at the given origin point.
  6854. * Note : the vector "normal" is updated because normalized.
  6855. */
  6856. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6857. /**
  6858. * Calculates the distance from a plane and a point
  6859. * @param origin origin of the plane to be constructed
  6860. * @param normal normal of the plane to be constructed
  6861. * @param point point to calculate distance to
  6862. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6863. */
  6864. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6865. }
  6866. }
  6867. declare module "babylonjs/Culling/boundingSphere" {
  6868. import { DeepImmutable } from "babylonjs/types";
  6869. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6870. import { Plane } from "babylonjs/Maths/math.plane";
  6871. /**
  6872. * Class used to store bounding sphere information
  6873. */
  6874. export class BoundingSphere {
  6875. /**
  6876. * Gets the center of the bounding sphere in local space
  6877. */
  6878. readonly center: Vector3;
  6879. /**
  6880. * Radius of the bounding sphere in local space
  6881. */
  6882. radius: number;
  6883. /**
  6884. * Gets the center of the bounding sphere in world space
  6885. */
  6886. readonly centerWorld: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in world space
  6889. */
  6890. radiusWorld: number;
  6891. /**
  6892. * Gets the minimum vector in local space
  6893. */
  6894. readonly minimum: Vector3;
  6895. /**
  6896. * Gets the maximum vector in local space
  6897. */
  6898. readonly maximum: Vector3;
  6899. private _worldMatrix;
  6900. private static readonly TmpVector3;
  6901. /**
  6902. * Creates a new bounding sphere
  6903. * @param min defines the minimum vector (in local space)
  6904. * @param max defines the maximum vector (in local space)
  6905. * @param worldMatrix defines the new world matrix
  6906. */
  6907. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6908. /**
  6909. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6910. * @param min defines the new minimum vector (in local space)
  6911. * @param max defines the new maximum vector (in local space)
  6912. * @param worldMatrix defines the new world matrix
  6913. */
  6914. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6915. /**
  6916. * Scale the current bounding sphere by applying a scale factor
  6917. * @param factor defines the scale factor to apply
  6918. * @returns the current bounding box
  6919. */
  6920. scale(factor: number): BoundingSphere;
  6921. /**
  6922. * Gets the world matrix of the bounding box
  6923. * @returns a matrix
  6924. */
  6925. getWorldMatrix(): DeepImmutable<Matrix>;
  6926. /** @hidden */
  6927. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6928. /**
  6929. * Tests if the bounding sphere is intersecting the frustum planes
  6930. * @param frustumPlanes defines the frustum planes to test
  6931. * @returns true if there is an intersection
  6932. */
  6933. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6934. /**
  6935. * Tests if the bounding sphere center is in between the frustum planes.
  6936. * Used for optimistic fast inclusion.
  6937. * @param frustumPlanes defines the frustum planes to test
  6938. * @returns true if the sphere center is in between the frustum planes
  6939. */
  6940. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6941. /**
  6942. * Tests if a point is inside the bounding sphere
  6943. * @param point defines the point to test
  6944. * @returns true if the point is inside the bounding sphere
  6945. */
  6946. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6947. /**
  6948. * Checks if two sphere intersct
  6949. * @param sphere0 sphere 0
  6950. * @param sphere1 sphere 1
  6951. * @returns true if the speres intersect
  6952. */
  6953. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6954. }
  6955. }
  6956. declare module "babylonjs/Culling/boundingBox" {
  6957. import { DeepImmutable } from "babylonjs/types";
  6958. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6959. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6960. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6961. import { Plane } from "babylonjs/Maths/math.plane";
  6962. /**
  6963. * Class used to store bounding box information
  6964. */
  6965. export class BoundingBox implements ICullable {
  6966. /**
  6967. * Gets the 8 vectors representing the bounding box in local space
  6968. */
  6969. readonly vectors: Vector3[];
  6970. /**
  6971. * Gets the center of the bounding box in local space
  6972. */
  6973. readonly center: Vector3;
  6974. /**
  6975. * Gets the center of the bounding box in world space
  6976. */
  6977. readonly centerWorld: Vector3;
  6978. /**
  6979. * Gets the extend size in local space
  6980. */
  6981. readonly extendSize: Vector3;
  6982. /**
  6983. * Gets the extend size in world space
  6984. */
  6985. readonly extendSizeWorld: Vector3;
  6986. /**
  6987. * Gets the OBB (object bounding box) directions
  6988. */
  6989. readonly directions: Vector3[];
  6990. /**
  6991. * Gets the 8 vectors representing the bounding box in world space
  6992. */
  6993. readonly vectorsWorld: Vector3[];
  6994. /**
  6995. * Gets the minimum vector in world space
  6996. */
  6997. readonly minimumWorld: Vector3;
  6998. /**
  6999. * Gets the maximum vector in world space
  7000. */
  7001. readonly maximumWorld: Vector3;
  7002. /**
  7003. * Gets the minimum vector in local space
  7004. */
  7005. readonly minimum: Vector3;
  7006. /**
  7007. * Gets the maximum vector in local space
  7008. */
  7009. readonly maximum: Vector3;
  7010. private _worldMatrix;
  7011. private static readonly TmpVector3;
  7012. /**
  7013. * @hidden
  7014. */
  7015. _tag: number;
  7016. /**
  7017. * Creates a new bounding box
  7018. * @param min defines the minimum vector (in local space)
  7019. * @param max defines the maximum vector (in local space)
  7020. * @param worldMatrix defines the new world matrix
  7021. */
  7022. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7023. /**
  7024. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7025. * @param min defines the new minimum vector (in local space)
  7026. * @param max defines the new maximum vector (in local space)
  7027. * @param worldMatrix defines the new world matrix
  7028. */
  7029. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7030. /**
  7031. * Scale the current bounding box by applying a scale factor
  7032. * @param factor defines the scale factor to apply
  7033. * @returns the current bounding box
  7034. */
  7035. scale(factor: number): BoundingBox;
  7036. /**
  7037. * Gets the world matrix of the bounding box
  7038. * @returns a matrix
  7039. */
  7040. getWorldMatrix(): DeepImmutable<Matrix>;
  7041. /** @hidden */
  7042. _update(world: DeepImmutable<Matrix>): void;
  7043. /**
  7044. * Tests if the bounding box is intersecting the frustum planes
  7045. * @param frustumPlanes defines the frustum planes to test
  7046. * @returns true if there is an intersection
  7047. */
  7048. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7049. /**
  7050. * Tests if the bounding box is entirely inside the frustum planes
  7051. * @param frustumPlanes defines the frustum planes to test
  7052. * @returns true if there is an inclusion
  7053. */
  7054. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7055. /**
  7056. * Tests if a point is inside the bounding box
  7057. * @param point defines the point to test
  7058. * @returns true if the point is inside the bounding box
  7059. */
  7060. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7061. /**
  7062. * Tests if the bounding box intersects with a bounding sphere
  7063. * @param sphere defines the sphere to test
  7064. * @returns true if there is an intersection
  7065. */
  7066. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7067. /**
  7068. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7069. * @param min defines the min vector to use
  7070. * @param max defines the max vector to use
  7071. * @returns true if there is an intersection
  7072. */
  7073. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7074. /**
  7075. * Tests if two bounding boxes are intersections
  7076. * @param box0 defines the first box to test
  7077. * @param box1 defines the second box to test
  7078. * @returns true if there is an intersection
  7079. */
  7080. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7081. /**
  7082. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7083. * @param minPoint defines the minimum vector of the bounding box
  7084. * @param maxPoint defines the maximum vector of the bounding box
  7085. * @param sphereCenter defines the sphere center
  7086. * @param sphereRadius defines the sphere radius
  7087. * @returns true if there is an intersection
  7088. */
  7089. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7090. /**
  7091. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7092. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7093. * @param frustumPlanes defines the frustum planes to test
  7094. * @return true if there is an inclusion
  7095. */
  7096. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7097. /**
  7098. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7099. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7100. * @param frustumPlanes defines the frustum planes to test
  7101. * @return true if there is an intersection
  7102. */
  7103. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7104. }
  7105. }
  7106. declare module "babylonjs/Collisions/collider" {
  7107. import { Nullable, IndicesArray } from "babylonjs/types";
  7108. import { Vector3 } from "babylonjs/Maths/math.vector";
  7109. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7110. import { Plane } from "babylonjs/Maths/math.plane";
  7111. /** @hidden */
  7112. export class Collider {
  7113. /** Define if a collision was found */
  7114. collisionFound: boolean;
  7115. /**
  7116. * Define last intersection point in local space
  7117. */
  7118. intersectionPoint: Vector3;
  7119. /**
  7120. * Define last collided mesh
  7121. */
  7122. collidedMesh: Nullable<AbstractMesh>;
  7123. private _collisionPoint;
  7124. private _planeIntersectionPoint;
  7125. private _tempVector;
  7126. private _tempVector2;
  7127. private _tempVector3;
  7128. private _tempVector4;
  7129. private _edge;
  7130. private _baseToVertex;
  7131. private _destinationPoint;
  7132. private _slidePlaneNormal;
  7133. private _displacementVector;
  7134. /** @hidden */
  7135. _radius: Vector3;
  7136. /** @hidden */
  7137. _retry: number;
  7138. private _velocity;
  7139. private _basePoint;
  7140. private _epsilon;
  7141. /** @hidden */
  7142. _velocityWorldLength: number;
  7143. /** @hidden */
  7144. _basePointWorld: Vector3;
  7145. private _velocityWorld;
  7146. private _normalizedVelocity;
  7147. /** @hidden */
  7148. _initialVelocity: Vector3;
  7149. /** @hidden */
  7150. _initialPosition: Vector3;
  7151. private _nearestDistance;
  7152. private _collisionMask;
  7153. collisionMask: number;
  7154. /**
  7155. * Gets the plane normal used to compute the sliding response (in local space)
  7156. */
  7157. readonly slidePlaneNormal: Vector3;
  7158. /** @hidden */
  7159. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7160. /** @hidden */
  7161. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7162. /** @hidden */
  7163. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7164. /** @hidden */
  7165. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7166. /** @hidden */
  7167. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7168. /** @hidden */
  7169. _getResponse(pos: Vector3, vel: Vector3): void;
  7170. }
  7171. }
  7172. declare module "babylonjs/Culling/boundingInfo" {
  7173. import { DeepImmutable } from "babylonjs/types";
  7174. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7175. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7176. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7177. import { Plane } from "babylonjs/Maths/math.plane";
  7178. import { Collider } from "babylonjs/Collisions/collider";
  7179. /**
  7180. * Interface for cullable objects
  7181. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7182. */
  7183. export interface ICullable {
  7184. /**
  7185. * Checks if the object or part of the object is in the frustum
  7186. * @param frustumPlanes Camera near/planes
  7187. * @returns true if the object is in frustum otherwise false
  7188. */
  7189. isInFrustum(frustumPlanes: Plane[]): boolean;
  7190. /**
  7191. * Checks if a cullable object (mesh...) is in the camera frustum
  7192. * Unlike isInFrustum this cheks the full bounding box
  7193. * @param frustumPlanes Camera near/planes
  7194. * @returns true if the object is in frustum otherwise false
  7195. */
  7196. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7197. }
  7198. /**
  7199. * Info for a bounding data of a mesh
  7200. */
  7201. export class BoundingInfo implements ICullable {
  7202. /**
  7203. * Bounding box for the mesh
  7204. */
  7205. readonly boundingBox: BoundingBox;
  7206. /**
  7207. * Bounding sphere for the mesh
  7208. */
  7209. readonly boundingSphere: BoundingSphere;
  7210. private _isLocked;
  7211. private static readonly TmpVector3;
  7212. /**
  7213. * Constructs bounding info
  7214. * @param minimum min vector of the bounding box/sphere
  7215. * @param maximum max vector of the bounding box/sphere
  7216. * @param worldMatrix defines the new world matrix
  7217. */
  7218. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7219. /**
  7220. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7221. * @param min defines the new minimum vector (in local space)
  7222. * @param max defines the new maximum vector (in local space)
  7223. * @param worldMatrix defines the new world matrix
  7224. */
  7225. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7226. /**
  7227. * min vector of the bounding box/sphere
  7228. */
  7229. readonly minimum: Vector3;
  7230. /**
  7231. * max vector of the bounding box/sphere
  7232. */
  7233. readonly maximum: Vector3;
  7234. /**
  7235. * If the info is locked and won't be updated to avoid perf overhead
  7236. */
  7237. isLocked: boolean;
  7238. /**
  7239. * Updates the bounding sphere and box
  7240. * @param world world matrix to be used to update
  7241. */
  7242. update(world: DeepImmutable<Matrix>): void;
  7243. /**
  7244. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7245. * @param center New center of the bounding info
  7246. * @param extend New extend of the bounding info
  7247. * @returns the current bounding info
  7248. */
  7249. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7250. /**
  7251. * Scale the current bounding info by applying a scale factor
  7252. * @param factor defines the scale factor to apply
  7253. * @returns the current bounding info
  7254. */
  7255. scale(factor: number): BoundingInfo;
  7256. /**
  7257. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7258. * @param frustumPlanes defines the frustum to test
  7259. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7260. * @returns true if the bounding info is in the frustum planes
  7261. */
  7262. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7263. /**
  7264. * Gets the world distance between the min and max points of the bounding box
  7265. */
  7266. readonly diagonalLength: number;
  7267. /**
  7268. * Checks if a cullable object (mesh...) is in the camera frustum
  7269. * Unlike isInFrustum this cheks the full bounding box
  7270. * @param frustumPlanes Camera near/planes
  7271. * @returns true if the object is in frustum otherwise false
  7272. */
  7273. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7274. /** @hidden */
  7275. _checkCollision(collider: Collider): boolean;
  7276. /**
  7277. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7278. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7279. * @param point the point to check intersection with
  7280. * @returns if the point intersects
  7281. */
  7282. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7283. /**
  7284. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7285. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7286. * @param boundingInfo the bounding info to check intersection with
  7287. * @param precise if the intersection should be done using OBB
  7288. * @returns if the bounding info intersects
  7289. */
  7290. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7291. }
  7292. }
  7293. declare module "babylonjs/Maths/math.functions" {
  7294. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7295. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7296. /**
  7297. * Extracts minimum and maximum values from a list of indexed positions
  7298. * @param positions defines the positions to use
  7299. * @param indices defines the indices to the positions
  7300. * @param indexStart defines the start index
  7301. * @param indexCount defines the end index
  7302. * @param bias defines bias value to add to the result
  7303. * @return minimum and maximum values
  7304. */
  7305. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7306. minimum: Vector3;
  7307. maximum: Vector3;
  7308. };
  7309. /**
  7310. * Extracts minimum and maximum values from a list of positions
  7311. * @param positions defines the positions to use
  7312. * @param start defines the start index in the positions array
  7313. * @param count defines the number of positions to handle
  7314. * @param bias defines bias value to add to the result
  7315. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7316. * @return minimum and maximum values
  7317. */
  7318. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7319. minimum: Vector3;
  7320. maximum: Vector3;
  7321. };
  7322. }
  7323. declare module "babylonjs/Misc/iInspectable" {
  7324. /**
  7325. * Enum that determines the text-wrapping mode to use.
  7326. */
  7327. export enum InspectableType {
  7328. /**
  7329. * Checkbox for booleans
  7330. */
  7331. Checkbox = 0,
  7332. /**
  7333. * Sliders for numbers
  7334. */
  7335. Slider = 1,
  7336. /**
  7337. * Vector3
  7338. */
  7339. Vector3 = 2,
  7340. /**
  7341. * Quaternions
  7342. */
  7343. Quaternion = 3,
  7344. /**
  7345. * Color3
  7346. */
  7347. Color3 = 4,
  7348. /**
  7349. * String
  7350. */
  7351. String = 5
  7352. }
  7353. /**
  7354. * Interface used to define custom inspectable properties.
  7355. * This interface is used by the inspector to display custom property grids
  7356. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7357. */
  7358. export interface IInspectable {
  7359. /**
  7360. * Gets the label to display
  7361. */
  7362. label: string;
  7363. /**
  7364. * Gets the name of the property to edit
  7365. */
  7366. propertyName: string;
  7367. /**
  7368. * Gets the type of the editor to use
  7369. */
  7370. type: InspectableType;
  7371. /**
  7372. * Gets the minimum value of the property when using in "slider" mode
  7373. */
  7374. min?: number;
  7375. /**
  7376. * Gets the maximum value of the property when using in "slider" mode
  7377. */
  7378. max?: number;
  7379. /**
  7380. * Gets the setp to use when using in "slider" mode
  7381. */
  7382. step?: number;
  7383. }
  7384. }
  7385. declare module "babylonjs/Misc/timingTools" {
  7386. /**
  7387. * Class used to provide helper for timing
  7388. */
  7389. export class TimingTools {
  7390. /**
  7391. * Polyfill for setImmediate
  7392. * @param action defines the action to execute after the current execution block
  7393. */
  7394. static SetImmediate(action: () => void): void;
  7395. }
  7396. }
  7397. declare module "babylonjs/Misc/instantiationTools" {
  7398. /**
  7399. * Class used to enable instatition of objects by class name
  7400. */
  7401. export class InstantiationTools {
  7402. /**
  7403. * Use this object to register external classes like custom textures or material
  7404. * to allow the laoders to instantiate them
  7405. */
  7406. static RegisteredExternalClasses: {
  7407. [key: string]: Object;
  7408. };
  7409. /**
  7410. * Tries to instantiate a new object from a given class name
  7411. * @param className defines the class name to instantiate
  7412. * @returns the new object or null if the system was not able to do the instantiation
  7413. */
  7414. static Instantiate(className: string): any;
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  7418. import { Nullable } from "babylonjs/types";
  7419. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7420. /**
  7421. * This represents the required contract to create a new type of texture loader.
  7422. */
  7423. export interface IInternalTextureLoader {
  7424. /**
  7425. * Defines wether the loader supports cascade loading the different faces.
  7426. */
  7427. supportCascades: boolean;
  7428. /**
  7429. * This returns if the loader support the current file information.
  7430. * @param extension defines the file extension of the file being loaded
  7431. * @param textureFormatInUse defines the current compressed format in use iun the engine
  7432. * @param fallback defines the fallback internal texture if any
  7433. * @param isBase64 defines whether the texture is encoded as a base64
  7434. * @param isBuffer defines whether the texture data are stored as a buffer
  7435. * @returns true if the loader can load the specified file
  7436. */
  7437. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  7438. /**
  7439. * Transform the url before loading if required.
  7440. * @param rootUrl the url of the texture
  7441. * @param textureFormatInUse defines the current compressed format in use iun the engine
  7442. * @returns the transformed texture
  7443. */
  7444. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  7445. /**
  7446. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  7447. * @param rootUrl the url of the texture
  7448. * @param textureFormatInUse defines the current compressed format in use iun the engine
  7449. * @returns the fallback texture
  7450. */
  7451. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  7452. /**
  7453. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  7454. * @param data contains the texture data
  7455. * @param texture defines the BabylonJS internal texture
  7456. * @param createPolynomials will be true if polynomials have been requested
  7457. * @param onLoad defines the callback to trigger once the texture is ready
  7458. * @param onError defines the callback to trigger in case of error
  7459. */
  7460. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  7461. /**
  7462. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  7463. * @param data contains the texture data
  7464. * @param texture defines the BabylonJS internal texture
  7465. * @param callback defines the method to call once ready to upload
  7466. */
  7467. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  7468. }
  7469. }
  7470. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7471. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7472. import { Nullable } from "babylonjs/types";
  7473. import { Scene } from "babylonjs/scene";
  7474. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7475. module "babylonjs/Engines/engine" {
  7476. interface Engine {
  7477. /**
  7478. * Creates a depth stencil cube texture.
  7479. * This is only available in WebGL 2.
  7480. * @param size The size of face edge in the cube texture.
  7481. * @param options The options defining the cube texture.
  7482. * @returns The cube texture
  7483. */
  7484. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7485. /**
  7486. * Creates a cube texture
  7487. * @param rootUrl defines the url where the files to load is located
  7488. * @param scene defines the current scene
  7489. * @param files defines the list of files to load (1 per face)
  7490. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7491. * @param onLoad defines an optional callback raised when the texture is loaded
  7492. * @param onError defines an optional callback raised if there is an issue to load the texture
  7493. * @param format defines the format of the data
  7494. * @param forcedExtension defines the extension to use to pick the right loader
  7495. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7496. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7497. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7498. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7499. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7500. * @returns the cube texture as an InternalTexture
  7501. */
  7502. 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;
  7503. /**
  7504. * Creates a cube texture
  7505. * @param rootUrl defines the url where the files to load is located
  7506. * @param scene defines the current scene
  7507. * @param files defines the list of files to load (1 per face)
  7508. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7509. * @param onLoad defines an optional callback raised when the texture is loaded
  7510. * @param onError defines an optional callback raised if there is an issue to load the texture
  7511. * @param format defines the format of the data
  7512. * @param forcedExtension defines the extension to use to pick the right loader
  7513. * @returns the cube texture as an InternalTexture
  7514. */
  7515. 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;
  7516. /**
  7517. * Creates a cube texture
  7518. * @param rootUrl defines the url where the files to load is located
  7519. * @param scene defines the current scene
  7520. * @param files defines the list of files to load (1 per face)
  7521. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7522. * @param onLoad defines an optional callback raised when the texture is loaded
  7523. * @param onError defines an optional callback raised if there is an issue to load the texture
  7524. * @param format defines the format of the data
  7525. * @param forcedExtension defines the extension to use to pick the right loader
  7526. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7527. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7528. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7529. * @returns the cube texture as an InternalTexture
  7530. */
  7531. 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;
  7532. /** @hidden */
  7533. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7534. /** @hidden */
  7535. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7536. /** @hidden */
  7537. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7538. /** @hidden */
  7539. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7540. }
  7541. }
  7542. }
  7543. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7544. import { Nullable } from "babylonjs/types";
  7545. import { Scene } from "babylonjs/scene";
  7546. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7547. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7548. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7549. /**
  7550. * Class for creating a cube texture
  7551. */
  7552. export class CubeTexture extends BaseTexture {
  7553. private _delayedOnLoad;
  7554. /**
  7555. * The url of the texture
  7556. */
  7557. url: string;
  7558. /**
  7559. * Gets or sets the center of the bounding box associated with the cube texture.
  7560. * It must define where the camera used to render the texture was set
  7561. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7562. */
  7563. boundingBoxPosition: Vector3;
  7564. private _boundingBoxSize;
  7565. /**
  7566. * Gets or sets the size of the bounding box associated with the cube texture
  7567. * When defined, the cubemap will switch to local mode
  7568. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7569. * @example https://www.babylonjs-playground.com/#RNASML
  7570. */
  7571. /**
  7572. * Returns the bounding box size
  7573. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7574. */
  7575. boundingBoxSize: Vector3;
  7576. protected _rotationY: number;
  7577. /**
  7578. * Sets texture matrix rotation angle around Y axis in radians.
  7579. */
  7580. /**
  7581. * Gets texture matrix rotation angle around Y axis radians.
  7582. */
  7583. rotationY: number;
  7584. /**
  7585. * Are mip maps generated for this texture or not.
  7586. */
  7587. readonly noMipmap: boolean;
  7588. private _noMipmap;
  7589. private _files;
  7590. private _extensions;
  7591. private _textureMatrix;
  7592. private _format;
  7593. private _createPolynomials;
  7594. /** @hidden */
  7595. _prefiltered: boolean;
  7596. /**
  7597. * Creates a cube texture from an array of image urls
  7598. * @param files defines an array of image urls
  7599. * @param scene defines the hosting scene
  7600. * @param noMipmap specifies if mip maps are not used
  7601. * @returns a cube texture
  7602. */
  7603. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7604. /**
  7605. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7606. * @param url defines the url of the prefiltered texture
  7607. * @param scene defines the scene the texture is attached to
  7608. * @param forcedExtension defines the extension of the file if different from the url
  7609. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7610. * @return the prefiltered texture
  7611. */
  7612. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7613. /**
  7614. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7615. * as prefiltered data.
  7616. * @param rootUrl defines the url of the texture or the root name of the six images
  7617. * @param scene defines the scene the texture is attached to
  7618. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7619. * @param noMipmap defines if mipmaps should be created or not
  7620. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7621. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7622. * @param onError defines a callback triggered in case of error during load
  7623. * @param format defines the internal format to use for the texture once loaded
  7624. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7625. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7626. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7627. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7628. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7629. * @return the cube texture
  7630. */
  7631. 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);
  7632. /**
  7633. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7634. */
  7635. readonly isPrefiltered: boolean;
  7636. /**
  7637. * Get the current class name of the texture useful for serialization or dynamic coding.
  7638. * @returns "CubeTexture"
  7639. */
  7640. getClassName(): string;
  7641. /**
  7642. * Update the url (and optional buffer) of this texture if url was null during construction.
  7643. * @param url the url of the texture
  7644. * @param forcedExtension defines the extension to use
  7645. * @param onLoad callback called when the texture is loaded (defaults to null)
  7646. */
  7647. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7648. /**
  7649. * Delays loading of the cube texture
  7650. * @param forcedExtension defines the extension to use
  7651. */
  7652. delayLoad(forcedExtension?: string): void;
  7653. /**
  7654. * Returns the reflection texture matrix
  7655. * @returns the reflection texture matrix
  7656. */
  7657. getReflectionTextureMatrix(): Matrix;
  7658. /**
  7659. * Sets the reflection texture matrix
  7660. * @param value Reflection texture matrix
  7661. */
  7662. setReflectionTextureMatrix(value: Matrix): void;
  7663. /**
  7664. * Parses text to create a cube texture
  7665. * @param parsedTexture define the serialized text to read from
  7666. * @param scene defines the hosting scene
  7667. * @param rootUrl defines the root url of the cube texture
  7668. * @returns a cube texture
  7669. */
  7670. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7671. /**
  7672. * Makes a clone, or deep copy, of the cube texture
  7673. * @returns a new cube texture
  7674. */
  7675. clone(): CubeTexture;
  7676. }
  7677. }
  7678. declare module "babylonjs/Materials/materialDefines" {
  7679. /**
  7680. * Manages the defines for the Material
  7681. */
  7682. export class MaterialDefines {
  7683. /** @hidden */
  7684. protected _keys: string[];
  7685. private _isDirty;
  7686. /** @hidden */
  7687. _renderId: number;
  7688. /** @hidden */
  7689. _areLightsDirty: boolean;
  7690. /** @hidden */
  7691. _areAttributesDirty: boolean;
  7692. /** @hidden */
  7693. _areTexturesDirty: boolean;
  7694. /** @hidden */
  7695. _areFresnelDirty: boolean;
  7696. /** @hidden */
  7697. _areMiscDirty: boolean;
  7698. /** @hidden */
  7699. _areImageProcessingDirty: boolean;
  7700. /** @hidden */
  7701. _normals: boolean;
  7702. /** @hidden */
  7703. _uvs: boolean;
  7704. /** @hidden */
  7705. _needNormals: boolean;
  7706. /** @hidden */
  7707. _needUVs: boolean;
  7708. [id: string]: any;
  7709. /**
  7710. * Specifies if the material needs to be re-calculated
  7711. */
  7712. readonly isDirty: boolean;
  7713. /**
  7714. * Marks the material to indicate that it has been re-calculated
  7715. */
  7716. markAsProcessed(): void;
  7717. /**
  7718. * Marks the material to indicate that it needs to be re-calculated
  7719. */
  7720. markAsUnprocessed(): void;
  7721. /**
  7722. * Marks the material to indicate all of its defines need to be re-calculated
  7723. */
  7724. markAllAsDirty(): void;
  7725. /**
  7726. * Marks the material to indicate that image processing needs to be re-calculated
  7727. */
  7728. markAsImageProcessingDirty(): void;
  7729. /**
  7730. * Marks the material to indicate the lights need to be re-calculated
  7731. */
  7732. markAsLightDirty(): void;
  7733. /**
  7734. * Marks the attribute state as changed
  7735. */
  7736. markAsAttributesDirty(): void;
  7737. /**
  7738. * Marks the texture state as changed
  7739. */
  7740. markAsTexturesDirty(): void;
  7741. /**
  7742. * Marks the fresnel state as changed
  7743. */
  7744. markAsFresnelDirty(): void;
  7745. /**
  7746. * Marks the misc state as changed
  7747. */
  7748. markAsMiscDirty(): void;
  7749. /**
  7750. * Rebuilds the material defines
  7751. */
  7752. rebuild(): void;
  7753. /**
  7754. * Specifies if two material defines are equal
  7755. * @param other - A material define instance to compare to
  7756. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7757. */
  7758. isEqual(other: MaterialDefines): boolean;
  7759. /**
  7760. * Clones this instance's defines to another instance
  7761. * @param other - material defines to clone values to
  7762. */
  7763. cloneTo(other: MaterialDefines): void;
  7764. /**
  7765. * Resets the material define values
  7766. */
  7767. reset(): void;
  7768. /**
  7769. * Converts the material define values to a string
  7770. * @returns - String of material define information
  7771. */
  7772. toString(): string;
  7773. }
  7774. }
  7775. declare module "babylonjs/Materials/colorCurves" {
  7776. import { Effect } from "babylonjs/Materials/effect";
  7777. /**
  7778. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7779. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7780. * 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;
  7781. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7782. */
  7783. export class ColorCurves {
  7784. private _dirty;
  7785. private _tempColor;
  7786. private _globalCurve;
  7787. private _highlightsCurve;
  7788. private _midtonesCurve;
  7789. private _shadowsCurve;
  7790. private _positiveCurve;
  7791. private _negativeCurve;
  7792. private _globalHue;
  7793. private _globalDensity;
  7794. private _globalSaturation;
  7795. private _globalExposure;
  7796. /**
  7797. * Gets the global Hue value.
  7798. * 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).
  7799. */
  7800. /**
  7801. * Sets the global Hue value.
  7802. * 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).
  7803. */
  7804. globalHue: number;
  7805. /**
  7806. * Gets the global Density value.
  7807. * 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.
  7808. * Values less than zero provide a filter of opposite hue.
  7809. */
  7810. /**
  7811. * Sets the global Density value.
  7812. * 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.
  7813. * Values less than zero provide a filter of opposite hue.
  7814. */
  7815. globalDensity: number;
  7816. /**
  7817. * Gets the global Saturation value.
  7818. * 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.
  7819. */
  7820. /**
  7821. * Sets the global Saturation value.
  7822. * 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.
  7823. */
  7824. globalSaturation: number;
  7825. /**
  7826. * Gets the global Exposure value.
  7827. * 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.
  7828. */
  7829. /**
  7830. * Sets the global Exposure value.
  7831. * 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.
  7832. */
  7833. globalExposure: number;
  7834. private _highlightsHue;
  7835. private _highlightsDensity;
  7836. private _highlightsSaturation;
  7837. private _highlightsExposure;
  7838. /**
  7839. * Gets the highlights Hue value.
  7840. * 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).
  7841. */
  7842. /**
  7843. * Sets the highlights Hue value.
  7844. * 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).
  7845. */
  7846. highlightsHue: number;
  7847. /**
  7848. * Gets the highlights Density value.
  7849. * 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.
  7850. * Values less than zero provide a filter of opposite hue.
  7851. */
  7852. /**
  7853. * Sets the highlights Density value.
  7854. * 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.
  7855. * Values less than zero provide a filter of opposite hue.
  7856. */
  7857. highlightsDensity: number;
  7858. /**
  7859. * Gets the highlights Saturation value.
  7860. * 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.
  7861. */
  7862. /**
  7863. * Sets the highlights Saturation value.
  7864. * 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.
  7865. */
  7866. highlightsSaturation: number;
  7867. /**
  7868. * Gets the highlights Exposure value.
  7869. * 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.
  7870. */
  7871. /**
  7872. * Sets the highlights Exposure value.
  7873. * 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.
  7874. */
  7875. highlightsExposure: number;
  7876. private _midtonesHue;
  7877. private _midtonesDensity;
  7878. private _midtonesSaturation;
  7879. private _midtonesExposure;
  7880. /**
  7881. * Gets the midtones Hue value.
  7882. * 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).
  7883. */
  7884. /**
  7885. * Sets the midtones Hue value.
  7886. * 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).
  7887. */
  7888. midtonesHue: number;
  7889. /**
  7890. * Gets the midtones Density value.
  7891. * 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.
  7892. * Values less than zero provide a filter of opposite hue.
  7893. */
  7894. /**
  7895. * Sets the midtones Density value.
  7896. * 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.
  7897. * Values less than zero provide a filter of opposite hue.
  7898. */
  7899. midtonesDensity: number;
  7900. /**
  7901. * Gets the midtones Saturation value.
  7902. * 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.
  7903. */
  7904. /**
  7905. * Sets the midtones Saturation value.
  7906. * 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.
  7907. */
  7908. midtonesSaturation: number;
  7909. /**
  7910. * Gets the midtones Exposure value.
  7911. * 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.
  7912. */
  7913. /**
  7914. * Sets the midtones Exposure value.
  7915. * 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.
  7916. */
  7917. midtonesExposure: number;
  7918. private _shadowsHue;
  7919. private _shadowsDensity;
  7920. private _shadowsSaturation;
  7921. private _shadowsExposure;
  7922. /**
  7923. * Gets the shadows Hue value.
  7924. * 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).
  7925. */
  7926. /**
  7927. * Sets the shadows Hue value.
  7928. * 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).
  7929. */
  7930. shadowsHue: number;
  7931. /**
  7932. * Gets the shadows Density value.
  7933. * 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.
  7934. * Values less than zero provide a filter of opposite hue.
  7935. */
  7936. /**
  7937. * Sets the shadows Density value.
  7938. * 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.
  7939. * Values less than zero provide a filter of opposite hue.
  7940. */
  7941. shadowsDensity: number;
  7942. /**
  7943. * Gets the shadows Saturation value.
  7944. * 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.
  7945. */
  7946. /**
  7947. * Sets the shadows Saturation value.
  7948. * 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.
  7949. */
  7950. shadowsSaturation: number;
  7951. /**
  7952. * Gets the shadows Exposure value.
  7953. * 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.
  7954. */
  7955. /**
  7956. * Sets the shadows Exposure value.
  7957. * 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.
  7958. */
  7959. shadowsExposure: number;
  7960. /**
  7961. * Returns the class name
  7962. * @returns The class name
  7963. */
  7964. getClassName(): string;
  7965. /**
  7966. * Binds the color curves to the shader.
  7967. * @param colorCurves The color curve to bind
  7968. * @param effect The effect to bind to
  7969. * @param positiveUniform The positive uniform shader parameter
  7970. * @param neutralUniform The neutral uniform shader parameter
  7971. * @param negativeUniform The negative uniform shader parameter
  7972. */
  7973. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  7974. /**
  7975. * Prepare the list of uniforms associated with the ColorCurves effects.
  7976. * @param uniformsList The list of uniforms used in the effect
  7977. */
  7978. static PrepareUniforms(uniformsList: string[]): void;
  7979. /**
  7980. * Returns color grading data based on a hue, density, saturation and exposure value.
  7981. * @param filterHue The hue of the color filter.
  7982. * @param filterDensity The density of the color filter.
  7983. * @param saturation The saturation.
  7984. * @param exposure The exposure.
  7985. * @param result The result data container.
  7986. */
  7987. private getColorGradingDataToRef;
  7988. /**
  7989. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  7990. * @param value The input slider value in range [-100,100].
  7991. * @returns Adjusted value.
  7992. */
  7993. private static applyColorGradingSliderNonlinear;
  7994. /**
  7995. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  7996. * @param hue The hue (H) input.
  7997. * @param saturation The saturation (S) input.
  7998. * @param brightness The brightness (B) input.
  7999. * @result An RGBA color represented as Vector4.
  8000. */
  8001. private static fromHSBToRef;
  8002. /**
  8003. * Returns a value clamped between min and max
  8004. * @param value The value to clamp
  8005. * @param min The minimum of value
  8006. * @param max The maximum of value
  8007. * @returns The clamped value.
  8008. */
  8009. private static clamp;
  8010. /**
  8011. * Clones the current color curve instance.
  8012. * @return The cloned curves
  8013. */
  8014. clone(): ColorCurves;
  8015. /**
  8016. * Serializes the current color curve instance to a json representation.
  8017. * @return a JSON representation
  8018. */
  8019. serialize(): any;
  8020. /**
  8021. * Parses the color curve from a json representation.
  8022. * @param source the JSON source to parse
  8023. * @return The parsed curves
  8024. */
  8025. static Parse(source: any): ColorCurves;
  8026. }
  8027. }
  8028. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8029. import { Observable } from "babylonjs/Misc/observable";
  8030. import { Nullable } from "babylonjs/types";
  8031. import { Color4 } from "babylonjs/Maths/math.color";
  8032. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8033. import { Effect } from "babylonjs/Materials/effect";
  8034. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8035. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8036. /**
  8037. * Interface to follow in your material defines to integrate easily the
  8038. * Image proccessing functions.
  8039. * @hidden
  8040. */
  8041. export interface IImageProcessingConfigurationDefines {
  8042. IMAGEPROCESSING: boolean;
  8043. VIGNETTE: boolean;
  8044. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8045. VIGNETTEBLENDMODEOPAQUE: boolean;
  8046. TONEMAPPING: boolean;
  8047. TONEMAPPING_ACES: boolean;
  8048. CONTRAST: boolean;
  8049. EXPOSURE: boolean;
  8050. COLORCURVES: boolean;
  8051. COLORGRADING: boolean;
  8052. COLORGRADING3D: boolean;
  8053. SAMPLER3DGREENDEPTH: boolean;
  8054. SAMPLER3DBGRMAP: boolean;
  8055. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8056. }
  8057. /**
  8058. * @hidden
  8059. */
  8060. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8061. IMAGEPROCESSING: boolean;
  8062. VIGNETTE: boolean;
  8063. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8064. VIGNETTEBLENDMODEOPAQUE: boolean;
  8065. TONEMAPPING: boolean;
  8066. TONEMAPPING_ACES: boolean;
  8067. CONTRAST: boolean;
  8068. COLORCURVES: boolean;
  8069. COLORGRADING: boolean;
  8070. COLORGRADING3D: boolean;
  8071. SAMPLER3DGREENDEPTH: boolean;
  8072. SAMPLER3DBGRMAP: boolean;
  8073. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8074. EXPOSURE: boolean;
  8075. constructor();
  8076. }
  8077. /**
  8078. * This groups together the common properties used for image processing either in direct forward pass
  8079. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8080. * or not.
  8081. */
  8082. export class ImageProcessingConfiguration {
  8083. /**
  8084. * Default tone mapping applied in BabylonJS.
  8085. */
  8086. static readonly TONEMAPPING_STANDARD: number;
  8087. /**
  8088. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8089. * to other engines rendering to increase portability.
  8090. */
  8091. static readonly TONEMAPPING_ACES: number;
  8092. /**
  8093. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8094. */
  8095. colorCurves: Nullable<ColorCurves>;
  8096. private _colorCurvesEnabled;
  8097. /**
  8098. * Gets wether the color curves effect is enabled.
  8099. */
  8100. /**
  8101. * Sets wether the color curves effect is enabled.
  8102. */
  8103. colorCurvesEnabled: boolean;
  8104. private _colorGradingTexture;
  8105. /**
  8106. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8107. */
  8108. /**
  8109. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8110. */
  8111. colorGradingTexture: Nullable<BaseTexture>;
  8112. private _colorGradingEnabled;
  8113. /**
  8114. * Gets wether the color grading effect is enabled.
  8115. */
  8116. /**
  8117. * Sets wether the color grading effect is enabled.
  8118. */
  8119. colorGradingEnabled: boolean;
  8120. private _colorGradingWithGreenDepth;
  8121. /**
  8122. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8123. */
  8124. /**
  8125. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8126. */
  8127. colorGradingWithGreenDepth: boolean;
  8128. private _colorGradingBGR;
  8129. /**
  8130. * Gets wether the color grading texture contains BGR values.
  8131. */
  8132. /**
  8133. * Sets wether the color grading texture contains BGR values.
  8134. */
  8135. colorGradingBGR: boolean;
  8136. /** @hidden */
  8137. _exposure: number;
  8138. /**
  8139. * Gets the Exposure used in the effect.
  8140. */
  8141. /**
  8142. * Sets the Exposure used in the effect.
  8143. */
  8144. exposure: number;
  8145. private _toneMappingEnabled;
  8146. /**
  8147. * Gets wether the tone mapping effect is enabled.
  8148. */
  8149. /**
  8150. * Sets wether the tone mapping effect is enabled.
  8151. */
  8152. toneMappingEnabled: boolean;
  8153. private _toneMappingType;
  8154. /**
  8155. * Gets the type of tone mapping effect.
  8156. */
  8157. /**
  8158. * Sets the type of tone mapping effect used in BabylonJS.
  8159. */
  8160. toneMappingType: number;
  8161. protected _contrast: number;
  8162. /**
  8163. * Gets the contrast used in the effect.
  8164. */
  8165. /**
  8166. * Sets the contrast used in the effect.
  8167. */
  8168. contrast: number;
  8169. /**
  8170. * Vignette stretch size.
  8171. */
  8172. vignetteStretch: number;
  8173. /**
  8174. * Vignette centre X Offset.
  8175. */
  8176. vignetteCentreX: number;
  8177. /**
  8178. * Vignette centre Y Offset.
  8179. */
  8180. vignetteCentreY: number;
  8181. /**
  8182. * Vignette weight or intensity of the vignette effect.
  8183. */
  8184. vignetteWeight: number;
  8185. /**
  8186. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8187. * if vignetteEnabled is set to true.
  8188. */
  8189. vignetteColor: Color4;
  8190. /**
  8191. * Camera field of view used by the Vignette effect.
  8192. */
  8193. vignetteCameraFov: number;
  8194. private _vignetteBlendMode;
  8195. /**
  8196. * Gets the vignette blend mode allowing different kind of effect.
  8197. */
  8198. /**
  8199. * Sets the vignette blend mode allowing different kind of effect.
  8200. */
  8201. vignetteBlendMode: number;
  8202. private _vignetteEnabled;
  8203. /**
  8204. * Gets wether the vignette effect is enabled.
  8205. */
  8206. /**
  8207. * Sets wether the vignette effect is enabled.
  8208. */
  8209. vignetteEnabled: boolean;
  8210. private _applyByPostProcess;
  8211. /**
  8212. * Gets wether the image processing is applied through a post process or not.
  8213. */
  8214. /**
  8215. * Sets wether the image processing is applied through a post process or not.
  8216. */
  8217. applyByPostProcess: boolean;
  8218. private _isEnabled;
  8219. /**
  8220. * Gets wether the image processing is enabled or not.
  8221. */
  8222. /**
  8223. * Sets wether the image processing is enabled or not.
  8224. */
  8225. isEnabled: boolean;
  8226. /**
  8227. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8228. */
  8229. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8230. /**
  8231. * Method called each time the image processing information changes requires to recompile the effect.
  8232. */
  8233. protected _updateParameters(): void;
  8234. /**
  8235. * Gets the current class name.
  8236. * @return "ImageProcessingConfiguration"
  8237. */
  8238. getClassName(): string;
  8239. /**
  8240. * Prepare the list of uniforms associated with the Image Processing effects.
  8241. * @param uniforms The list of uniforms used in the effect
  8242. * @param defines the list of defines currently in use
  8243. */
  8244. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8245. /**
  8246. * Prepare the list of samplers associated with the Image Processing effects.
  8247. * @param samplersList The list of uniforms used in the effect
  8248. * @param defines the list of defines currently in use
  8249. */
  8250. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8251. /**
  8252. * Prepare the list of defines associated to the shader.
  8253. * @param defines the list of defines to complete
  8254. * @param forPostProcess Define if we are currently in post process mode or not
  8255. */
  8256. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8257. /**
  8258. * Returns true if all the image processing information are ready.
  8259. * @returns True if ready, otherwise, false
  8260. */
  8261. isReady(): boolean;
  8262. /**
  8263. * Binds the image processing to the shader.
  8264. * @param effect The effect to bind to
  8265. * @param aspectRatio Define the current aspect ratio of the effect
  8266. */
  8267. bind(effect: Effect, aspectRatio?: number): void;
  8268. /**
  8269. * Clones the current image processing instance.
  8270. * @return The cloned image processing
  8271. */
  8272. clone(): ImageProcessingConfiguration;
  8273. /**
  8274. * Serializes the current image processing instance to a json representation.
  8275. * @return a JSON representation
  8276. */
  8277. serialize(): any;
  8278. /**
  8279. * Parses the image processing from a json representation.
  8280. * @param source the JSON source to parse
  8281. * @return The parsed image processing
  8282. */
  8283. static Parse(source: any): ImageProcessingConfiguration;
  8284. private static _VIGNETTEMODE_MULTIPLY;
  8285. private static _VIGNETTEMODE_OPAQUE;
  8286. /**
  8287. * Used to apply the vignette as a mix with the pixel color.
  8288. */
  8289. static readonly VIGNETTEMODE_MULTIPLY: number;
  8290. /**
  8291. * Used to apply the vignette as a replacement of the pixel color.
  8292. */
  8293. static readonly VIGNETTEMODE_OPAQUE: number;
  8294. }
  8295. }
  8296. declare module "babylonjs/Shaders/postprocess.vertex" {
  8297. /** @hidden */
  8298. export var postprocessVertexShader: {
  8299. name: string;
  8300. shader: string;
  8301. };
  8302. }
  8303. declare module "babylonjs/Maths/math.axis" {
  8304. import { Vector3 } from "babylonjs/Maths/math.vector";
  8305. /** Defines supported spaces */
  8306. export enum Space {
  8307. /** Local (object) space */
  8308. LOCAL = 0,
  8309. /** World space */
  8310. WORLD = 1,
  8311. /** Bone space */
  8312. BONE = 2
  8313. }
  8314. /** Defines the 3 main axes */
  8315. export class Axis {
  8316. /** X axis */
  8317. static X: Vector3;
  8318. /** Y axis */
  8319. static Y: Vector3;
  8320. /** Z axis */
  8321. static Z: Vector3;
  8322. }
  8323. }
  8324. declare module "babylonjs/Cameras/targetCamera" {
  8325. import { Nullable } from "babylonjs/types";
  8326. import { Camera } from "babylonjs/Cameras/camera";
  8327. import { Scene } from "babylonjs/scene";
  8328. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8329. /**
  8330. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8331. * This is the base of the follow, arc rotate cameras and Free camera
  8332. * @see http://doc.babylonjs.com/features/cameras
  8333. */
  8334. export class TargetCamera extends Camera {
  8335. private static _RigCamTransformMatrix;
  8336. private static _TargetTransformMatrix;
  8337. private static _TargetFocalPoint;
  8338. /**
  8339. * Define the current direction the camera is moving to
  8340. */
  8341. cameraDirection: Vector3;
  8342. /**
  8343. * Define the current rotation the camera is rotating to
  8344. */
  8345. cameraRotation: Vector2;
  8346. /**
  8347. * When set, the up vector of the camera will be updated by the rotation of the camera
  8348. */
  8349. updateUpVectorFromRotation: boolean;
  8350. private _tmpQuaternion;
  8351. /**
  8352. * Define the current rotation of the camera
  8353. */
  8354. rotation: Vector3;
  8355. /**
  8356. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8357. */
  8358. rotationQuaternion: Quaternion;
  8359. /**
  8360. * Define the current speed of the camera
  8361. */
  8362. speed: number;
  8363. /**
  8364. * Add cconstraint to the camera to prevent it to move freely in all directions and
  8365. * around all axis.
  8366. */
  8367. noRotationConstraint: boolean;
  8368. /**
  8369. * Define the current target of the camera as an object or a position.
  8370. */
  8371. lockedTarget: any;
  8372. /** @hidden */
  8373. _currentTarget: Vector3;
  8374. /** @hidden */
  8375. _initialFocalDistance: number;
  8376. /** @hidden */
  8377. _viewMatrix: Matrix;
  8378. /** @hidden */
  8379. _camMatrix: Matrix;
  8380. /** @hidden */
  8381. _cameraTransformMatrix: Matrix;
  8382. /** @hidden */
  8383. _cameraRotationMatrix: Matrix;
  8384. /** @hidden */
  8385. _referencePoint: Vector3;
  8386. /** @hidden */
  8387. _transformedReferencePoint: Vector3;
  8388. protected _globalCurrentTarget: Vector3;
  8389. protected _globalCurrentUpVector: Vector3;
  8390. /** @hidden */
  8391. _reset: () => void;
  8392. private _defaultUp;
  8393. /**
  8394. * Instantiates a target camera that takes a meshor position as a target and continues to look at it while it moves.
  8395. * This is the base of the follow, arc rotate cameras and Free camera
  8396. * @see http://doc.babylonjs.com/features/cameras
  8397. * @param name Defines the name of the camera in the scene
  8398. * @param position Defines the start position of the camera in the scene
  8399. * @param scene Defines the scene the camera belongs to
  8400. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8401. */
  8402. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8403. /**
  8404. * Gets the position in front of the camera at a given distance.
  8405. * @param distance The distance from the camera we want the position to be
  8406. * @returns the position
  8407. */
  8408. getFrontPosition(distance: number): Vector3;
  8409. /** @hidden */
  8410. _getLockedTargetPosition(): Nullable<Vector3>;
  8411. private _storedPosition;
  8412. private _storedRotation;
  8413. private _storedRotationQuaternion;
  8414. /**
  8415. * Store current camera state of the camera (fov, position, rotation, etc..)
  8416. * @returns the camera
  8417. */
  8418. storeState(): Camera;
  8419. /**
  8420. * Restored camera state. You must call storeState() first
  8421. * @returns whether it was successful or not
  8422. * @hidden
  8423. */
  8424. _restoreStateValues(): boolean;
  8425. /** @hidden */
  8426. _initCache(): void;
  8427. /** @hidden */
  8428. _updateCache(ignoreParentClass?: boolean): void;
  8429. /** @hidden */
  8430. _isSynchronizedViewMatrix(): boolean;
  8431. /** @hidden */
  8432. _computeLocalCameraSpeed(): number;
  8433. /**
  8434. * Defines the target the camera should look at.
  8435. * @param target Defines the new target as a Vector or a mesh
  8436. */
  8437. setTarget(target: Vector3): void;
  8438. /**
  8439. * Return the current target position of the camera. This value is expressed in local space.
  8440. * @returns the target position
  8441. */
  8442. getTarget(): Vector3;
  8443. /** @hidden */
  8444. _decideIfNeedsToMove(): boolean;
  8445. /** @hidden */
  8446. _updatePosition(): void;
  8447. /** @hidden */
  8448. _checkInputs(): void;
  8449. protected _updateCameraRotationMatrix(): void;
  8450. /**
  8451. * 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)
  8452. * @returns the current camera
  8453. */
  8454. private _rotateUpVectorWithCameraRotationMatrix;
  8455. private _cachedRotationZ;
  8456. private _cachedQuaternionRotationZ;
  8457. /** @hidden */
  8458. _getViewMatrix(): Matrix;
  8459. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8460. /**
  8461. * @hidden
  8462. */
  8463. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8464. /**
  8465. * @hidden
  8466. */
  8467. _updateRigCameras(): void;
  8468. private _getRigCamPositionAndTarget;
  8469. /**
  8470. * Gets the current object class name.
  8471. * @return the class name
  8472. */
  8473. getClassName(): string;
  8474. }
  8475. }
  8476. declare module "babylonjs/Events/keyboardEvents" {
  8477. /**
  8478. * Gather the list of keyboard event types as constants.
  8479. */
  8480. export class KeyboardEventTypes {
  8481. /**
  8482. * The keydown event is fired when a key becomes active (pressed).
  8483. */
  8484. static readonly KEYDOWN: number;
  8485. /**
  8486. * The keyup event is fired when a key has been released.
  8487. */
  8488. static readonly KEYUP: number;
  8489. }
  8490. /**
  8491. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8492. */
  8493. export class KeyboardInfo {
  8494. /**
  8495. * Defines the type of event (KeyboardEventTypes)
  8496. */
  8497. type: number;
  8498. /**
  8499. * Defines the related dom event
  8500. */
  8501. event: KeyboardEvent;
  8502. /**
  8503. * Instantiates a new keyboard info.
  8504. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8505. * @param type Defines the type of event (KeyboardEventTypes)
  8506. * @param event Defines the related dom event
  8507. */
  8508. constructor(
  8509. /**
  8510. * Defines the type of event (KeyboardEventTypes)
  8511. */
  8512. type: number,
  8513. /**
  8514. * Defines the related dom event
  8515. */
  8516. event: KeyboardEvent);
  8517. }
  8518. /**
  8519. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8520. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8521. */
  8522. export class KeyboardInfoPre extends KeyboardInfo {
  8523. /**
  8524. * Defines the type of event (KeyboardEventTypes)
  8525. */
  8526. type: number;
  8527. /**
  8528. * Defines the related dom event
  8529. */
  8530. event: KeyboardEvent;
  8531. /**
  8532. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8533. */
  8534. skipOnPointerObservable: boolean;
  8535. /**
  8536. * Instantiates a new keyboard pre info.
  8537. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8538. * @param type Defines the type of event (KeyboardEventTypes)
  8539. * @param event Defines the related dom event
  8540. */
  8541. constructor(
  8542. /**
  8543. * Defines the type of event (KeyboardEventTypes)
  8544. */
  8545. type: number,
  8546. /**
  8547. * Defines the related dom event
  8548. */
  8549. event: KeyboardEvent);
  8550. }
  8551. }
  8552. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8553. import { Nullable } from "babylonjs/types";
  8554. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8555. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8556. /**
  8557. * Manage the keyboard inputs to control the movement of a free camera.
  8558. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8559. */
  8560. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8561. /**
  8562. * Defines the camera the input is attached to.
  8563. */
  8564. camera: FreeCamera;
  8565. /**
  8566. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8567. */
  8568. keysUp: number[];
  8569. /**
  8570. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8571. */
  8572. keysDown: number[];
  8573. /**
  8574. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8575. */
  8576. keysLeft: number[];
  8577. /**
  8578. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8579. */
  8580. keysRight: number[];
  8581. private _keys;
  8582. private _onCanvasBlurObserver;
  8583. private _onKeyboardObserver;
  8584. private _engine;
  8585. private _scene;
  8586. /**
  8587. * Attach the input controls to a specific dom element to get the input from.
  8588. * @param element Defines the element the controls should be listened from
  8589. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8590. */
  8591. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8592. /**
  8593. * Detach the current controls from the specified dom element.
  8594. * @param element Defines the element to stop listening the inputs from
  8595. */
  8596. detachControl(element: Nullable<HTMLElement>): void;
  8597. /**
  8598. * Update the current camera state depending on the inputs that have been used this frame.
  8599. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8600. */
  8601. checkInputs(): void;
  8602. /**
  8603. * Gets the class name of the current intput.
  8604. * @returns the class name
  8605. */
  8606. getClassName(): string;
  8607. /** @hidden */
  8608. _onLostFocus(): void;
  8609. /**
  8610. * Get the friendly name associated with the input class.
  8611. * @returns the input friendly name
  8612. */
  8613. getSimpleName(): string;
  8614. }
  8615. }
  8616. declare module "babylonjs/Lights/shadowLight" {
  8617. import { Camera } from "babylonjs/Cameras/camera";
  8618. import { Scene } from "babylonjs/scene";
  8619. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8620. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8621. import { Light } from "babylonjs/Lights/light";
  8622. /**
  8623. * Interface describing all the common properties and methods a shadow light needs to implement.
  8624. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8625. * as well as binding the different shadow properties to the effects.
  8626. */
  8627. export interface IShadowLight extends Light {
  8628. /**
  8629. * The light id in the scene (used in scene.findLighById for instance)
  8630. */
  8631. id: string;
  8632. /**
  8633. * The position the shdow will be casted from.
  8634. */
  8635. position: Vector3;
  8636. /**
  8637. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8638. */
  8639. direction: Vector3;
  8640. /**
  8641. * The transformed position. Position of the light in world space taking parenting in account.
  8642. */
  8643. transformedPosition: Vector3;
  8644. /**
  8645. * The transformed direction. Direction of the light in world space taking parenting in account.
  8646. */
  8647. transformedDirection: Vector3;
  8648. /**
  8649. * The friendly name of the light in the scene.
  8650. */
  8651. name: string;
  8652. /**
  8653. * Defines the shadow projection clipping minimum z value.
  8654. */
  8655. shadowMinZ: number;
  8656. /**
  8657. * Defines the shadow projection clipping maximum z value.
  8658. */
  8659. shadowMaxZ: number;
  8660. /**
  8661. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8662. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8663. */
  8664. computeTransformedInformation(): boolean;
  8665. /**
  8666. * Gets the scene the light belongs to.
  8667. * @returns The scene
  8668. */
  8669. getScene(): Scene;
  8670. /**
  8671. * Callback defining a custom Projection Matrix Builder.
  8672. * This can be used to override the default projection matrix computation.
  8673. */
  8674. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8675. /**
  8676. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8677. * @param matrix The materix to updated with the projection information
  8678. * @param viewMatrix The transform matrix of the light
  8679. * @param renderList The list of mesh to render in the map
  8680. * @returns The current light
  8681. */
  8682. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8683. /**
  8684. * Gets the current depth scale used in ESM.
  8685. * @returns The scale
  8686. */
  8687. getDepthScale(): number;
  8688. /**
  8689. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8690. * @returns true if a cube texture needs to be use
  8691. */
  8692. needCube(): boolean;
  8693. /**
  8694. * Detects if the projection matrix requires to be recomputed this frame.
  8695. * @returns true if it requires to be recomputed otherwise, false.
  8696. */
  8697. needProjectionMatrixCompute(): boolean;
  8698. /**
  8699. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8700. */
  8701. forceProjectionMatrixCompute(): void;
  8702. /**
  8703. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8704. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8705. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8706. */
  8707. getShadowDirection(faceIndex?: number): Vector3;
  8708. /**
  8709. * Gets the minZ used for shadow according to both the scene and the light.
  8710. * @param activeCamera The camera we are returning the min for
  8711. * @returns the depth min z
  8712. */
  8713. getDepthMinZ(activeCamera: Camera): number;
  8714. /**
  8715. * Gets the maxZ used for shadow according to both the scene and the light.
  8716. * @param activeCamera The camera we are returning the max for
  8717. * @returns the depth max z
  8718. */
  8719. getDepthMaxZ(activeCamera: Camera): number;
  8720. }
  8721. /**
  8722. * Base implementation IShadowLight
  8723. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8724. */
  8725. export abstract class ShadowLight extends Light implements IShadowLight {
  8726. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8727. protected _position: Vector3;
  8728. protected _setPosition(value: Vector3): void;
  8729. /**
  8730. * Sets the position the shadow will be casted from. Also use as the light position for both
  8731. * point and spot lights.
  8732. */
  8733. /**
  8734. * Sets the position the shadow will be casted from. Also use as the light position for both
  8735. * point and spot lights.
  8736. */
  8737. position: Vector3;
  8738. protected _direction: Vector3;
  8739. protected _setDirection(value: Vector3): void;
  8740. /**
  8741. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8742. * Also use as the light direction on spot and directional lights.
  8743. */
  8744. /**
  8745. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8746. * Also use as the light direction on spot and directional lights.
  8747. */
  8748. direction: Vector3;
  8749. private _shadowMinZ;
  8750. /**
  8751. * Gets the shadow projection clipping minimum z value.
  8752. */
  8753. /**
  8754. * Sets the shadow projection clipping minimum z value.
  8755. */
  8756. shadowMinZ: number;
  8757. private _shadowMaxZ;
  8758. /**
  8759. * Sets the shadow projection clipping maximum z value.
  8760. */
  8761. /**
  8762. * Gets the shadow projection clipping maximum z value.
  8763. */
  8764. shadowMaxZ: number;
  8765. /**
  8766. * Callback defining a custom Projection Matrix Builder.
  8767. * This can be used to override the default projection matrix computation.
  8768. */
  8769. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8770. /**
  8771. * The transformed position. Position of the light in world space taking parenting in account.
  8772. */
  8773. transformedPosition: Vector3;
  8774. /**
  8775. * The transformed direction. Direction of the light in world space taking parenting in account.
  8776. */
  8777. transformedDirection: Vector3;
  8778. private _needProjectionMatrixCompute;
  8779. /**
  8780. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8781. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8782. */
  8783. computeTransformedInformation(): boolean;
  8784. /**
  8785. * Return the depth scale used for the shadow map.
  8786. * @returns the depth scale.
  8787. */
  8788. getDepthScale(): number;
  8789. /**
  8790. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8791. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8792. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8793. */
  8794. getShadowDirection(faceIndex?: number): Vector3;
  8795. /**
  8796. * Returns the ShadowLight absolute position in the World.
  8797. * @returns the position vector in world space
  8798. */
  8799. getAbsolutePosition(): Vector3;
  8800. /**
  8801. * Sets the ShadowLight direction toward the passed target.
  8802. * @param target The point to target in local space
  8803. * @returns the updated ShadowLight direction
  8804. */
  8805. setDirectionToTarget(target: Vector3): Vector3;
  8806. /**
  8807. * Returns the light rotation in euler definition.
  8808. * @returns the x y z rotation in local space.
  8809. */
  8810. getRotation(): Vector3;
  8811. /**
  8812. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8813. * @returns true if a cube texture needs to be use
  8814. */
  8815. needCube(): boolean;
  8816. /**
  8817. * Detects if the projection matrix requires to be recomputed this frame.
  8818. * @returns true if it requires to be recomputed otherwise, false.
  8819. */
  8820. needProjectionMatrixCompute(): boolean;
  8821. /**
  8822. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8823. */
  8824. forceProjectionMatrixCompute(): void;
  8825. /** @hidden */
  8826. _initCache(): void;
  8827. /** @hidden */
  8828. _isSynchronized(): boolean;
  8829. /**
  8830. * Computes the world matrix of the node
  8831. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  8832. * @returns the world matrix
  8833. */
  8834. computeWorldMatrix(force?: boolean): Matrix;
  8835. /**
  8836. * Gets the minZ used for shadow according to both the scene and the light.
  8837. * @param activeCamera The camera we are returning the min for
  8838. * @returns the depth min z
  8839. */
  8840. getDepthMinZ(activeCamera: Camera): number;
  8841. /**
  8842. * Gets the maxZ used for shadow according to both the scene and the light.
  8843. * @param activeCamera The camera we are returning the max for
  8844. * @returns the depth max z
  8845. */
  8846. getDepthMaxZ(activeCamera: Camera): number;
  8847. /**
  8848. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8849. * @param matrix The materix to updated with the projection information
  8850. * @param viewMatrix The transform matrix of the light
  8851. * @param renderList The list of mesh to render in the map
  8852. * @returns The current light
  8853. */
  8854. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8855. }
  8856. }
  8857. declare module "babylonjs/Materials/materialHelper" {
  8858. import { Nullable } from "babylonjs/types";
  8859. import { Scene } from "babylonjs/scene";
  8860. import { Engine } from "babylonjs/Engines/engine";
  8861. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8862. import { Light } from "babylonjs/Lights/light";
  8863. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  8864. import { Effect, EffectFallbacks, EffectCreationOptions } from "babylonjs/Materials/effect";
  8865. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8866. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8867. /**
  8868. * "Static Class" containing the most commonly used helper while dealing with material for
  8869. * rendering purpose.
  8870. *
  8871. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  8872. *
  8873. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  8874. */
  8875. export class MaterialHelper {
  8876. /**
  8877. * Bind the current view position to an effect.
  8878. * @param effect The effect to be bound
  8879. * @param scene The scene the eyes position is used from
  8880. */
  8881. static BindEyePosition(effect: Effect, scene: Scene): void;
  8882. /**
  8883. * Helps preparing the defines values about the UVs in used in the effect.
  8884. * UVs are shared as much as we can accross channels in the shaders.
  8885. * @param texture The texture we are preparing the UVs for
  8886. * @param defines The defines to update
  8887. * @param key The channel key "diffuse", "specular"... used in the shader
  8888. */
  8889. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  8890. /**
  8891. * Binds a texture matrix value to its corrsponding uniform
  8892. * @param texture The texture to bind the matrix for
  8893. * @param uniformBuffer The uniform buffer receivin the data
  8894. * @param key The channel key "diffuse", "specular"... used in the shader
  8895. */
  8896. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  8897. /**
  8898. * Gets the current status of the fog (should it be enabled?)
  8899. * @param mesh defines the mesh to evaluate for fog support
  8900. * @param scene defines the hosting scene
  8901. * @returns true if fog must be enabled
  8902. */
  8903. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  8904. /**
  8905. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  8906. * @param mesh defines the current mesh
  8907. * @param scene defines the current scene
  8908. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  8909. * @param pointsCloud defines if point cloud rendering has to be turned on
  8910. * @param fogEnabled defines if fog has to be turned on
  8911. * @param alphaTest defines if alpha testing has to be turned on
  8912. * @param defines defines the current list of defines
  8913. */
  8914. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  8915. /**
  8916. * Helper used to prepare the list of defines associated with frame values for shader compilation
  8917. * @param scene defines the current scene
  8918. * @param engine defines the current engine
  8919. * @param defines specifies the list of active defines
  8920. * @param useInstances defines if instances have to be turned on
  8921. * @param useClipPlane defines if clip plane have to be turned on
  8922. */
  8923. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  8924. /**
  8925. * Prepares the defines for bones
  8926. * @param mesh The mesh containing the geometry data we will draw
  8927. * @param defines The defines to update
  8928. */
  8929. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  8930. /**
  8931. * Prepares the defines for morph targets
  8932. * @param mesh The mesh containing the geometry data we will draw
  8933. * @param defines The defines to update
  8934. */
  8935. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  8936. /**
  8937. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  8938. * @param mesh The mesh containing the geometry data we will draw
  8939. * @param defines The defines to update
  8940. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  8941. * @param useBones Precise whether bones should be used or not (override mesh info)
  8942. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  8943. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  8944. * @returns false if defines are considered not dirty and have not been checked
  8945. */
  8946. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  8947. /**
  8948. * Prepares the defines related to multiview
  8949. * @param scene The scene we are intending to draw
  8950. * @param defines The defines to update
  8951. */
  8952. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  8953. /**
  8954. * Prepares the defines related to the light information passed in parameter
  8955. * @param scene The scene we are intending to draw
  8956. * @param mesh The mesh the effect is compiling for
  8957. * @param light The light the effect is compiling for
  8958. * @param lightIndex The index of the light
  8959. * @param defines The defines to update
  8960. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  8961. * @param state Defines the current state regarding what is needed (normals, etc...)
  8962. */
  8963. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  8964. needNormals: boolean;
  8965. needRebuild: boolean;
  8966. shadowEnabled: boolean;
  8967. specularEnabled: boolean;
  8968. lightmapMode: boolean;
  8969. }): void;
  8970. /**
  8971. * Prepares the defines related to the light information passed in parameter
  8972. * @param scene The scene we are intending to draw
  8973. * @param mesh The mesh the effect is compiling for
  8974. * @param defines The defines to update
  8975. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  8976. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  8977. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  8978. * @returns true if normals will be required for the rest of the effect
  8979. */
  8980. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  8981. /**
  8982. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  8983. * @param lightIndex defines the light index
  8984. * @param uniformsList The uniform list
  8985. * @param samplersList The sampler list
  8986. * @param projectedLightTexture defines if projected texture must be used
  8987. * @param uniformBuffersList defines an optional list of uniform buffers
  8988. */
  8989. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  8990. /**
  8991. * Prepares the uniforms and samplers list to be used in the effect
  8992. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  8993. * @param samplersList The sampler list
  8994. * @param defines The defines helping in the list generation
  8995. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  8996. */
  8997. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | EffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  8998. /**
  8999. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9000. * @param defines The defines to update while falling back
  9001. * @param fallbacks The authorized effect fallbacks
  9002. * @param maxSimultaneousLights The maximum number of lights allowed
  9003. * @param rank the current rank of the Effect
  9004. * @returns The newly affected rank
  9005. */
  9006. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9007. private static _TmpMorphInfluencers;
  9008. /**
  9009. * Prepares the list of attributes required for morph targets according to the effect defines.
  9010. * @param attribs The current list of supported attribs
  9011. * @param mesh The mesh to prepare the morph targets attributes for
  9012. * @param influencers The number of influencers
  9013. */
  9014. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9015. /**
  9016. * Prepares the list of attributes required for morph targets according to the effect defines.
  9017. * @param attribs The current list of supported attribs
  9018. * @param mesh The mesh to prepare the morph targets attributes for
  9019. * @param defines The current Defines of the effect
  9020. */
  9021. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9022. /**
  9023. * Prepares the list of attributes required for bones according to the effect defines.
  9024. * @param attribs The current list of supported attribs
  9025. * @param mesh The mesh to prepare the bones attributes for
  9026. * @param defines The current Defines of the effect
  9027. * @param fallbacks The current efffect fallback strategy
  9028. */
  9029. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9030. /**
  9031. * Check and prepare the list of attributes required for instances according to the effect defines.
  9032. * @param attribs The current list of supported attribs
  9033. * @param defines The current MaterialDefines of the effect
  9034. */
  9035. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9036. /**
  9037. * Add the list of attributes required for instances to the attribs array.
  9038. * @param attribs The current list of supported attribs
  9039. */
  9040. static PushAttributesForInstances(attribs: string[]): void;
  9041. /**
  9042. * Binds the light shadow information to the effect for the given mesh.
  9043. * @param light The light containing the generator
  9044. * @param scene The scene the lights belongs to
  9045. * @param mesh The mesh we are binding the information to render
  9046. * @param lightIndex The light index in the effect used to render the mesh
  9047. * @param effect The effect we are binding the data to
  9048. */
  9049. static BindLightShadow(light: Light, mesh: AbstractMesh, lightIndex: string, effect: Effect): void;
  9050. /**
  9051. * Binds the light information to the effect.
  9052. * @param light The light containing the generator
  9053. * @param effect The effect we are binding the data to
  9054. * @param lightIndex The light index in the effect used to render
  9055. */
  9056. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9057. /**
  9058. * Binds the lights information from the scene to the effect for the given mesh.
  9059. * @param light Light to bind
  9060. * @param lightIndex Light index
  9061. * @param scene The scene where the light belongs to
  9062. * @param mesh The mesh we are binding the information to render
  9063. * @param effect The effect we are binding the data to
  9064. * @param useSpecular Defines if specular is supported
  9065. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9066. */
  9067. static BindLight(light: Light, lightIndex: number, scene: Scene, mesh: AbstractMesh, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean): void;
  9068. /**
  9069. * Binds the lights information from the scene to the effect for the given mesh.
  9070. * @param scene The scene the lights belongs to
  9071. * @param mesh The mesh we are binding the information to render
  9072. * @param effect The effect we are binding the data to
  9073. * @param defines The generated defines for the effect
  9074. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9075. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9076. */
  9077. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean): void;
  9078. private static _tempFogColor;
  9079. /**
  9080. * Binds the fog information from the scene to the effect for the given mesh.
  9081. * @param scene The scene the lights belongs to
  9082. * @param mesh The mesh we are binding the information to render
  9083. * @param effect The effect we are binding the data to
  9084. * @param linearSpace Defines if the fog effect is applied in linear space
  9085. */
  9086. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9087. /**
  9088. * Binds the bones information from the mesh to the effect.
  9089. * @param mesh The mesh we are binding the information to render
  9090. * @param effect The effect we are binding the data to
  9091. */
  9092. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9093. /**
  9094. * Binds the morph targets information from the mesh to the effect.
  9095. * @param abstractMesh The mesh we are binding the information to render
  9096. * @param effect The effect we are binding the data to
  9097. */
  9098. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9099. /**
  9100. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9101. * @param defines The generated defines used in the effect
  9102. * @param effect The effect we are binding the data to
  9103. * @param scene The scene we are willing to render with logarithmic scale for
  9104. */
  9105. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9106. /**
  9107. * Binds the clip plane information from the scene to the effect.
  9108. * @param scene The scene the clip plane information are extracted from
  9109. * @param effect The effect we are binding the data to
  9110. */
  9111. static BindClipPlane(effect: Effect, scene: Scene): void;
  9112. }
  9113. }
  9114. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9115. /** @hidden */
  9116. export var packingFunctions: {
  9117. name: string;
  9118. shader: string;
  9119. };
  9120. }
  9121. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9122. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9123. /** @hidden */
  9124. export var shadowMapPixelShader: {
  9125. name: string;
  9126. shader: string;
  9127. };
  9128. }
  9129. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9130. /** @hidden */
  9131. export var bonesDeclaration: {
  9132. name: string;
  9133. shader: string;
  9134. };
  9135. }
  9136. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9137. /** @hidden */
  9138. export var morphTargetsVertexGlobalDeclaration: {
  9139. name: string;
  9140. shader: string;
  9141. };
  9142. }
  9143. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9144. /** @hidden */
  9145. export var morphTargetsVertexDeclaration: {
  9146. name: string;
  9147. shader: string;
  9148. };
  9149. }
  9150. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9151. /** @hidden */
  9152. export var instancesDeclaration: {
  9153. name: string;
  9154. shader: string;
  9155. };
  9156. }
  9157. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9158. /** @hidden */
  9159. export var helperFunctions: {
  9160. name: string;
  9161. shader: string;
  9162. };
  9163. }
  9164. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9165. /** @hidden */
  9166. export var morphTargetsVertex: {
  9167. name: string;
  9168. shader: string;
  9169. };
  9170. }
  9171. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9172. /** @hidden */
  9173. export var instancesVertex: {
  9174. name: string;
  9175. shader: string;
  9176. };
  9177. }
  9178. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9179. /** @hidden */
  9180. export var bonesVertex: {
  9181. name: string;
  9182. shader: string;
  9183. };
  9184. }
  9185. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9186. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9187. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9188. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9189. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9190. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9191. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9192. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9193. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9194. /** @hidden */
  9195. export var shadowMapVertexShader: {
  9196. name: string;
  9197. shader: string;
  9198. };
  9199. }
  9200. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9201. /** @hidden */
  9202. export var depthBoxBlurPixelShader: {
  9203. name: string;
  9204. shader: string;
  9205. };
  9206. }
  9207. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9208. import { Nullable } from "babylonjs/types";
  9209. import { Scene } from "babylonjs/scene";
  9210. import { Matrix } from "babylonjs/Maths/math.vector";
  9211. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9213. import { Mesh } from "babylonjs/Meshes/mesh";
  9214. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9215. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9216. import { Effect } from "babylonjs/Materials/effect";
  9217. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9218. import "babylonjs/Shaders/shadowMap.fragment";
  9219. import "babylonjs/Shaders/shadowMap.vertex";
  9220. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9221. import { Observable } from "babylonjs/Misc/observable";
  9222. /**
  9223. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9224. */
  9225. export interface ICustomShaderOptions {
  9226. /**
  9227. * Gets or sets the custom shader name to use
  9228. */
  9229. shaderName: string;
  9230. /**
  9231. * The list of attribute names used in the shader
  9232. */
  9233. attributes?: string[];
  9234. /**
  9235. * The list of unifrom names used in the shader
  9236. */
  9237. uniforms?: string[];
  9238. /**
  9239. * The list of sampler names used in the shader
  9240. */
  9241. samplers?: string[];
  9242. /**
  9243. * The list of defines used in the shader
  9244. */
  9245. defines?: string[];
  9246. }
  9247. /**
  9248. * Interface to implement to create a shadow generator compatible with BJS.
  9249. */
  9250. export interface IShadowGenerator {
  9251. /**
  9252. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9253. * @returns The render target texture if present otherwise, null
  9254. */
  9255. getShadowMap(): Nullable<RenderTargetTexture>;
  9256. /**
  9257. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9258. * @returns The render target texture if the shadow map is present otherwise, null
  9259. */
  9260. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9261. /**
  9262. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9263. * @param subMesh The submesh we want to render in the shadow map
  9264. * @param useInstances Defines wether will draw in the map using instances
  9265. * @returns true if ready otherwise, false
  9266. */
  9267. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9268. /**
  9269. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9270. * @param defines Defines of the material we want to update
  9271. * @param lightIndex Index of the light in the enabled light list of the material
  9272. */
  9273. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9274. /**
  9275. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9276. * defined in the generator but impacting the effect).
  9277. * It implies the unifroms available on the materials are the standard BJS ones.
  9278. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9279. * @param effect The effect we are binfing the information for
  9280. */
  9281. bindShadowLight(lightIndex: string, effect: Effect): void;
  9282. /**
  9283. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9284. * (eq to shadow prjection matrix * light transform matrix)
  9285. * @returns The transform matrix used to create the shadow map
  9286. */
  9287. getTransformMatrix(): Matrix;
  9288. /**
  9289. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9290. * Cube and 2D textures for instance.
  9291. */
  9292. recreateShadowMap(): void;
  9293. /**
  9294. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9295. * @param onCompiled Callback triggered at the and of the effects compilation
  9296. * @param options Sets of optional options forcing the compilation with different modes
  9297. */
  9298. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9299. useInstances: boolean;
  9300. }>): void;
  9301. /**
  9302. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9303. * @param options Sets of optional options forcing the compilation with different modes
  9304. * @returns A promise that resolves when the compilation completes
  9305. */
  9306. forceCompilationAsync(options?: Partial<{
  9307. useInstances: boolean;
  9308. }>): Promise<void>;
  9309. /**
  9310. * Serializes the shadow generator setup to a json object.
  9311. * @returns The serialized JSON object
  9312. */
  9313. serialize(): any;
  9314. /**
  9315. * Disposes the Shadow map and related Textures and effects.
  9316. */
  9317. dispose(): void;
  9318. }
  9319. /**
  9320. * Default implementation IShadowGenerator.
  9321. * This is the main object responsible of generating shadows in the framework.
  9322. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9323. */
  9324. export class ShadowGenerator implements IShadowGenerator {
  9325. /**
  9326. * Shadow generator mode None: no filtering applied.
  9327. */
  9328. static readonly FILTER_NONE: number;
  9329. /**
  9330. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9331. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9332. */
  9333. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9334. /**
  9335. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9336. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9337. */
  9338. static readonly FILTER_POISSONSAMPLING: number;
  9339. /**
  9340. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9341. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9342. */
  9343. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9344. /**
  9345. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9346. * edge artifacts on steep falloff.
  9347. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9348. */
  9349. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9350. /**
  9351. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9352. * edge artifacts on steep falloff.
  9353. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9354. */
  9355. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9356. /**
  9357. * Shadow generator mode PCF: Percentage Closer Filtering
  9358. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9359. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9360. */
  9361. static readonly FILTER_PCF: number;
  9362. /**
  9363. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9364. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9365. * Contact Hardening
  9366. */
  9367. static readonly FILTER_PCSS: number;
  9368. /**
  9369. * Reserved for PCF and PCSS
  9370. * Highest Quality.
  9371. *
  9372. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9373. *
  9374. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9375. */
  9376. static readonly QUALITY_HIGH: number;
  9377. /**
  9378. * Reserved for PCF and PCSS
  9379. * Good tradeoff for quality/perf cross devices
  9380. *
  9381. * Execute PCF on a 3*3 kernel.
  9382. *
  9383. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9384. */
  9385. static readonly QUALITY_MEDIUM: number;
  9386. /**
  9387. * Reserved for PCF and PCSS
  9388. * The lowest quality but the fastest.
  9389. *
  9390. * Execute PCF on a 1*1 kernel.
  9391. *
  9392. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9393. */
  9394. static readonly QUALITY_LOW: number;
  9395. /** Gets or sets the custom shader name to use */
  9396. customShaderOptions: ICustomShaderOptions;
  9397. /**
  9398. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9399. */
  9400. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9401. /**
  9402. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9403. */
  9404. onAfterShadowMapRenderObservable: Observable<Effect>;
  9405. /**
  9406. * Observable triggered before a mesh is rendered in the shadow map.
  9407. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9408. */
  9409. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9410. /**
  9411. * Observable triggered after a mesh is rendered in the shadow map.
  9412. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9413. */
  9414. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9415. private _bias;
  9416. /**
  9417. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9418. */
  9419. /**
  9420. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9421. */
  9422. bias: number;
  9423. private _normalBias;
  9424. /**
  9425. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9426. */
  9427. /**
  9428. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9429. */
  9430. normalBias: number;
  9431. private _blurBoxOffset;
  9432. /**
  9433. * Gets the blur box offset: offset applied during the blur pass.
  9434. * Only useful if useKernelBlur = false
  9435. */
  9436. /**
  9437. * Sets the blur box offset: offset applied during the blur pass.
  9438. * Only useful if useKernelBlur = false
  9439. */
  9440. blurBoxOffset: number;
  9441. private _blurScale;
  9442. /**
  9443. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9444. * 2 means half of the size.
  9445. */
  9446. /**
  9447. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9448. * 2 means half of the size.
  9449. */
  9450. blurScale: number;
  9451. private _blurKernel;
  9452. /**
  9453. * Gets the blur kernel: kernel size of the blur pass.
  9454. * Only useful if useKernelBlur = true
  9455. */
  9456. /**
  9457. * Sets the blur kernel: kernel size of the blur pass.
  9458. * Only useful if useKernelBlur = true
  9459. */
  9460. blurKernel: number;
  9461. private _useKernelBlur;
  9462. /**
  9463. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9464. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9465. */
  9466. /**
  9467. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9468. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9469. */
  9470. useKernelBlur: boolean;
  9471. private _depthScale;
  9472. /**
  9473. * Gets the depth scale used in ESM mode.
  9474. */
  9475. /**
  9476. * Sets the depth scale used in ESM mode.
  9477. * This can override the scale stored on the light.
  9478. */
  9479. depthScale: number;
  9480. private _filter;
  9481. /**
  9482. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9483. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9484. */
  9485. /**
  9486. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9487. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9488. */
  9489. filter: number;
  9490. /**
  9491. * Gets if the current filter is set to Poisson Sampling.
  9492. */
  9493. /**
  9494. * Sets the current filter to Poisson Sampling.
  9495. */
  9496. usePoissonSampling: boolean;
  9497. /**
  9498. * Gets if the current filter is set to ESM.
  9499. */
  9500. /**
  9501. * Sets the current filter is to ESM.
  9502. */
  9503. useExponentialShadowMap: boolean;
  9504. /**
  9505. * Gets if the current filter is set to filtered ESM.
  9506. */
  9507. /**
  9508. * Gets if the current filter is set to filtered ESM.
  9509. */
  9510. useBlurExponentialShadowMap: boolean;
  9511. /**
  9512. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9513. * exponential to prevent steep falloff artifacts).
  9514. */
  9515. /**
  9516. * Sets the current filter to "close ESM" (using the inverse of the
  9517. * exponential to prevent steep falloff artifacts).
  9518. */
  9519. useCloseExponentialShadowMap: boolean;
  9520. /**
  9521. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9522. * exponential to prevent steep falloff artifacts).
  9523. */
  9524. /**
  9525. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9526. * exponential to prevent steep falloff artifacts).
  9527. */
  9528. useBlurCloseExponentialShadowMap: boolean;
  9529. /**
  9530. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9531. */
  9532. /**
  9533. * Sets the current filter to "PCF" (percentage closer filtering).
  9534. */
  9535. usePercentageCloserFiltering: boolean;
  9536. private _filteringQuality;
  9537. /**
  9538. * Gets the PCF or PCSS Quality.
  9539. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9540. */
  9541. /**
  9542. * Sets the PCF or PCSS Quality.
  9543. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9544. */
  9545. filteringQuality: number;
  9546. /**
  9547. * Gets if the current filter is set to "PCSS" (contact hardening).
  9548. */
  9549. /**
  9550. * Sets the current filter to "PCSS" (contact hardening).
  9551. */
  9552. useContactHardeningShadow: boolean;
  9553. private _contactHardeningLightSizeUVRatio;
  9554. /**
  9555. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9556. * Using a ratio helps keeping shape stability independently of the map size.
  9557. *
  9558. * It does not account for the light projection as it was having too much
  9559. * instability during the light setup or during light position changes.
  9560. *
  9561. * Only valid if useContactHardeningShadow is true.
  9562. */
  9563. /**
  9564. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9565. * Using a ratio helps keeping shape stability independently of the map size.
  9566. *
  9567. * It does not account for the light projection as it was having too much
  9568. * instability during the light setup or during light position changes.
  9569. *
  9570. * Only valid if useContactHardeningShadow is true.
  9571. */
  9572. contactHardeningLightSizeUVRatio: number;
  9573. private _darkness;
  9574. /** Gets or sets the actual darkness of a shadow */
  9575. darkness: number;
  9576. /**
  9577. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9578. * 0 means strongest and 1 would means no shadow.
  9579. * @returns the darkness.
  9580. */
  9581. getDarkness(): number;
  9582. /**
  9583. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9584. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9585. * @returns the shadow generator allowing fluent coding.
  9586. */
  9587. setDarkness(darkness: number): ShadowGenerator;
  9588. private _transparencyShadow;
  9589. /** Gets or sets the ability to have transparent shadow */
  9590. transparencyShadow: boolean;
  9591. /**
  9592. * Sets the ability to have transparent shadow (boolean).
  9593. * @param transparent True if transparent else False
  9594. * @returns the shadow generator allowing fluent coding
  9595. */
  9596. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9597. private _shadowMap;
  9598. private _shadowMap2;
  9599. /**
  9600. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9601. * @returns The render target texture if present otherwise, null
  9602. */
  9603. getShadowMap(): Nullable<RenderTargetTexture>;
  9604. /**
  9605. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9606. * @returns The render target texture if the shadow map is present otherwise, null
  9607. */
  9608. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9609. /**
  9610. * Gets the class name of that object
  9611. * @returns "ShadowGenerator"
  9612. */
  9613. getClassName(): string;
  9614. /**
  9615. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9616. * @param mesh Mesh to add
  9617. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9618. * @returns the Shadow Generator itself
  9619. */
  9620. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9621. /**
  9622. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9623. * @param mesh Mesh to remove
  9624. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9625. * @returns the Shadow Generator itself
  9626. */
  9627. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9628. /**
  9629. * Controls the extent to which the shadows fade out at the edge of the frustum
  9630. * Used only by directionals and spots
  9631. */
  9632. frustumEdgeFalloff: number;
  9633. private _light;
  9634. /**
  9635. * Returns the associated light object.
  9636. * @returns the light generating the shadow
  9637. */
  9638. getLight(): IShadowLight;
  9639. /**
  9640. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9641. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9642. * It might on the other hand introduce peter panning.
  9643. */
  9644. forceBackFacesOnly: boolean;
  9645. private _scene;
  9646. private _lightDirection;
  9647. private _effect;
  9648. private _viewMatrix;
  9649. private _projectionMatrix;
  9650. private _transformMatrix;
  9651. private _cachedPosition;
  9652. private _cachedDirection;
  9653. private _cachedDefines;
  9654. private _currentRenderID;
  9655. private _boxBlurPostprocess;
  9656. private _kernelBlurXPostprocess;
  9657. private _kernelBlurYPostprocess;
  9658. private _blurPostProcesses;
  9659. private _mapSize;
  9660. private _currentFaceIndex;
  9661. private _currentFaceIndexCache;
  9662. private _textureType;
  9663. private _defaultTextureMatrix;
  9664. /** @hidden */
  9665. static _SceneComponentInitialization: (scene: Scene) => void;
  9666. /**
  9667. * Creates a ShadowGenerator object.
  9668. * A ShadowGenerator is the required tool to use the shadows.
  9669. * Each light casting shadows needs to use its own ShadowGenerator.
  9670. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9671. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9672. * @param light The light object generating the shadows.
  9673. * @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.
  9674. */
  9675. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9676. private _initializeGenerator;
  9677. private _initializeShadowMap;
  9678. private _initializeBlurRTTAndPostProcesses;
  9679. private _renderForShadowMap;
  9680. private _renderSubMeshForShadowMap;
  9681. private _applyFilterValues;
  9682. /**
  9683. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9684. * @param onCompiled Callback triggered at the and of the effects compilation
  9685. * @param options Sets of optional options forcing the compilation with different modes
  9686. */
  9687. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9688. useInstances: boolean;
  9689. }>): void;
  9690. /**
  9691. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9692. * @param options Sets of optional options forcing the compilation with different modes
  9693. * @returns A promise that resolves when the compilation completes
  9694. */
  9695. forceCompilationAsync(options?: Partial<{
  9696. useInstances: boolean;
  9697. }>): Promise<void>;
  9698. /**
  9699. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9700. * @param subMesh The submesh we want to render in the shadow map
  9701. * @param useInstances Defines wether will draw in the map using instances
  9702. * @returns true if ready otherwise, false
  9703. */
  9704. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9705. /**
  9706. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9707. * @param defines Defines of the material we want to update
  9708. * @param lightIndex Index of the light in the enabled light list of the material
  9709. */
  9710. prepareDefines(defines: any, lightIndex: number): void;
  9711. /**
  9712. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9713. * defined in the generator but impacting the effect).
  9714. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9715. * @param effect The effect we are binfing the information for
  9716. */
  9717. bindShadowLight(lightIndex: string, effect: Effect): void;
  9718. /**
  9719. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9720. * (eq to shadow prjection matrix * light transform matrix)
  9721. * @returns The transform matrix used to create the shadow map
  9722. */
  9723. getTransformMatrix(): Matrix;
  9724. /**
  9725. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9726. * Cube and 2D textures for instance.
  9727. */
  9728. recreateShadowMap(): void;
  9729. private _disposeBlurPostProcesses;
  9730. private _disposeRTTandPostProcesses;
  9731. /**
  9732. * Disposes the ShadowGenerator.
  9733. * Returns nothing.
  9734. */
  9735. dispose(): void;
  9736. /**
  9737. * Serializes the shadow generator setup to a json object.
  9738. * @returns The serialized JSON object
  9739. */
  9740. serialize(): any;
  9741. /**
  9742. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9743. * @param parsedShadowGenerator The JSON object to parse
  9744. * @param scene The scene to create the shadow map for
  9745. * @returns The parsed shadow generator
  9746. */
  9747. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9748. }
  9749. }
  9750. declare module "babylonjs/Lights/light" {
  9751. import { Nullable } from "babylonjs/types";
  9752. import { Scene } from "babylonjs/scene";
  9753. import { Vector3 } from "babylonjs/Maths/math.vector";
  9754. import { Color3 } from "babylonjs/Maths/math.color";
  9755. import { Node } from "babylonjs/node";
  9756. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9757. import { Effect } from "babylonjs/Materials/effect";
  9758. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9759. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9760. /**
  9761. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9762. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9763. * 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.
  9764. */
  9765. export abstract class Light extends Node {
  9766. /**
  9767. * Falloff Default: light is falling off following the material specification:
  9768. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9769. */
  9770. static readonly FALLOFF_DEFAULT: number;
  9771. /**
  9772. * Falloff Physical: light is falling off following the inverse squared distance law.
  9773. */
  9774. static readonly FALLOFF_PHYSICAL: number;
  9775. /**
  9776. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  9777. * to enhance interoperability with other engines.
  9778. */
  9779. static readonly FALLOFF_GLTF: number;
  9780. /**
  9781. * Falloff Standard: light is falling off like in the standard material
  9782. * to enhance interoperability with other materials.
  9783. */
  9784. static readonly FALLOFF_STANDARD: number;
  9785. /**
  9786. * If every light affecting the material is in this lightmapMode,
  9787. * material.lightmapTexture adds or multiplies
  9788. * (depends on material.useLightmapAsShadowmap)
  9789. * after every other light calculations.
  9790. */
  9791. static readonly LIGHTMAP_DEFAULT: number;
  9792. /**
  9793. * material.lightmapTexture as only diffuse lighting from this light
  9794. * adds only specular lighting from this light
  9795. * adds dynamic shadows
  9796. */
  9797. static readonly LIGHTMAP_SPECULAR: number;
  9798. /**
  9799. * material.lightmapTexture as only lighting
  9800. * no light calculation from this light
  9801. * only adds dynamic shadows from this light
  9802. */
  9803. static readonly LIGHTMAP_SHADOWSONLY: number;
  9804. /**
  9805. * Each light type uses the default quantity according to its type:
  9806. * point/spot lights use luminous intensity
  9807. * directional lights use illuminance
  9808. */
  9809. static readonly INTENSITYMODE_AUTOMATIC: number;
  9810. /**
  9811. * lumen (lm)
  9812. */
  9813. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  9814. /**
  9815. * candela (lm/sr)
  9816. */
  9817. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  9818. /**
  9819. * lux (lm/m^2)
  9820. */
  9821. static readonly INTENSITYMODE_ILLUMINANCE: number;
  9822. /**
  9823. * nit (cd/m^2)
  9824. */
  9825. static readonly INTENSITYMODE_LUMINANCE: number;
  9826. /**
  9827. * Light type const id of the point light.
  9828. */
  9829. static readonly LIGHTTYPEID_POINTLIGHT: number;
  9830. /**
  9831. * Light type const id of the directional light.
  9832. */
  9833. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  9834. /**
  9835. * Light type const id of the spot light.
  9836. */
  9837. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  9838. /**
  9839. * Light type const id of the hemispheric light.
  9840. */
  9841. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  9842. /**
  9843. * Diffuse gives the basic color to an object.
  9844. */
  9845. diffuse: Color3;
  9846. /**
  9847. * Specular produces a highlight color on an object.
  9848. * Note: This is note affecting PBR materials.
  9849. */
  9850. specular: Color3;
  9851. /**
  9852. * Defines the falloff type for this light. This lets overrriding how punctual light are
  9853. * falling off base on range or angle.
  9854. * This can be set to any values in Light.FALLOFF_x.
  9855. *
  9856. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  9857. * other types of materials.
  9858. */
  9859. falloffType: number;
  9860. /**
  9861. * Strength of the light.
  9862. * Note: By default it is define in the framework own unit.
  9863. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  9864. */
  9865. intensity: number;
  9866. private _range;
  9867. protected _inverseSquaredRange: number;
  9868. /**
  9869. * Defines how far from the source the light is impacting in scene units.
  9870. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9871. */
  9872. /**
  9873. * Defines how far from the source the light is impacting in scene units.
  9874. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9875. */
  9876. range: number;
  9877. /**
  9878. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  9879. * of light.
  9880. */
  9881. private _photometricScale;
  9882. private _intensityMode;
  9883. /**
  9884. * Gets the photometric scale used to interpret the intensity.
  9885. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  9886. */
  9887. /**
  9888. * Sets the photometric scale used to interpret the intensity.
  9889. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  9890. */
  9891. intensityMode: number;
  9892. private _radius;
  9893. /**
  9894. * Gets the light radius used by PBR Materials to simulate soft area lights.
  9895. */
  9896. /**
  9897. * sets the light radius used by PBR Materials to simulate soft area lights.
  9898. */
  9899. radius: number;
  9900. private _renderPriority;
  9901. /**
  9902. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  9903. * exceeding the number allowed of the materials.
  9904. */
  9905. renderPriority: number;
  9906. private _shadowEnabled;
  9907. /**
  9908. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  9909. * the current shadow generator.
  9910. */
  9911. /**
  9912. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  9913. * the current shadow generator.
  9914. */
  9915. shadowEnabled: boolean;
  9916. private _includedOnlyMeshes;
  9917. /**
  9918. * Gets the only meshes impacted by this light.
  9919. */
  9920. /**
  9921. * Sets the only meshes impacted by this light.
  9922. */
  9923. includedOnlyMeshes: AbstractMesh[];
  9924. private _excludedMeshes;
  9925. /**
  9926. * Gets the meshes not impacted by this light.
  9927. */
  9928. /**
  9929. * Sets the meshes not impacted by this light.
  9930. */
  9931. excludedMeshes: AbstractMesh[];
  9932. private _excludeWithLayerMask;
  9933. /**
  9934. * Gets the layer id use to find what meshes are not impacted by the light.
  9935. * Inactive if 0
  9936. */
  9937. /**
  9938. * Sets the layer id use to find what meshes are not impacted by the light.
  9939. * Inactive if 0
  9940. */
  9941. excludeWithLayerMask: number;
  9942. private _includeOnlyWithLayerMask;
  9943. /**
  9944. * Gets the layer id use to find what meshes are impacted by the light.
  9945. * Inactive if 0
  9946. */
  9947. /**
  9948. * Sets the layer id use to find what meshes are impacted by the light.
  9949. * Inactive if 0
  9950. */
  9951. includeOnlyWithLayerMask: number;
  9952. private _lightmapMode;
  9953. /**
  9954. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  9955. */
  9956. /**
  9957. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  9958. */
  9959. lightmapMode: number;
  9960. /**
  9961. * Shadow generator associted to the light.
  9962. * @hidden Internal use only.
  9963. */
  9964. _shadowGenerator: Nullable<IShadowGenerator>;
  9965. /**
  9966. * @hidden Internal use only.
  9967. */
  9968. _excludedMeshesIds: string[];
  9969. /**
  9970. * @hidden Internal use only.
  9971. */
  9972. _includedOnlyMeshesIds: string[];
  9973. /**
  9974. * The current light unifom buffer.
  9975. * @hidden Internal use only.
  9976. */
  9977. _uniformBuffer: UniformBuffer;
  9978. /**
  9979. * Creates a Light object in the scene.
  9980. * Documentation : https://doc.babylonjs.com/babylon101/lights
  9981. * @param name The firendly name of the light
  9982. * @param scene The scene the light belongs too
  9983. */
  9984. constructor(name: string, scene: Scene);
  9985. protected abstract _buildUniformLayout(): void;
  9986. /**
  9987. * Sets the passed Effect "effect" with the Light information.
  9988. * @param effect The effect to update
  9989. * @param lightIndex The index of the light in the effect to update
  9990. * @returns The light
  9991. */
  9992. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  9993. /**
  9994. * Returns the string "Light".
  9995. * @returns the class name
  9996. */
  9997. getClassName(): string;
  9998. /** @hidden */
  9999. readonly _isLight: boolean;
  10000. /**
  10001. * Converts the light information to a readable string for debug purpose.
  10002. * @param fullDetails Supports for multiple levels of logging within scene loading
  10003. * @returns the human readable light info
  10004. */
  10005. toString(fullDetails?: boolean): string;
  10006. /** @hidden */
  10007. protected _syncParentEnabledState(): void;
  10008. /**
  10009. * Set the enabled state of this node.
  10010. * @param value - the new enabled state
  10011. */
  10012. setEnabled(value: boolean): void;
  10013. /**
  10014. * Returns the Light associated shadow generator if any.
  10015. * @return the associated shadow generator.
  10016. */
  10017. getShadowGenerator(): Nullable<IShadowGenerator>;
  10018. /**
  10019. * Returns a Vector3, the absolute light position in the World.
  10020. * @returns the world space position of the light
  10021. */
  10022. getAbsolutePosition(): Vector3;
  10023. /**
  10024. * Specifies if the light will affect the passed mesh.
  10025. * @param mesh The mesh to test against the light
  10026. * @return true the mesh is affected otherwise, false.
  10027. */
  10028. canAffectMesh(mesh: AbstractMesh): boolean;
  10029. /**
  10030. * Sort function to order lights for rendering.
  10031. * @param a First Light object to compare to second.
  10032. * @param b Second Light object to compare first.
  10033. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10034. */
  10035. static CompareLightsPriority(a: Light, b: Light): number;
  10036. /**
  10037. * Releases resources associated with this node.
  10038. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10039. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10040. */
  10041. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10042. /**
  10043. * Returns the light type ID (integer).
  10044. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10045. */
  10046. getTypeID(): number;
  10047. /**
  10048. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10049. * @returns the scaled intensity in intensity mode unit
  10050. */
  10051. getScaledIntensity(): number;
  10052. /**
  10053. * Returns a new Light object, named "name", from the current one.
  10054. * @param name The name of the cloned light
  10055. * @returns the new created light
  10056. */
  10057. clone(name: string): Nullable<Light>;
  10058. /**
  10059. * Serializes the current light into a Serialization object.
  10060. * @returns the serialized object.
  10061. */
  10062. serialize(): any;
  10063. /**
  10064. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10065. * This new light is named "name" and added to the passed scene.
  10066. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10067. * @param name The friendly name of the light
  10068. * @param scene The scene the new light will belong to
  10069. * @returns the constructor function
  10070. */
  10071. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10072. /**
  10073. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10074. * @param parsedLight The JSON representation of the light
  10075. * @param scene The scene to create the parsed light in
  10076. * @returns the created light after parsing
  10077. */
  10078. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10079. private _hookArrayForExcluded;
  10080. private _hookArrayForIncludedOnly;
  10081. private _resyncMeshes;
  10082. /**
  10083. * Forces the meshes to update their light related information in their rendering used effects
  10084. * @hidden Internal Use Only
  10085. */
  10086. _markMeshesAsLightDirty(): void;
  10087. /**
  10088. * Recomputes the cached photometric scale if needed.
  10089. */
  10090. private _computePhotometricScale;
  10091. /**
  10092. * Returns the Photometric Scale according to the light type and intensity mode.
  10093. */
  10094. private _getPhotometricScale;
  10095. /**
  10096. * Reorder the light in the scene according to their defined priority.
  10097. * @hidden Internal Use Only
  10098. */
  10099. _reorderLightsInScene(): void;
  10100. /**
  10101. * Prepares the list of defines specific to the light type.
  10102. * @param defines the list of defines
  10103. * @param lightIndex defines the index of the light for the effect
  10104. */
  10105. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10106. }
  10107. }
  10108. declare module "babylonjs/Actions/action" {
  10109. import { Observable } from "babylonjs/Misc/observable";
  10110. import { Condition } from "babylonjs/Actions/condition";
  10111. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10112. import { ActionManager } from "babylonjs/Actions/actionManager";
  10113. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10114. /**
  10115. * Interface used to define Action
  10116. */
  10117. export interface IAction {
  10118. /**
  10119. * Trigger for the action
  10120. */
  10121. trigger: number;
  10122. /** Options of the trigger */
  10123. triggerOptions: any;
  10124. /**
  10125. * Gets the trigger parameters
  10126. * @returns the trigger parameters
  10127. */
  10128. getTriggerParameter(): any;
  10129. /**
  10130. * Internal only - executes current action event
  10131. * @hidden
  10132. */
  10133. _executeCurrent(evt?: ActionEvent): void;
  10134. /**
  10135. * Serialize placeholder for child classes
  10136. * @param parent of child
  10137. * @returns the serialized object
  10138. */
  10139. serialize(parent: any): any;
  10140. /**
  10141. * Internal only
  10142. * @hidden
  10143. */
  10144. _prepare(): void;
  10145. /**
  10146. * Internal only - manager for action
  10147. * @hidden
  10148. */
  10149. _actionManager: AbstractActionManager;
  10150. /**
  10151. * Adds action to chain of actions, may be a DoNothingAction
  10152. * @param action defines the next action to execute
  10153. * @returns The action passed in
  10154. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10155. */
  10156. then(action: IAction): IAction;
  10157. }
  10158. /**
  10159. * The action to be carried out following a trigger
  10160. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10161. */
  10162. export class Action implements IAction {
  10163. /** the trigger, with or without parameters, for the action */
  10164. triggerOptions: any;
  10165. /**
  10166. * Trigger for the action
  10167. */
  10168. trigger: number;
  10169. /**
  10170. * Internal only - manager for action
  10171. * @hidden
  10172. */
  10173. _actionManager: ActionManager;
  10174. private _nextActiveAction;
  10175. private _child;
  10176. private _condition?;
  10177. private _triggerParameter;
  10178. /**
  10179. * An event triggered prior to action being executed.
  10180. */
  10181. onBeforeExecuteObservable: Observable<Action>;
  10182. /**
  10183. * Creates a new Action
  10184. * @param triggerOptions the trigger, with or without parameters, for the action
  10185. * @param condition an optional determinant of action
  10186. */
  10187. constructor(
  10188. /** the trigger, with or without parameters, for the action */
  10189. triggerOptions: any, condition?: Condition);
  10190. /**
  10191. * Internal only
  10192. * @hidden
  10193. */
  10194. _prepare(): void;
  10195. /**
  10196. * Gets the trigger parameters
  10197. * @returns the trigger parameters
  10198. */
  10199. getTriggerParameter(): any;
  10200. /**
  10201. * Internal only - executes current action event
  10202. * @hidden
  10203. */
  10204. _executeCurrent(evt?: ActionEvent): void;
  10205. /**
  10206. * Execute placeholder for child classes
  10207. * @param evt optional action event
  10208. */
  10209. execute(evt?: ActionEvent): void;
  10210. /**
  10211. * Skips to next active action
  10212. */
  10213. skipToNextActiveAction(): void;
  10214. /**
  10215. * Adds action to chain of actions, may be a DoNothingAction
  10216. * @param action defines the next action to execute
  10217. * @returns The action passed in
  10218. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10219. */
  10220. then(action: Action): Action;
  10221. /**
  10222. * Internal only
  10223. * @hidden
  10224. */
  10225. _getProperty(propertyPath: string): string;
  10226. /**
  10227. * Internal only
  10228. * @hidden
  10229. */
  10230. _getEffectiveTarget(target: any, propertyPath: string): any;
  10231. /**
  10232. * Serialize placeholder for child classes
  10233. * @param parent of child
  10234. * @returns the serialized object
  10235. */
  10236. serialize(parent: any): any;
  10237. /**
  10238. * Internal only called by serialize
  10239. * @hidden
  10240. */
  10241. protected _serialize(serializedAction: any, parent?: any): any;
  10242. /**
  10243. * Internal only
  10244. * @hidden
  10245. */
  10246. static _SerializeValueAsString: (value: any) => string;
  10247. /**
  10248. * Internal only
  10249. * @hidden
  10250. */
  10251. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10252. name: string;
  10253. targetType: string;
  10254. value: string;
  10255. };
  10256. }
  10257. }
  10258. declare module "babylonjs/Actions/condition" {
  10259. import { ActionManager } from "babylonjs/Actions/actionManager";
  10260. /**
  10261. * A Condition applied to an Action
  10262. */
  10263. export class Condition {
  10264. /**
  10265. * Internal only - manager for action
  10266. * @hidden
  10267. */
  10268. _actionManager: ActionManager;
  10269. /**
  10270. * Internal only
  10271. * @hidden
  10272. */
  10273. _evaluationId: number;
  10274. /**
  10275. * Internal only
  10276. * @hidden
  10277. */
  10278. _currentResult: boolean;
  10279. /**
  10280. * Creates a new Condition
  10281. * @param actionManager the manager of the action the condition is applied to
  10282. */
  10283. constructor(actionManager: ActionManager);
  10284. /**
  10285. * Check if the current condition is valid
  10286. * @returns a boolean
  10287. */
  10288. isValid(): boolean;
  10289. /**
  10290. * Internal only
  10291. * @hidden
  10292. */
  10293. _getProperty(propertyPath: string): string;
  10294. /**
  10295. * Internal only
  10296. * @hidden
  10297. */
  10298. _getEffectiveTarget(target: any, propertyPath: string): any;
  10299. /**
  10300. * Serialize placeholder for child classes
  10301. * @returns the serialized object
  10302. */
  10303. serialize(): any;
  10304. /**
  10305. * Internal only
  10306. * @hidden
  10307. */
  10308. protected _serialize(serializedCondition: any): any;
  10309. }
  10310. /**
  10311. * Defines specific conditional operators as extensions of Condition
  10312. */
  10313. export class ValueCondition extends Condition {
  10314. /** path to specify the property of the target the conditional operator uses */
  10315. propertyPath: string;
  10316. /** the value compared by the conditional operator against the current value of the property */
  10317. value: any;
  10318. /** the conditional operator, default ValueCondition.IsEqual */
  10319. operator: number;
  10320. /**
  10321. * Internal only
  10322. * @hidden
  10323. */
  10324. private static _IsEqual;
  10325. /**
  10326. * Internal only
  10327. * @hidden
  10328. */
  10329. private static _IsDifferent;
  10330. /**
  10331. * Internal only
  10332. * @hidden
  10333. */
  10334. private static _IsGreater;
  10335. /**
  10336. * Internal only
  10337. * @hidden
  10338. */
  10339. private static _IsLesser;
  10340. /**
  10341. * returns the number for IsEqual
  10342. */
  10343. static readonly IsEqual: number;
  10344. /**
  10345. * Returns the number for IsDifferent
  10346. */
  10347. static readonly IsDifferent: number;
  10348. /**
  10349. * Returns the number for IsGreater
  10350. */
  10351. static readonly IsGreater: number;
  10352. /**
  10353. * Returns the number for IsLesser
  10354. */
  10355. static readonly IsLesser: number;
  10356. /**
  10357. * Internal only The action manager for the condition
  10358. * @hidden
  10359. */
  10360. _actionManager: ActionManager;
  10361. /**
  10362. * Internal only
  10363. * @hidden
  10364. */
  10365. private _target;
  10366. /**
  10367. * Internal only
  10368. * @hidden
  10369. */
  10370. private _effectiveTarget;
  10371. /**
  10372. * Internal only
  10373. * @hidden
  10374. */
  10375. private _property;
  10376. /**
  10377. * Creates a new ValueCondition
  10378. * @param actionManager manager for the action the condition applies to
  10379. * @param target for the action
  10380. * @param propertyPath path to specify the property of the target the conditional operator uses
  10381. * @param value the value compared by the conditional operator against the current value of the property
  10382. * @param operator the conditional operator, default ValueCondition.IsEqual
  10383. */
  10384. constructor(actionManager: ActionManager, target: any,
  10385. /** path to specify the property of the target the conditional operator uses */
  10386. propertyPath: string,
  10387. /** the value compared by the conditional operator against the current value of the property */
  10388. value: any,
  10389. /** the conditional operator, default ValueCondition.IsEqual */
  10390. operator?: number);
  10391. /**
  10392. * Compares the given value with the property value for the specified conditional operator
  10393. * @returns the result of the comparison
  10394. */
  10395. isValid(): boolean;
  10396. /**
  10397. * Serialize the ValueCondition into a JSON compatible object
  10398. * @returns serialization object
  10399. */
  10400. serialize(): any;
  10401. /**
  10402. * Gets the name of the conditional operator for the ValueCondition
  10403. * @param operator the conditional operator
  10404. * @returns the name
  10405. */
  10406. static GetOperatorName(operator: number): string;
  10407. }
  10408. /**
  10409. * Defines a predicate condition as an extension of Condition
  10410. */
  10411. export class PredicateCondition extends Condition {
  10412. /** defines the predicate function used to validate the condition */
  10413. predicate: () => boolean;
  10414. /**
  10415. * Internal only - manager for action
  10416. * @hidden
  10417. */
  10418. _actionManager: ActionManager;
  10419. /**
  10420. * Creates a new PredicateCondition
  10421. * @param actionManager manager for the action the condition applies to
  10422. * @param predicate defines the predicate function used to validate the condition
  10423. */
  10424. constructor(actionManager: ActionManager,
  10425. /** defines the predicate function used to validate the condition */
  10426. predicate: () => boolean);
  10427. /**
  10428. * @returns the validity of the predicate condition
  10429. */
  10430. isValid(): boolean;
  10431. }
  10432. /**
  10433. * Defines a state condition as an extension of Condition
  10434. */
  10435. export class StateCondition extends Condition {
  10436. /** Value to compare with target state */
  10437. value: string;
  10438. /**
  10439. * Internal only - manager for action
  10440. * @hidden
  10441. */
  10442. _actionManager: ActionManager;
  10443. /**
  10444. * Internal only
  10445. * @hidden
  10446. */
  10447. private _target;
  10448. /**
  10449. * Creates a new StateCondition
  10450. * @param actionManager manager for the action the condition applies to
  10451. * @param target of the condition
  10452. * @param value to compare with target state
  10453. */
  10454. constructor(actionManager: ActionManager, target: any,
  10455. /** Value to compare with target state */
  10456. value: string);
  10457. /**
  10458. * Gets a boolean indicating if the current condition is met
  10459. * @returns the validity of the state
  10460. */
  10461. isValid(): boolean;
  10462. /**
  10463. * Serialize the StateCondition into a JSON compatible object
  10464. * @returns serialization object
  10465. */
  10466. serialize(): any;
  10467. }
  10468. }
  10469. declare module "babylonjs/Actions/directActions" {
  10470. import { Action } from "babylonjs/Actions/action";
  10471. import { Condition } from "babylonjs/Actions/condition";
  10472. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10473. /**
  10474. * This defines an action responsible to toggle a boolean once triggered.
  10475. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10476. */
  10477. export class SwitchBooleanAction extends Action {
  10478. /**
  10479. * The path to the boolean property in the target object
  10480. */
  10481. propertyPath: string;
  10482. private _target;
  10483. private _effectiveTarget;
  10484. private _property;
  10485. /**
  10486. * Instantiate the action
  10487. * @param triggerOptions defines the trigger options
  10488. * @param target defines the object containing the boolean
  10489. * @param propertyPath defines the path to the boolean property in the target object
  10490. * @param condition defines the trigger related conditions
  10491. */
  10492. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10493. /** @hidden */
  10494. _prepare(): void;
  10495. /**
  10496. * Execute the action toggle the boolean value.
  10497. */
  10498. execute(): void;
  10499. /**
  10500. * Serializes the actions and its related information.
  10501. * @param parent defines the object to serialize in
  10502. * @returns the serialized object
  10503. */
  10504. serialize(parent: any): any;
  10505. }
  10506. /**
  10507. * This defines an action responsible to set a the state field of the target
  10508. * to a desired value once triggered.
  10509. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10510. */
  10511. export class SetStateAction extends Action {
  10512. /**
  10513. * The value to store in the state field.
  10514. */
  10515. value: string;
  10516. private _target;
  10517. /**
  10518. * Instantiate the action
  10519. * @param triggerOptions defines the trigger options
  10520. * @param target defines the object containing the state property
  10521. * @param value defines the value to store in the state field
  10522. * @param condition defines the trigger related conditions
  10523. */
  10524. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10525. /**
  10526. * Execute the action and store the value on the target state property.
  10527. */
  10528. execute(): void;
  10529. /**
  10530. * Serializes the actions and its related information.
  10531. * @param parent defines the object to serialize in
  10532. * @returns the serialized object
  10533. */
  10534. serialize(parent: any): any;
  10535. }
  10536. /**
  10537. * This defines an action responsible to set a property of the target
  10538. * to a desired value once triggered.
  10539. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10540. */
  10541. export class SetValueAction extends Action {
  10542. /**
  10543. * The path of the property to set in the target.
  10544. */
  10545. propertyPath: string;
  10546. /**
  10547. * The value to set in the property
  10548. */
  10549. value: any;
  10550. private _target;
  10551. private _effectiveTarget;
  10552. private _property;
  10553. /**
  10554. * Instantiate the action
  10555. * @param triggerOptions defines the trigger options
  10556. * @param target defines the object containing the property
  10557. * @param propertyPath defines the path of the property to set in the target
  10558. * @param value defines the value to set in the property
  10559. * @param condition defines the trigger related conditions
  10560. */
  10561. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10562. /** @hidden */
  10563. _prepare(): void;
  10564. /**
  10565. * Execute the action and set the targetted property to the desired value.
  10566. */
  10567. execute(): void;
  10568. /**
  10569. * Serializes the actions and its related information.
  10570. * @param parent defines the object to serialize in
  10571. * @returns the serialized object
  10572. */
  10573. serialize(parent: any): any;
  10574. }
  10575. /**
  10576. * This defines an action responsible to increment the target value
  10577. * to a desired value once triggered.
  10578. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10579. */
  10580. export class IncrementValueAction extends Action {
  10581. /**
  10582. * The path of the property to increment in the target.
  10583. */
  10584. propertyPath: string;
  10585. /**
  10586. * The value we should increment the property by.
  10587. */
  10588. value: any;
  10589. private _target;
  10590. private _effectiveTarget;
  10591. private _property;
  10592. /**
  10593. * Instantiate the action
  10594. * @param triggerOptions defines the trigger options
  10595. * @param target defines the object containing the property
  10596. * @param propertyPath defines the path of the property to increment in the target
  10597. * @param value defines the value value we should increment the property by
  10598. * @param condition defines the trigger related conditions
  10599. */
  10600. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10601. /** @hidden */
  10602. _prepare(): void;
  10603. /**
  10604. * Execute the action and increment the target of the value amount.
  10605. */
  10606. execute(): void;
  10607. /**
  10608. * Serializes the actions and its related information.
  10609. * @param parent defines the object to serialize in
  10610. * @returns the serialized object
  10611. */
  10612. serialize(parent: any): any;
  10613. }
  10614. /**
  10615. * This defines an action responsible to start an animation once triggered.
  10616. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10617. */
  10618. export class PlayAnimationAction extends Action {
  10619. /**
  10620. * Where the animation should start (animation frame)
  10621. */
  10622. from: number;
  10623. /**
  10624. * Where the animation should stop (animation frame)
  10625. */
  10626. to: number;
  10627. /**
  10628. * Define if the animation should loop or stop after the first play.
  10629. */
  10630. loop?: boolean;
  10631. private _target;
  10632. /**
  10633. * Instantiate the action
  10634. * @param triggerOptions defines the trigger options
  10635. * @param target defines the target animation or animation name
  10636. * @param from defines from where the animation should start (animation frame)
  10637. * @param end defines where the animation should stop (animation frame)
  10638. * @param loop defines if the animation should loop or stop after the first play
  10639. * @param condition defines the trigger related conditions
  10640. */
  10641. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10642. /** @hidden */
  10643. _prepare(): void;
  10644. /**
  10645. * Execute the action and play the animation.
  10646. */
  10647. execute(): void;
  10648. /**
  10649. * Serializes the actions and its related information.
  10650. * @param parent defines the object to serialize in
  10651. * @returns the serialized object
  10652. */
  10653. serialize(parent: any): any;
  10654. }
  10655. /**
  10656. * This defines an action responsible to stop an animation once triggered.
  10657. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10658. */
  10659. export class StopAnimationAction extends Action {
  10660. private _target;
  10661. /**
  10662. * Instantiate the action
  10663. * @param triggerOptions defines the trigger options
  10664. * @param target defines the target animation or animation name
  10665. * @param condition defines the trigger related conditions
  10666. */
  10667. constructor(triggerOptions: any, target: any, condition?: Condition);
  10668. /** @hidden */
  10669. _prepare(): void;
  10670. /**
  10671. * Execute the action and stop the animation.
  10672. */
  10673. execute(): void;
  10674. /**
  10675. * Serializes the actions and its related information.
  10676. * @param parent defines the object to serialize in
  10677. * @returns the serialized object
  10678. */
  10679. serialize(parent: any): any;
  10680. }
  10681. /**
  10682. * This defines an action responsible that does nothing once triggered.
  10683. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10684. */
  10685. export class DoNothingAction extends Action {
  10686. /**
  10687. * Instantiate the action
  10688. * @param triggerOptions defines the trigger options
  10689. * @param condition defines the trigger related conditions
  10690. */
  10691. constructor(triggerOptions?: any, condition?: Condition);
  10692. /**
  10693. * Execute the action and do nothing.
  10694. */
  10695. execute(): void;
  10696. /**
  10697. * Serializes the actions and its related information.
  10698. * @param parent defines the object to serialize in
  10699. * @returns the serialized object
  10700. */
  10701. serialize(parent: any): any;
  10702. }
  10703. /**
  10704. * This defines an action responsible to trigger several actions once triggered.
  10705. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10706. */
  10707. export class CombineAction extends Action {
  10708. /**
  10709. * The list of aggregated animations to run.
  10710. */
  10711. children: Action[];
  10712. /**
  10713. * Instantiate the action
  10714. * @param triggerOptions defines the trigger options
  10715. * @param children defines the list of aggregated animations to run
  10716. * @param condition defines the trigger related conditions
  10717. */
  10718. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10719. /** @hidden */
  10720. _prepare(): void;
  10721. /**
  10722. * Execute the action and executes all the aggregated actions.
  10723. */
  10724. execute(evt: ActionEvent): void;
  10725. /**
  10726. * Serializes the actions and its related information.
  10727. * @param parent defines the object to serialize in
  10728. * @returns the serialized object
  10729. */
  10730. serialize(parent: any): any;
  10731. }
  10732. /**
  10733. * This defines an action responsible to run code (external event) once triggered.
  10734. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10735. */
  10736. export class ExecuteCodeAction extends Action {
  10737. /**
  10738. * The callback function to run.
  10739. */
  10740. func: (evt: ActionEvent) => void;
  10741. /**
  10742. * Instantiate the action
  10743. * @param triggerOptions defines the trigger options
  10744. * @param func defines the callback function to run
  10745. * @param condition defines the trigger related conditions
  10746. */
  10747. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10748. /**
  10749. * Execute the action and run the attached code.
  10750. */
  10751. execute(evt: ActionEvent): void;
  10752. }
  10753. /**
  10754. * This defines an action responsible to set the parent property of the target once triggered.
  10755. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10756. */
  10757. export class SetParentAction extends Action {
  10758. private _parent;
  10759. private _target;
  10760. /**
  10761. * Instantiate the action
  10762. * @param triggerOptions defines the trigger options
  10763. * @param target defines the target containing the parent property
  10764. * @param parent defines from where the animation should start (animation frame)
  10765. * @param condition defines the trigger related conditions
  10766. */
  10767. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10768. /** @hidden */
  10769. _prepare(): void;
  10770. /**
  10771. * Execute the action and set the parent property.
  10772. */
  10773. execute(): void;
  10774. /**
  10775. * Serializes the actions and its related information.
  10776. * @param parent defines the object to serialize in
  10777. * @returns the serialized object
  10778. */
  10779. serialize(parent: any): any;
  10780. }
  10781. }
  10782. declare module "babylonjs/Actions/actionManager" {
  10783. import { Nullable } from "babylonjs/types";
  10784. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10785. import { Scene } from "babylonjs/scene";
  10786. import { IAction } from "babylonjs/Actions/action";
  10787. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10788. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10789. /**
  10790. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10791. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10792. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10793. */
  10794. export class ActionManager extends AbstractActionManager {
  10795. /**
  10796. * Nothing
  10797. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10798. */
  10799. static readonly NothingTrigger: number;
  10800. /**
  10801. * On pick
  10802. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10803. */
  10804. static readonly OnPickTrigger: number;
  10805. /**
  10806. * On left pick
  10807. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10808. */
  10809. static readonly OnLeftPickTrigger: number;
  10810. /**
  10811. * On right pick
  10812. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10813. */
  10814. static readonly OnRightPickTrigger: number;
  10815. /**
  10816. * On center pick
  10817. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10818. */
  10819. static readonly OnCenterPickTrigger: number;
  10820. /**
  10821. * On pick down
  10822. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10823. */
  10824. static readonly OnPickDownTrigger: number;
  10825. /**
  10826. * On double pick
  10827. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10828. */
  10829. static readonly OnDoublePickTrigger: number;
  10830. /**
  10831. * On pick up
  10832. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10833. */
  10834. static readonly OnPickUpTrigger: number;
  10835. /**
  10836. * On pick out.
  10837. * This trigger will only be raised if you also declared a OnPickDown
  10838. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10839. */
  10840. static readonly OnPickOutTrigger: number;
  10841. /**
  10842. * On long press
  10843. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10844. */
  10845. static readonly OnLongPressTrigger: number;
  10846. /**
  10847. * On pointer over
  10848. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10849. */
  10850. static readonly OnPointerOverTrigger: number;
  10851. /**
  10852. * On pointer out
  10853. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10854. */
  10855. static readonly OnPointerOutTrigger: number;
  10856. /**
  10857. * On every frame
  10858. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10859. */
  10860. static readonly OnEveryFrameTrigger: number;
  10861. /**
  10862. * On intersection enter
  10863. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10864. */
  10865. static readonly OnIntersectionEnterTrigger: number;
  10866. /**
  10867. * On intersection exit
  10868. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10869. */
  10870. static readonly OnIntersectionExitTrigger: number;
  10871. /**
  10872. * On key down
  10873. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10874. */
  10875. static readonly OnKeyDownTrigger: number;
  10876. /**
  10877. * On key up
  10878. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10879. */
  10880. static readonly OnKeyUpTrigger: number;
  10881. private _scene;
  10882. /**
  10883. * Creates a new action manager
  10884. * @param scene defines the hosting scene
  10885. */
  10886. constructor(scene: Scene);
  10887. /**
  10888. * Releases all associated resources
  10889. */
  10890. dispose(): void;
  10891. /**
  10892. * Gets hosting scene
  10893. * @returns the hosting scene
  10894. */
  10895. getScene(): Scene;
  10896. /**
  10897. * Does this action manager handles actions of any of the given triggers
  10898. * @param triggers defines the triggers to be tested
  10899. * @return a boolean indicating whether one (or more) of the triggers is handled
  10900. */
  10901. hasSpecificTriggers(triggers: number[]): boolean;
  10902. /**
  10903. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10904. * speed.
  10905. * @param triggerA defines the trigger to be tested
  10906. * @param triggerB defines the trigger to be tested
  10907. * @return a boolean indicating whether one (or more) of the triggers is handled
  10908. */
  10909. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10910. /**
  10911. * Does this action manager handles actions of a given trigger
  10912. * @param trigger defines the trigger to be tested
  10913. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10914. * @return whether the trigger is handled
  10915. */
  10916. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10917. /**
  10918. * Does this action manager has pointer triggers
  10919. */
  10920. readonly hasPointerTriggers: boolean;
  10921. /**
  10922. * Does this action manager has pick triggers
  10923. */
  10924. readonly hasPickTriggers: boolean;
  10925. /**
  10926. * Registers an action to this action manager
  10927. * @param action defines the action to be registered
  10928. * @return the action amended (prepared) after registration
  10929. */
  10930. registerAction(action: IAction): Nullable<IAction>;
  10931. /**
  10932. * Unregisters an action to this action manager
  10933. * @param action defines the action to be unregistered
  10934. * @return a boolean indicating whether the action has been unregistered
  10935. */
  10936. unregisterAction(action: IAction): Boolean;
  10937. /**
  10938. * Process a specific trigger
  10939. * @param trigger defines the trigger to process
  10940. * @param evt defines the event details to be processed
  10941. */
  10942. processTrigger(trigger: number, evt?: IActionEvent): void;
  10943. /** @hidden */
  10944. _getEffectiveTarget(target: any, propertyPath: string): any;
  10945. /** @hidden */
  10946. _getProperty(propertyPath: string): string;
  10947. /**
  10948. * Serialize this manager to a JSON object
  10949. * @param name defines the property name to store this manager
  10950. * @returns a JSON representation of this manager
  10951. */
  10952. serialize(name: string): any;
  10953. /**
  10954. * Creates a new ActionManager from a JSON data
  10955. * @param parsedActions defines the JSON data to read from
  10956. * @param object defines the hosting mesh
  10957. * @param scene defines the hosting scene
  10958. */
  10959. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10960. /**
  10961. * Get a trigger name by index
  10962. * @param trigger defines the trigger index
  10963. * @returns a trigger name
  10964. */
  10965. static GetTriggerName(trigger: number): string;
  10966. }
  10967. }
  10968. declare module "babylonjs/Culling/ray" {
  10969. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10970. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10971. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10972. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10973. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10974. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10975. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10976. import { Plane } from "babylonjs/Maths/math.plane";
  10977. /**
  10978. * Class representing a ray with position and direction
  10979. */
  10980. export class Ray {
  10981. /** origin point */
  10982. origin: Vector3;
  10983. /** direction */
  10984. direction: Vector3;
  10985. /** length of the ray */
  10986. length: number;
  10987. private static readonly TmpVector3;
  10988. private _tmpRay;
  10989. /**
  10990. * Creates a new ray
  10991. * @param origin origin point
  10992. * @param direction direction
  10993. * @param length length of the ray
  10994. */
  10995. constructor(
  10996. /** origin point */
  10997. origin: Vector3,
  10998. /** direction */
  10999. direction: Vector3,
  11000. /** length of the ray */
  11001. length?: number);
  11002. /**
  11003. * Checks if the ray intersects a box
  11004. * @param minimum bound of the box
  11005. * @param maximum bound of the box
  11006. * @param intersectionTreshold extra extend to be added to the box in all direction
  11007. * @returns if the box was hit
  11008. */
  11009. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11010. /**
  11011. * Checks if the ray intersects a box
  11012. * @param box the bounding box to check
  11013. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11014. * @returns if the box was hit
  11015. */
  11016. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11017. /**
  11018. * If the ray hits a sphere
  11019. * @param sphere the bounding sphere to check
  11020. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11021. * @returns true if it hits the sphere
  11022. */
  11023. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11024. /**
  11025. * If the ray hits a triange
  11026. * @param vertex0 triangle vertex
  11027. * @param vertex1 triangle vertex
  11028. * @param vertex2 triangle vertex
  11029. * @returns intersection information if hit
  11030. */
  11031. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11032. /**
  11033. * Checks if ray intersects a plane
  11034. * @param plane the plane to check
  11035. * @returns the distance away it was hit
  11036. */
  11037. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11038. /**
  11039. * Calculate the intercept of a ray on a given axis
  11040. * @param axis to check 'x' | 'y' | 'z'
  11041. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11042. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11043. */
  11044. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11045. /**
  11046. * Checks if ray intersects a mesh
  11047. * @param mesh the mesh to check
  11048. * @param fastCheck if only the bounding box should checked
  11049. * @returns picking info of the intersecton
  11050. */
  11051. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11052. /**
  11053. * Checks if ray intersects a mesh
  11054. * @param meshes the meshes to check
  11055. * @param fastCheck if only the bounding box should checked
  11056. * @param results array to store result in
  11057. * @returns Array of picking infos
  11058. */
  11059. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11060. private _comparePickingInfo;
  11061. private static smallnum;
  11062. private static rayl;
  11063. /**
  11064. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11065. * @param sega the first point of the segment to test the intersection against
  11066. * @param segb the second point of the segment to test the intersection against
  11067. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11068. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11069. */
  11070. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11071. /**
  11072. * Update the ray from viewport position
  11073. * @param x position
  11074. * @param y y position
  11075. * @param viewportWidth viewport width
  11076. * @param viewportHeight viewport height
  11077. * @param world world matrix
  11078. * @param view view matrix
  11079. * @param projection projection matrix
  11080. * @returns this ray updated
  11081. */
  11082. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11083. /**
  11084. * Creates a ray with origin and direction of 0,0,0
  11085. * @returns the new ray
  11086. */
  11087. static Zero(): Ray;
  11088. /**
  11089. * Creates a new ray from screen space and viewport
  11090. * @param x position
  11091. * @param y y position
  11092. * @param viewportWidth viewport width
  11093. * @param viewportHeight viewport height
  11094. * @param world world matrix
  11095. * @param view view matrix
  11096. * @param projection projection matrix
  11097. * @returns new ray
  11098. */
  11099. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11100. /**
  11101. * 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
  11102. * transformed to the given world matrix.
  11103. * @param origin The origin point
  11104. * @param end The end point
  11105. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11106. * @returns the new ray
  11107. */
  11108. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11109. /**
  11110. * Transforms a ray by a matrix
  11111. * @param ray ray to transform
  11112. * @param matrix matrix to apply
  11113. * @returns the resulting new ray
  11114. */
  11115. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11116. /**
  11117. * Transforms a ray by a matrix
  11118. * @param ray ray to transform
  11119. * @param matrix matrix to apply
  11120. * @param result ray to store result in
  11121. */
  11122. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11123. /**
  11124. * Unproject a ray from screen space to object space
  11125. * @param sourceX defines the screen space x coordinate to use
  11126. * @param sourceY defines the screen space y coordinate to use
  11127. * @param viewportWidth defines the current width of the viewport
  11128. * @param viewportHeight defines the current height of the viewport
  11129. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11130. * @param view defines the view matrix to use
  11131. * @param projection defines the projection matrix to use
  11132. */
  11133. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11134. }
  11135. /**
  11136. * Type used to define predicate used to select faces when a mesh intersection is detected
  11137. */
  11138. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11139. module "babylonjs/scene" {
  11140. interface Scene {
  11141. /** @hidden */
  11142. _tempPickingRay: Nullable<Ray>;
  11143. /** @hidden */
  11144. _cachedRayForTransform: Ray;
  11145. /** @hidden */
  11146. _pickWithRayInverseMatrix: Matrix;
  11147. /** @hidden */
  11148. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11149. /** @hidden */
  11150. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11151. }
  11152. }
  11153. }
  11154. declare module "babylonjs/sceneComponent" {
  11155. import { Scene } from "babylonjs/scene";
  11156. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11157. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11158. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11159. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11160. import { Nullable } from "babylonjs/types";
  11161. import { Camera } from "babylonjs/Cameras/camera";
  11162. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11163. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11164. import { AbstractScene } from "babylonjs/abstractScene";
  11165. /**
  11166. * Groups all the scene component constants in one place to ease maintenance.
  11167. * @hidden
  11168. */
  11169. export class SceneComponentConstants {
  11170. static readonly NAME_EFFECTLAYER: string;
  11171. static readonly NAME_LAYER: string;
  11172. static readonly NAME_LENSFLARESYSTEM: string;
  11173. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11174. static readonly NAME_PARTICLESYSTEM: string;
  11175. static readonly NAME_GAMEPAD: string;
  11176. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11177. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11178. static readonly NAME_DEPTHRENDERER: string;
  11179. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11180. static readonly NAME_SPRITE: string;
  11181. static readonly NAME_OUTLINERENDERER: string;
  11182. static readonly NAME_PROCEDURALTEXTURE: string;
  11183. static readonly NAME_SHADOWGENERATOR: string;
  11184. static readonly NAME_OCTREE: string;
  11185. static readonly NAME_PHYSICSENGINE: string;
  11186. static readonly NAME_AUDIO: string;
  11187. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11188. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11189. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11190. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11191. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11192. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11193. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11194. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11195. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11196. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11197. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11198. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11199. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11200. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11201. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11202. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11203. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11204. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11205. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11206. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11207. static readonly STEP_AFTERRENDER_AUDIO: number;
  11208. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11209. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11210. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11211. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11212. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11213. static readonly STEP_POINTERMOVE_SPRITE: number;
  11214. static readonly STEP_POINTERDOWN_SPRITE: number;
  11215. static readonly STEP_POINTERUP_SPRITE: number;
  11216. }
  11217. /**
  11218. * This represents a scene component.
  11219. *
  11220. * This is used to decouple the dependency the scene is having on the different workloads like
  11221. * layers, post processes...
  11222. */
  11223. export interface ISceneComponent {
  11224. /**
  11225. * The name of the component. Each component must have a unique name.
  11226. */
  11227. name: string;
  11228. /**
  11229. * The scene the component belongs to.
  11230. */
  11231. scene: Scene;
  11232. /**
  11233. * Register the component to one instance of a scene.
  11234. */
  11235. register(): void;
  11236. /**
  11237. * Rebuilds the elements related to this component in case of
  11238. * context lost for instance.
  11239. */
  11240. rebuild(): void;
  11241. /**
  11242. * Disposes the component and the associated ressources.
  11243. */
  11244. dispose(): void;
  11245. }
  11246. /**
  11247. * This represents a SERIALIZABLE scene component.
  11248. *
  11249. * This extends Scene Component to add Serialization methods on top.
  11250. */
  11251. export interface ISceneSerializableComponent extends ISceneComponent {
  11252. /**
  11253. * Adds all the elements from the container to the scene
  11254. * @param container the container holding the elements
  11255. */
  11256. addFromContainer(container: AbstractScene): void;
  11257. /**
  11258. * Removes all the elements in the container from the scene
  11259. * @param container contains the elements to remove
  11260. * @param dispose if the removed element should be disposed (default: false)
  11261. */
  11262. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11263. /**
  11264. * Serializes the component data to the specified json object
  11265. * @param serializationObject The object to serialize to
  11266. */
  11267. serialize(serializationObject: any): void;
  11268. }
  11269. /**
  11270. * Strong typing of a Mesh related stage step action
  11271. */
  11272. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11273. /**
  11274. * Strong typing of a Evaluate Sub Mesh related stage step action
  11275. */
  11276. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11277. /**
  11278. * Strong typing of a Active Mesh related stage step action
  11279. */
  11280. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11281. /**
  11282. * Strong typing of a Camera related stage step action
  11283. */
  11284. export type CameraStageAction = (camera: Camera) => void;
  11285. /**
  11286. * Strong typing of a Camera Frame buffer related stage step action
  11287. */
  11288. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11289. /**
  11290. * Strong typing of a Render Target related stage step action
  11291. */
  11292. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11293. /**
  11294. * Strong typing of a RenderingGroup related stage step action
  11295. */
  11296. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11297. /**
  11298. * Strong typing of a Mesh Render related stage step action
  11299. */
  11300. export type RenderingMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11301. /**
  11302. * Strong typing of a simple stage step action
  11303. */
  11304. export type SimpleStageAction = () => void;
  11305. /**
  11306. * Strong typing of a render target action.
  11307. */
  11308. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11309. /**
  11310. * Strong typing of a pointer move action.
  11311. */
  11312. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  11313. /**
  11314. * Strong typing of a pointer up/down action.
  11315. */
  11316. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11317. /**
  11318. * Repressentation of a stage in the scene (Basically a list of ordered steps)
  11319. * @hidden
  11320. */
  11321. export class Stage<T extends Function> extends Array<{
  11322. index: number;
  11323. component: ISceneComponent;
  11324. action: T;
  11325. }> {
  11326. /**
  11327. * Hide ctor from the rest of the world.
  11328. * @param items The items to add.
  11329. */
  11330. private constructor();
  11331. /**
  11332. * Creates a new Stage.
  11333. * @returns A new instance of a Stage
  11334. */
  11335. static Create<T extends Function>(): Stage<T>;
  11336. /**
  11337. * Registers a step in an ordered way in the targeted stage.
  11338. * @param index Defines the position to register the step in
  11339. * @param component Defines the component attached to the step
  11340. * @param action Defines the action to launch during the step
  11341. */
  11342. registerStep(index: number, component: ISceneComponent, action: T): void;
  11343. /**
  11344. * Clears all the steps from the stage.
  11345. */
  11346. clear(): void;
  11347. }
  11348. }
  11349. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11350. import { Nullable } from "babylonjs/types";
  11351. import { Observable } from "babylonjs/Misc/observable";
  11352. import { Scene } from "babylonjs/scene";
  11353. import { Sprite } from "babylonjs/Sprites/sprite";
  11354. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11355. import { Ray } from "babylonjs/Culling/ray";
  11356. import { Camera } from "babylonjs/Cameras/camera";
  11357. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11358. import { ISceneComponent } from "babylonjs/sceneComponent";
  11359. module "babylonjs/scene" {
  11360. interface Scene {
  11361. /** @hidden */
  11362. _pointerOverSprite: Nullable<Sprite>;
  11363. /** @hidden */
  11364. _pickedDownSprite: Nullable<Sprite>;
  11365. /** @hidden */
  11366. _tempSpritePickingRay: Nullable<Ray>;
  11367. /**
  11368. * All of the sprite managers added to this scene
  11369. * @see http://doc.babylonjs.com/babylon101/sprites
  11370. */
  11371. spriteManagers: Array<ISpriteManager>;
  11372. /**
  11373. * An event triggered when sprites rendering is about to start
  11374. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11375. */
  11376. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11377. /**
  11378. * An event triggered when sprites rendering is done
  11379. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11380. */
  11381. onAfterSpritesRenderingObservable: Observable<Scene>;
  11382. /** @hidden */
  11383. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11384. /** Launch a ray to try to pick a sprite in the scene
  11385. * @param x position on screen
  11386. * @param y position on screen
  11387. * @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
  11388. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11389. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11390. * @returns a PickingInfo
  11391. */
  11392. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11393. /** Use the given ray to pick a sprite in the scene
  11394. * @param ray The ray (in world space) to use to pick meshes
  11395. * @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
  11396. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11397. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11398. * @returns a PickingInfo
  11399. */
  11400. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11401. /**
  11402. * Force the sprite under the pointer
  11403. * @param sprite defines the sprite to use
  11404. */
  11405. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11406. /**
  11407. * Gets the sprite under the pointer
  11408. * @returns a Sprite or null if no sprite is under the pointer
  11409. */
  11410. getPointerOverSprite(): Nullable<Sprite>;
  11411. }
  11412. }
  11413. /**
  11414. * Defines the sprite scene component responsible to manage sprites
  11415. * in a given scene.
  11416. */
  11417. export class SpriteSceneComponent implements ISceneComponent {
  11418. /**
  11419. * The component name helpfull to identify the component in the list of scene components.
  11420. */
  11421. readonly name: string;
  11422. /**
  11423. * The scene the component belongs to.
  11424. */
  11425. scene: Scene;
  11426. /** @hidden */
  11427. private _spritePredicate;
  11428. /**
  11429. * Creates a new instance of the component for the given scene
  11430. * @param scene Defines the scene to register the component in
  11431. */
  11432. constructor(scene: Scene);
  11433. /**
  11434. * Registers the component in a given scene
  11435. */
  11436. register(): void;
  11437. /**
  11438. * Rebuilds the elements related to this component in case of
  11439. * context lost for instance.
  11440. */
  11441. rebuild(): void;
  11442. /**
  11443. * Disposes the component and the associated ressources.
  11444. */
  11445. dispose(): void;
  11446. private _pickSpriteButKeepRay;
  11447. private _pointerMove;
  11448. private _pointerDown;
  11449. private _pointerUp;
  11450. }
  11451. }
  11452. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11453. /** @hidden */
  11454. export var fogFragmentDeclaration: {
  11455. name: string;
  11456. shader: string;
  11457. };
  11458. }
  11459. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11460. /** @hidden */
  11461. export var fogFragment: {
  11462. name: string;
  11463. shader: string;
  11464. };
  11465. }
  11466. declare module "babylonjs/Shaders/sprites.fragment" {
  11467. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11468. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11469. /** @hidden */
  11470. export var spritesPixelShader: {
  11471. name: string;
  11472. shader: string;
  11473. };
  11474. }
  11475. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11476. /** @hidden */
  11477. export var fogVertexDeclaration: {
  11478. name: string;
  11479. shader: string;
  11480. };
  11481. }
  11482. declare module "babylonjs/Shaders/sprites.vertex" {
  11483. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11484. /** @hidden */
  11485. export var spritesVertexShader: {
  11486. name: string;
  11487. shader: string;
  11488. };
  11489. }
  11490. declare module "babylonjs/Sprites/spriteManager" {
  11491. import { IDisposable, Scene } from "babylonjs/scene";
  11492. import { Nullable } from "babylonjs/types";
  11493. import { Observable } from "babylonjs/Misc/observable";
  11494. import { Sprite } from "babylonjs/Sprites/sprite";
  11495. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11496. import { Camera } from "babylonjs/Cameras/camera";
  11497. import { Texture } from "babylonjs/Materials/Textures/texture";
  11498. import "babylonjs/Shaders/sprites.fragment";
  11499. import "babylonjs/Shaders/sprites.vertex";
  11500. import { Ray } from "babylonjs/Culling/ray";
  11501. /**
  11502. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11503. */
  11504. export interface ISpriteManager extends IDisposable {
  11505. /**
  11506. * Restricts the camera to viewing objects with the same layerMask.
  11507. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11508. */
  11509. layerMask: number;
  11510. /**
  11511. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11512. */
  11513. isPickable: boolean;
  11514. /**
  11515. * Specifies the rendering group id for this mesh (0 by default)
  11516. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11517. */
  11518. renderingGroupId: number;
  11519. /**
  11520. * Defines the list of sprites managed by the manager.
  11521. */
  11522. sprites: Array<Sprite>;
  11523. /**
  11524. * Tests the intersection of a sprite with a specific ray.
  11525. * @param ray The ray we are sending to test the collision
  11526. * @param camera The camera space we are sending rays in
  11527. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11528. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11529. * @returns picking info or null.
  11530. */
  11531. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11532. /**
  11533. * Renders the list of sprites on screen.
  11534. */
  11535. render(): void;
  11536. }
  11537. /**
  11538. * Class used to manage multiple sprites on the same spritesheet
  11539. * @see http://doc.babylonjs.com/babylon101/sprites
  11540. */
  11541. export class SpriteManager implements ISpriteManager {
  11542. /** defines the manager's name */
  11543. name: string;
  11544. /** Gets the list of sprites */
  11545. sprites: Sprite[];
  11546. /** Gets or sets the rendering group id (0 by default) */
  11547. renderingGroupId: number;
  11548. /** Gets or sets camera layer mask */
  11549. layerMask: number;
  11550. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11551. fogEnabled: boolean;
  11552. /** Gets or sets a boolean indicating if the sprites are pickable */
  11553. isPickable: boolean;
  11554. /** Defines the default width of a cell in the spritesheet */
  11555. cellWidth: number;
  11556. /** Defines the default height of a cell in the spritesheet */
  11557. cellHeight: number;
  11558. /**
  11559. * An event triggered when the manager is disposed.
  11560. */
  11561. onDisposeObservable: Observable<SpriteManager>;
  11562. private _onDisposeObserver;
  11563. /**
  11564. * Callback called when the manager is disposed
  11565. */
  11566. onDispose: () => void;
  11567. private _capacity;
  11568. private _spriteTexture;
  11569. private _epsilon;
  11570. private _scene;
  11571. private _vertexData;
  11572. private _buffer;
  11573. private _vertexBuffers;
  11574. private _indexBuffer;
  11575. private _effectBase;
  11576. private _effectFog;
  11577. /**
  11578. * Gets or sets the spritesheet texture
  11579. */
  11580. texture: Texture;
  11581. /**
  11582. * Creates a new sprite manager
  11583. * @param name defines the manager's name
  11584. * @param imgUrl defines the sprite sheet url
  11585. * @param capacity defines the maximum allowed number of sprites
  11586. * @param cellSize defines the size of a sprite cell
  11587. * @param scene defines the hosting scene
  11588. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11589. * @param samplingMode defines the smapling mode to use with spritesheet
  11590. */
  11591. constructor(
  11592. /** defines the manager's name */
  11593. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number);
  11594. private _appendSpriteVertex;
  11595. /**
  11596. * Intersects the sprites with a ray
  11597. * @param ray defines the ray to intersect with
  11598. * @param camera defines the current active camera
  11599. * @param predicate defines a predicate used to select candidate sprites
  11600. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11601. * @returns null if no hit or a PickingInfo
  11602. */
  11603. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11604. /**
  11605. * Render all child sprites
  11606. */
  11607. render(): void;
  11608. /**
  11609. * Release associated resources
  11610. */
  11611. dispose(): void;
  11612. }
  11613. }
  11614. declare module "babylonjs/Sprites/sprite" {
  11615. import { Vector3 } from "babylonjs/Maths/math.vector";
  11616. import { Nullable } from "babylonjs/types";
  11617. import { ActionManager } from "babylonjs/Actions/actionManager";
  11618. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11619. import { Color4 } from "babylonjs/Maths/math.color";
  11620. /**
  11621. * Class used to represent a sprite
  11622. * @see http://doc.babylonjs.com/babylon101/sprites
  11623. */
  11624. export class Sprite {
  11625. /** defines the name */
  11626. name: string;
  11627. /** Gets or sets the current world position */
  11628. position: Vector3;
  11629. /** Gets or sets the main color */
  11630. color: Color4;
  11631. /** Gets or sets the width */
  11632. width: number;
  11633. /** Gets or sets the height */
  11634. height: number;
  11635. /** Gets or sets rotation angle */
  11636. angle: number;
  11637. /** Gets or sets the cell index in the sprite sheet */
  11638. cellIndex: number;
  11639. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11640. invertU: number;
  11641. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11642. invertV: number;
  11643. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11644. disposeWhenFinishedAnimating: boolean;
  11645. /** Gets the list of attached animations */
  11646. animations: Animation[];
  11647. /** Gets or sets a boolean indicating if the sprite can be picked */
  11648. isPickable: boolean;
  11649. /**
  11650. * Gets or sets the associated action manager
  11651. */
  11652. actionManager: Nullable<ActionManager>;
  11653. private _animationStarted;
  11654. private _loopAnimation;
  11655. private _fromIndex;
  11656. private _toIndex;
  11657. private _delay;
  11658. private _direction;
  11659. private _manager;
  11660. private _time;
  11661. private _onAnimationEnd;
  11662. /**
  11663. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11664. */
  11665. isVisible: boolean;
  11666. /**
  11667. * Gets or sets the sprite size
  11668. */
  11669. size: number;
  11670. /**
  11671. * Creates a new Sprite
  11672. * @param name defines the name
  11673. * @param manager defines the manager
  11674. */
  11675. constructor(
  11676. /** defines the name */
  11677. name: string, manager: ISpriteManager);
  11678. /**
  11679. * Starts an animation
  11680. * @param from defines the initial key
  11681. * @param to defines the end key
  11682. * @param loop defines if the animation must loop
  11683. * @param delay defines the start delay (in ms)
  11684. * @param onAnimationEnd defines a callback to call when animation ends
  11685. */
  11686. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11687. /** Stops current animation (if any) */
  11688. stopAnimation(): void;
  11689. /** @hidden */
  11690. _animate(deltaTime: number): void;
  11691. /** Release associated resources */
  11692. dispose(): void;
  11693. }
  11694. }
  11695. declare module "babylonjs/Collisions/pickingInfo" {
  11696. import { Nullable } from "babylonjs/types";
  11697. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11698. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11699. import { Sprite } from "babylonjs/Sprites/sprite";
  11700. import { Ray } from "babylonjs/Culling/ray";
  11701. /**
  11702. * Information about the result of picking within a scene
  11703. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11704. */
  11705. export class PickingInfo {
  11706. /** @hidden */
  11707. _pickingUnavailable: boolean;
  11708. /**
  11709. * If the pick collided with an object
  11710. */
  11711. hit: boolean;
  11712. /**
  11713. * Distance away where the pick collided
  11714. */
  11715. distance: number;
  11716. /**
  11717. * The location of pick collision
  11718. */
  11719. pickedPoint: Nullable<Vector3>;
  11720. /**
  11721. * The mesh corresponding the the pick collision
  11722. */
  11723. pickedMesh: Nullable<AbstractMesh>;
  11724. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  11725. bu: number;
  11726. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  11727. bv: number;
  11728. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  11729. faceId: number;
  11730. /** Id of the the submesh that was picked */
  11731. subMeshId: number;
  11732. /** If a sprite was picked, this will be the sprite the pick collided with */
  11733. pickedSprite: Nullable<Sprite>;
  11734. /**
  11735. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  11736. */
  11737. originMesh: Nullable<AbstractMesh>;
  11738. /**
  11739. * The ray that was used to perform the picking.
  11740. */
  11741. ray: Nullable<Ray>;
  11742. /**
  11743. * Gets the normal correspodning to the face the pick collided with
  11744. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  11745. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  11746. * @returns The normal correspodning to the face the pick collided with
  11747. */
  11748. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  11749. /**
  11750. * Gets the texture coordinates of where the pick occured
  11751. * @returns the vector containing the coordnates of the texture
  11752. */
  11753. getTextureCoordinates(): Nullable<Vector2>;
  11754. }
  11755. }
  11756. declare module "babylonjs/Events/pointerEvents" {
  11757. import { Nullable } from "babylonjs/types";
  11758. import { Vector2 } from "babylonjs/Maths/math.vector";
  11759. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11760. import { Ray } from "babylonjs/Culling/ray";
  11761. /**
  11762. * Gather the list of pointer event types as constants.
  11763. */
  11764. export class PointerEventTypes {
  11765. /**
  11766. * 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.
  11767. */
  11768. static readonly POINTERDOWN: number;
  11769. /**
  11770. * The pointerup event is fired when a pointer is no longer active.
  11771. */
  11772. static readonly POINTERUP: number;
  11773. /**
  11774. * The pointermove event is fired when a pointer changes coordinates.
  11775. */
  11776. static readonly POINTERMOVE: number;
  11777. /**
  11778. * The pointerwheel event is fired when a mouse wheel has been rotated.
  11779. */
  11780. static readonly POINTERWHEEL: number;
  11781. /**
  11782. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  11783. */
  11784. static readonly POINTERPICK: number;
  11785. /**
  11786. * The pointertap event is fired when a the object has been touched and released without drag.
  11787. */
  11788. static readonly POINTERTAP: number;
  11789. /**
  11790. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  11791. */
  11792. static readonly POINTERDOUBLETAP: number;
  11793. }
  11794. /**
  11795. * Base class of pointer info types.
  11796. */
  11797. export class PointerInfoBase {
  11798. /**
  11799. * Defines the type of event (PointerEventTypes)
  11800. */
  11801. type: number;
  11802. /**
  11803. * Defines the related dom event
  11804. */
  11805. event: PointerEvent | MouseWheelEvent;
  11806. /**
  11807. * Instantiates the base class of pointers info.
  11808. * @param type Defines the type of event (PointerEventTypes)
  11809. * @param event Defines the related dom event
  11810. */
  11811. constructor(
  11812. /**
  11813. * Defines the type of event (PointerEventTypes)
  11814. */
  11815. type: number,
  11816. /**
  11817. * Defines the related dom event
  11818. */
  11819. event: PointerEvent | MouseWheelEvent);
  11820. }
  11821. /**
  11822. * This class is used to store pointer related info for the onPrePointerObservable event.
  11823. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  11824. */
  11825. export class PointerInfoPre extends PointerInfoBase {
  11826. /**
  11827. * Ray from a pointer if availible (eg. 6dof controller)
  11828. */
  11829. ray: Nullable<Ray>;
  11830. /**
  11831. * Defines the local position of the pointer on the canvas.
  11832. */
  11833. localPosition: Vector2;
  11834. /**
  11835. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  11836. */
  11837. skipOnPointerObservable: boolean;
  11838. /**
  11839. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  11840. * @param type Defines the type of event (PointerEventTypes)
  11841. * @param event Defines the related dom event
  11842. * @param localX Defines the local x coordinates of the pointer when the event occured
  11843. * @param localY Defines the local y coordinates of the pointer when the event occured
  11844. */
  11845. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  11846. }
  11847. /**
  11848. * This type contains all the data related to a pointer event in Babylon.js.
  11849. * 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.
  11850. */
  11851. export class PointerInfo extends PointerInfoBase {
  11852. /**
  11853. * Defines the picking info associated to the info (if any)\
  11854. */
  11855. pickInfo: Nullable<PickingInfo>;
  11856. /**
  11857. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  11858. * @param type Defines the type of event (PointerEventTypes)
  11859. * @param event Defines the related dom event
  11860. * @param pickInfo Defines the picking info associated to the info (if any)\
  11861. */
  11862. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  11863. /**
  11864. * Defines the picking info associated to the info (if any)\
  11865. */
  11866. pickInfo: Nullable<PickingInfo>);
  11867. }
  11868. /**
  11869. * Data relating to a touch event on the screen.
  11870. */
  11871. export interface PointerTouch {
  11872. /**
  11873. * X coordinate of touch.
  11874. */
  11875. x: number;
  11876. /**
  11877. * Y coordinate of touch.
  11878. */
  11879. y: number;
  11880. /**
  11881. * Id of touch. Unique for each finger.
  11882. */
  11883. pointerId: number;
  11884. /**
  11885. * Event type passed from DOM.
  11886. */
  11887. type: any;
  11888. }
  11889. }
  11890. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  11891. import { Observable } from "babylonjs/Misc/observable";
  11892. import { Nullable } from "babylonjs/types";
  11893. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  11894. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  11895. /**
  11896. * Manage the mouse inputs to control the movement of a free camera.
  11897. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  11898. */
  11899. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  11900. /**
  11901. * Define if touch is enabled in the mouse input
  11902. */
  11903. touchEnabled: boolean;
  11904. /**
  11905. * Defines the camera the input is attached to.
  11906. */
  11907. camera: FreeCamera;
  11908. /**
  11909. * Defines the buttons associated with the input to handle camera move.
  11910. */
  11911. buttons: number[];
  11912. /**
  11913. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  11914. */
  11915. angularSensibility: number;
  11916. private _pointerInput;
  11917. private _onMouseMove;
  11918. private _observer;
  11919. private previousPosition;
  11920. /**
  11921. * Observable for when a pointer move event occurs containing the move offset
  11922. */
  11923. onPointerMovedObservable: Observable<{
  11924. offsetX: number;
  11925. offsetY: number;
  11926. }>;
  11927. /**
  11928. * @hidden
  11929. * If the camera should be rotated automatically based on pointer movement
  11930. */
  11931. _allowCameraRotation: boolean;
  11932. /**
  11933. * Manage the mouse inputs to control the movement of a free camera.
  11934. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  11935. * @param touchEnabled Defines if touch is enabled or not
  11936. */
  11937. constructor(
  11938. /**
  11939. * Define if touch is enabled in the mouse input
  11940. */
  11941. touchEnabled?: boolean);
  11942. /**
  11943. * Attach the input controls to a specific dom element to get the input from.
  11944. * @param element Defines the element the controls should be listened from
  11945. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  11946. */
  11947. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  11948. /**
  11949. * Called on JS contextmenu event.
  11950. * Override this method to provide functionality.
  11951. */
  11952. protected onContextMenu(evt: PointerEvent): void;
  11953. /**
  11954. * Detach the current controls from the specified dom element.
  11955. * @param element Defines the element to stop listening the inputs from
  11956. */
  11957. detachControl(element: Nullable<HTMLElement>): void;
  11958. /**
  11959. * Gets the class name of the current intput.
  11960. * @returns the class name
  11961. */
  11962. getClassName(): string;
  11963. /**
  11964. * Get the friendly name associated with the input class.
  11965. * @returns the input friendly name
  11966. */
  11967. getSimpleName(): string;
  11968. }
  11969. }
  11970. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  11971. import { Nullable } from "babylonjs/types";
  11972. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  11973. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  11974. /**
  11975. * Manage the touch inputs to control the movement of a free camera.
  11976. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  11977. */
  11978. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  11979. /**
  11980. * Defines the camera the input is attached to.
  11981. */
  11982. camera: FreeCamera;
  11983. /**
  11984. * Defines the touch sensibility for rotation.
  11985. * The higher the faster.
  11986. */
  11987. touchAngularSensibility: number;
  11988. /**
  11989. * Defines the touch sensibility for move.
  11990. * The higher the faster.
  11991. */
  11992. touchMoveSensibility: number;
  11993. private _offsetX;
  11994. private _offsetY;
  11995. private _pointerPressed;
  11996. private _pointerInput;
  11997. private _observer;
  11998. private _onLostFocus;
  11999. /**
  12000. * Attach the input controls to a specific dom element to get the input from.
  12001. * @param element Defines the element the controls should be listened from
  12002. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12003. */
  12004. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12005. /**
  12006. * Detach the current controls from the specified dom element.
  12007. * @param element Defines the element to stop listening the inputs from
  12008. */
  12009. detachControl(element: Nullable<HTMLElement>): void;
  12010. /**
  12011. * Update the current camera state depending on the inputs that have been used this frame.
  12012. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12013. */
  12014. checkInputs(): void;
  12015. /**
  12016. * Gets the class name of the current intput.
  12017. * @returns the class name
  12018. */
  12019. getClassName(): string;
  12020. /**
  12021. * Get the friendly name associated with the input class.
  12022. * @returns the input friendly name
  12023. */
  12024. getSimpleName(): string;
  12025. }
  12026. }
  12027. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12028. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12029. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12030. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12031. import { Nullable } from "babylonjs/types";
  12032. /**
  12033. * Default Inputs manager for the FreeCamera.
  12034. * It groups all the default supported inputs for ease of use.
  12035. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12036. */
  12037. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12038. /**
  12039. * @hidden
  12040. */
  12041. _mouseInput: Nullable<FreeCameraMouseInput>;
  12042. /**
  12043. * Instantiates a new FreeCameraInputsManager.
  12044. * @param camera Defines the camera the inputs belong to
  12045. */
  12046. constructor(camera: FreeCamera);
  12047. /**
  12048. * Add keyboard input support to the input manager.
  12049. * @returns the current input manager
  12050. */
  12051. addKeyboard(): FreeCameraInputsManager;
  12052. /**
  12053. * Add mouse input support to the input manager.
  12054. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12055. * @returns the current input manager
  12056. */
  12057. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12058. /**
  12059. * Removes the mouse input support from the manager
  12060. * @returns the current input manager
  12061. */
  12062. removeMouse(): FreeCameraInputsManager;
  12063. /**
  12064. * Add touch input support to the input manager.
  12065. * @returns the current input manager
  12066. */
  12067. addTouch(): FreeCameraInputsManager;
  12068. /**
  12069. * Remove all attached input methods from a camera
  12070. */
  12071. clear(): void;
  12072. }
  12073. }
  12074. declare module "babylonjs/Cameras/freeCamera" {
  12075. import { Vector3 } from "babylonjs/Maths/math.vector";
  12076. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12077. import { Scene } from "babylonjs/scene";
  12078. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12079. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12080. /**
  12081. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12082. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12083. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12084. */
  12085. export class FreeCamera extends TargetCamera {
  12086. /**
  12087. * Define the collision ellipsoid of the camera.
  12088. * This is helpful to simulate a camera body like the player body around the camera
  12089. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12090. */
  12091. ellipsoid: Vector3;
  12092. /**
  12093. * Define an offset for the position of the ellipsoid around the camera.
  12094. * This can be helpful to determine the center of the body near the gravity center of the body
  12095. * instead of its head.
  12096. */
  12097. ellipsoidOffset: Vector3;
  12098. /**
  12099. * Enable or disable collisions of the camera with the rest of the scene objects.
  12100. */
  12101. checkCollisions: boolean;
  12102. /**
  12103. * Enable or disable gravity on the camera.
  12104. */
  12105. applyGravity: boolean;
  12106. /**
  12107. * Define the input manager associated to the camera.
  12108. */
  12109. inputs: FreeCameraInputsManager;
  12110. /**
  12111. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12112. * Higher values reduce sensitivity.
  12113. */
  12114. /**
  12115. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12116. * Higher values reduce sensitivity.
  12117. */
  12118. angularSensibility: number;
  12119. /**
  12120. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12121. */
  12122. keysUp: number[];
  12123. /**
  12124. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12125. */
  12126. keysDown: number[];
  12127. /**
  12128. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12129. */
  12130. keysLeft: number[];
  12131. /**
  12132. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12133. */
  12134. keysRight: number[];
  12135. /**
  12136. * Event raised when the camera collide with a mesh in the scene.
  12137. */
  12138. onCollide: (collidedMesh: AbstractMesh) => void;
  12139. private _collider;
  12140. private _needMoveForGravity;
  12141. private _oldPosition;
  12142. private _diffPosition;
  12143. private _newPosition;
  12144. /** @hidden */
  12145. _localDirection: Vector3;
  12146. /** @hidden */
  12147. _transformedDirection: Vector3;
  12148. /**
  12149. * Instantiates a Free Camera.
  12150. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12151. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12152. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12153. * @param name Define the name of the camera in the scene
  12154. * @param position Define the start position of the camera in the scene
  12155. * @param scene Define the scene the camera belongs to
  12156. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12157. */
  12158. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12159. /**
  12160. * Attached controls to the current camera.
  12161. * @param element Defines the element the controls should be listened from
  12162. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12163. */
  12164. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12165. /**
  12166. * Detach the current controls from the camera.
  12167. * The camera will stop reacting to inputs.
  12168. * @param element Defines the element to stop listening the inputs from
  12169. */
  12170. detachControl(element: HTMLElement): void;
  12171. private _collisionMask;
  12172. /**
  12173. * Define a collision mask to limit the list of object the camera can collide with
  12174. */
  12175. collisionMask: number;
  12176. /** @hidden */
  12177. _collideWithWorld(displacement: Vector3): void;
  12178. private _onCollisionPositionChange;
  12179. /** @hidden */
  12180. _checkInputs(): void;
  12181. /** @hidden */
  12182. _decideIfNeedsToMove(): boolean;
  12183. /** @hidden */
  12184. _updatePosition(): void;
  12185. /**
  12186. * Destroy the camera and release the current resources hold by it.
  12187. */
  12188. dispose(): void;
  12189. /**
  12190. * Gets the current object class name.
  12191. * @return the class name
  12192. */
  12193. getClassName(): string;
  12194. }
  12195. }
  12196. declare module "babylonjs/Gamepads/gamepad" {
  12197. import { Observable } from "babylonjs/Misc/observable";
  12198. /**
  12199. * Represents a gamepad control stick position
  12200. */
  12201. export class StickValues {
  12202. /**
  12203. * The x component of the control stick
  12204. */
  12205. x: number;
  12206. /**
  12207. * The y component of the control stick
  12208. */
  12209. y: number;
  12210. /**
  12211. * Initializes the gamepad x and y control stick values
  12212. * @param x The x component of the gamepad control stick value
  12213. * @param y The y component of the gamepad control stick value
  12214. */
  12215. constructor(
  12216. /**
  12217. * The x component of the control stick
  12218. */
  12219. x: number,
  12220. /**
  12221. * The y component of the control stick
  12222. */
  12223. y: number);
  12224. }
  12225. /**
  12226. * An interface which manages callbacks for gamepad button changes
  12227. */
  12228. export interface GamepadButtonChanges {
  12229. /**
  12230. * Called when a gamepad has been changed
  12231. */
  12232. changed: boolean;
  12233. /**
  12234. * Called when a gamepad press event has been triggered
  12235. */
  12236. pressChanged: boolean;
  12237. /**
  12238. * Called when a touch event has been triggered
  12239. */
  12240. touchChanged: boolean;
  12241. /**
  12242. * Called when a value has changed
  12243. */
  12244. valueChanged: boolean;
  12245. }
  12246. /**
  12247. * Represents a gamepad
  12248. */
  12249. export class Gamepad {
  12250. /**
  12251. * The id of the gamepad
  12252. */
  12253. id: string;
  12254. /**
  12255. * The index of the gamepad
  12256. */
  12257. index: number;
  12258. /**
  12259. * The browser gamepad
  12260. */
  12261. browserGamepad: any;
  12262. /**
  12263. * Specifies what type of gamepad this represents
  12264. */
  12265. type: number;
  12266. private _leftStick;
  12267. private _rightStick;
  12268. /** @hidden */
  12269. _isConnected: boolean;
  12270. private _leftStickAxisX;
  12271. private _leftStickAxisY;
  12272. private _rightStickAxisX;
  12273. private _rightStickAxisY;
  12274. /**
  12275. * Triggered when the left control stick has been changed
  12276. */
  12277. private _onleftstickchanged;
  12278. /**
  12279. * Triggered when the right control stick has been changed
  12280. */
  12281. private _onrightstickchanged;
  12282. /**
  12283. * Represents a gamepad controller
  12284. */
  12285. static GAMEPAD: number;
  12286. /**
  12287. * Represents a generic controller
  12288. */
  12289. static GENERIC: number;
  12290. /**
  12291. * Represents an XBox controller
  12292. */
  12293. static XBOX: number;
  12294. /**
  12295. * Represents a pose-enabled controller
  12296. */
  12297. static POSE_ENABLED: number;
  12298. /**
  12299. * Represents an Dual Shock controller
  12300. */
  12301. static DUALSHOCK: number;
  12302. /**
  12303. * Specifies whether the left control stick should be Y-inverted
  12304. */
  12305. protected _invertLeftStickY: boolean;
  12306. /**
  12307. * Specifies if the gamepad has been connected
  12308. */
  12309. readonly isConnected: boolean;
  12310. /**
  12311. * Initializes the gamepad
  12312. * @param id The id of the gamepad
  12313. * @param index The index of the gamepad
  12314. * @param browserGamepad The browser gamepad
  12315. * @param leftStickX The x component of the left joystick
  12316. * @param leftStickY The y component of the left joystick
  12317. * @param rightStickX The x component of the right joystick
  12318. * @param rightStickY The y component of the right joystick
  12319. */
  12320. constructor(
  12321. /**
  12322. * The id of the gamepad
  12323. */
  12324. id: string,
  12325. /**
  12326. * The index of the gamepad
  12327. */
  12328. index: number,
  12329. /**
  12330. * The browser gamepad
  12331. */
  12332. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12333. /**
  12334. * Callback triggered when the left joystick has changed
  12335. * @param callback
  12336. */
  12337. onleftstickchanged(callback: (values: StickValues) => void): void;
  12338. /**
  12339. * Callback triggered when the right joystick has changed
  12340. * @param callback
  12341. */
  12342. onrightstickchanged(callback: (values: StickValues) => void): void;
  12343. /**
  12344. * Gets the left joystick
  12345. */
  12346. /**
  12347. * Sets the left joystick values
  12348. */
  12349. leftStick: StickValues;
  12350. /**
  12351. * Gets the right joystick
  12352. */
  12353. /**
  12354. * Sets the right joystick value
  12355. */
  12356. rightStick: StickValues;
  12357. /**
  12358. * Updates the gamepad joystick positions
  12359. */
  12360. update(): void;
  12361. /**
  12362. * Disposes the gamepad
  12363. */
  12364. dispose(): void;
  12365. }
  12366. /**
  12367. * Represents a generic gamepad
  12368. */
  12369. export class GenericPad extends Gamepad {
  12370. private _buttons;
  12371. private _onbuttondown;
  12372. private _onbuttonup;
  12373. /**
  12374. * Observable triggered when a button has been pressed
  12375. */
  12376. onButtonDownObservable: Observable<number>;
  12377. /**
  12378. * Observable triggered when a button has been released
  12379. */
  12380. onButtonUpObservable: Observable<number>;
  12381. /**
  12382. * Callback triggered when a button has been pressed
  12383. * @param callback Called when a button has been pressed
  12384. */
  12385. onbuttondown(callback: (buttonPressed: number) => void): void;
  12386. /**
  12387. * Callback triggered when a button has been released
  12388. * @param callback Called when a button has been released
  12389. */
  12390. onbuttonup(callback: (buttonReleased: number) => void): void;
  12391. /**
  12392. * Initializes the generic gamepad
  12393. * @param id The id of the generic gamepad
  12394. * @param index The index of the generic gamepad
  12395. * @param browserGamepad The browser gamepad
  12396. */
  12397. constructor(id: string, index: number, browserGamepad: any);
  12398. private _setButtonValue;
  12399. /**
  12400. * Updates the generic gamepad
  12401. */
  12402. update(): void;
  12403. /**
  12404. * Disposes the generic gamepad
  12405. */
  12406. dispose(): void;
  12407. }
  12408. }
  12409. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12410. import { Nullable } from "babylonjs/types";
  12411. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12412. import { Scene } from "babylonjs/scene";
  12413. module "babylonjs/Engines/engine" {
  12414. interface Engine {
  12415. /**
  12416. * Creates a raw texture
  12417. * @param data defines the data to store in the texture
  12418. * @param width defines the width of the texture
  12419. * @param height defines the height of the texture
  12420. * @param format defines the format of the data
  12421. * @param generateMipMaps defines if the engine should generate the mip levels
  12422. * @param invertY defines if data must be stored with Y axis inverted
  12423. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12424. * @param compression defines the compression used (null by default)
  12425. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12426. * @returns the raw texture inside an InternalTexture
  12427. */
  12428. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12429. /**
  12430. * Update a raw texture
  12431. * @param texture defines the texture to update
  12432. * @param data defines the data to store in the texture
  12433. * @param format defines the format of the data
  12434. * @param invertY defines if data must be stored with Y axis inverted
  12435. */
  12436. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12437. /**
  12438. * Update a raw texture
  12439. * @param texture defines the texture to update
  12440. * @param data defines the data to store in the texture
  12441. * @param format defines the format of the data
  12442. * @param invertY defines if data must be stored with Y axis inverted
  12443. * @param compression defines the compression used (null by default)
  12444. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12445. */
  12446. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12447. /**
  12448. * Creates a new raw cube texture
  12449. * @param data defines the array of data to use to create each face
  12450. * @param size defines the size of the textures
  12451. * @param format defines the format of the data
  12452. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12453. * @param generateMipMaps defines if the engine should generate the mip levels
  12454. * @param invertY defines if data must be stored with Y axis inverted
  12455. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12456. * @param compression defines the compression used (null by default)
  12457. * @returns the cube texture as an InternalTexture
  12458. */
  12459. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12460. /**
  12461. * Update a raw cube texture
  12462. * @param texture defines the texture to udpdate
  12463. * @param data defines the data to store
  12464. * @param format defines the data format
  12465. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12466. * @param invertY defines if data must be stored with Y axis inverted
  12467. */
  12468. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12469. /**
  12470. * Update a raw cube texture
  12471. * @param texture defines the texture to udpdate
  12472. * @param data defines the data to store
  12473. * @param format defines the data format
  12474. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12475. * @param invertY defines if data must be stored with Y axis inverted
  12476. * @param compression defines the compression used (null by default)
  12477. */
  12478. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12479. /**
  12480. * Update a raw cube texture
  12481. * @param texture defines the texture to udpdate
  12482. * @param data defines the data to store
  12483. * @param format defines the data format
  12484. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12485. * @param invertY defines if data must be stored with Y axis inverted
  12486. * @param compression defines the compression used (null by default)
  12487. * @param level defines which level of the texture to update
  12488. */
  12489. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12490. /**
  12491. * Creates a new raw cube texture from a specified url
  12492. * @param url defines the url where the data is located
  12493. * @param scene defines the current scene
  12494. * @param size defines the size of the textures
  12495. * @param format defines the format of the data
  12496. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12497. * @param noMipmap defines if the engine should avoid generating the mip levels
  12498. * @param callback defines a callback used to extract texture data from loaded data
  12499. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12500. * @param onLoad defines a callback called when texture is loaded
  12501. * @param onError defines a callback called if there is an error
  12502. * @returns the cube texture as an InternalTexture
  12503. */
  12504. 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;
  12505. /**
  12506. * Creates a new raw cube texture from a specified url
  12507. * @param url defines the url where the data is located
  12508. * @param scene defines the current scene
  12509. * @param size defines the size of the textures
  12510. * @param format defines the format of the data
  12511. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12512. * @param noMipmap defines if the engine should avoid generating the mip levels
  12513. * @param callback defines a callback used to extract texture data from loaded data
  12514. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12515. * @param onLoad defines a callback called when texture is loaded
  12516. * @param onError defines a callback called if there is an error
  12517. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12518. * @param invertY defines if data must be stored with Y axis inverted
  12519. * @returns the cube texture as an InternalTexture
  12520. */
  12521. 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;
  12522. /**
  12523. * Creates a new raw 3D texture
  12524. * @param data defines the data used to create the texture
  12525. * @param width defines the width of the texture
  12526. * @param height defines the height of the texture
  12527. * @param depth defines the depth of the texture
  12528. * @param format defines the format of the texture
  12529. * @param generateMipMaps defines if the engine must generate mip levels
  12530. * @param invertY defines if data must be stored with Y axis inverted
  12531. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12532. * @param compression defines the compressed used (can be null)
  12533. * @param textureType defines the compressed used (can be null)
  12534. * @returns a new raw 3D texture (stored in an InternalTexture)
  12535. */
  12536. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12537. /**
  12538. * Update a raw 3D texture
  12539. * @param texture defines the texture to update
  12540. * @param data defines the data to store
  12541. * @param format defines the data format
  12542. * @param invertY defines if data must be stored with Y axis inverted
  12543. */
  12544. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12545. /**
  12546. * Update a raw 3D texture
  12547. * @param texture defines the texture to update
  12548. * @param data defines the data to store
  12549. * @param format defines the data format
  12550. * @param invertY defines if data must be stored with Y axis inverted
  12551. * @param compression defines the used compression (can be null)
  12552. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12553. */
  12554. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12555. }
  12556. }
  12557. }
  12558. declare module "babylonjs/Materials/Textures/rawTexture" {
  12559. import { Scene } from "babylonjs/scene";
  12560. import { Texture } from "babylonjs/Materials/Textures/texture";
  12561. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12562. /**
  12563. * Raw texture can help creating a texture directly from an array of data.
  12564. * This can be super useful if you either get the data from an uncompressed source or
  12565. * if you wish to create your texture pixel by pixel.
  12566. */
  12567. export class RawTexture extends Texture {
  12568. /**
  12569. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12570. */
  12571. format: number;
  12572. private _engine;
  12573. /**
  12574. * Instantiates a new RawTexture.
  12575. * Raw texture can help creating a texture directly from an array of data.
  12576. * This can be super useful if you either get the data from an uncompressed source or
  12577. * if you wish to create your texture pixel by pixel.
  12578. * @param data define the array of data to use to create the texture
  12579. * @param width define the width of the texture
  12580. * @param height define the height of the texture
  12581. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12582. * @param scene define the scene the texture belongs to
  12583. * @param generateMipMaps define whether mip maps should be generated or not
  12584. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12585. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12586. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12587. */
  12588. constructor(data: ArrayBufferView, width: number, height: number,
  12589. /**
  12590. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12591. */
  12592. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12593. /**
  12594. * Updates the texture underlying data.
  12595. * @param data Define the new data of the texture
  12596. */
  12597. update(data: ArrayBufferView): void;
  12598. /**
  12599. * Creates a luminance texture from some data.
  12600. * @param data Define the texture data
  12601. * @param width Define the width of the texture
  12602. * @param height Define the height of the texture
  12603. * @param scene Define the scene the texture belongs to
  12604. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12605. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12606. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12607. * @returns the luminance texture
  12608. */
  12609. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12610. /**
  12611. * Creates a luminance alpha texture from some data.
  12612. * @param data Define the texture data
  12613. * @param width Define the width of the texture
  12614. * @param height Define the height of the texture
  12615. * @param scene Define the scene the texture belongs to
  12616. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12617. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12618. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12619. * @returns the luminance alpha texture
  12620. */
  12621. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12622. /**
  12623. * Creates an alpha texture from some data.
  12624. * @param data Define the texture data
  12625. * @param width Define the width of the texture
  12626. * @param height Define the height of the texture
  12627. * @param scene Define the scene the texture belongs to
  12628. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12629. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12630. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12631. * @returns the alpha texture
  12632. */
  12633. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12634. /**
  12635. * Creates a RGB texture from some data.
  12636. * @param data Define the texture data
  12637. * @param width Define the width of the texture
  12638. * @param height Define the height of the texture
  12639. * @param scene Define the scene the texture belongs to
  12640. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12641. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12642. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12643. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12644. * @returns the RGB alpha texture
  12645. */
  12646. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12647. /**
  12648. * Creates a RGBA texture from some data.
  12649. * @param data Define the texture data
  12650. * @param width Define the width of the texture
  12651. * @param height Define the height of the texture
  12652. * @param scene Define the scene the texture belongs to
  12653. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12654. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12655. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12656. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12657. * @returns the RGBA texture
  12658. */
  12659. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12660. /**
  12661. * Creates a R texture from some data.
  12662. * @param data Define the texture data
  12663. * @param width Define the width of the texture
  12664. * @param height Define the height of the texture
  12665. * @param scene Define the scene the texture belongs to
  12666. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12667. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12668. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12669. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12670. * @returns the R texture
  12671. */
  12672. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12673. }
  12674. }
  12675. declare module "babylonjs/Maths/math.size" {
  12676. /**
  12677. * Interface for the size containing width and height
  12678. */
  12679. export interface ISize {
  12680. /**
  12681. * Width
  12682. */
  12683. width: number;
  12684. /**
  12685. * Heighht
  12686. */
  12687. height: number;
  12688. }
  12689. /**
  12690. * Size containing widht and height
  12691. */
  12692. export class Size implements ISize {
  12693. /**
  12694. * Width
  12695. */
  12696. width: number;
  12697. /**
  12698. * Height
  12699. */
  12700. height: number;
  12701. /**
  12702. * Creates a Size object from the given width and height (floats).
  12703. * @param width width of the new size
  12704. * @param height height of the new size
  12705. */
  12706. constructor(width: number, height: number);
  12707. /**
  12708. * Returns a string with the Size width and height
  12709. * @returns a string with the Size width and height
  12710. */
  12711. toString(): string;
  12712. /**
  12713. * "Size"
  12714. * @returns the string "Size"
  12715. */
  12716. getClassName(): string;
  12717. /**
  12718. * Returns the Size hash code.
  12719. * @returns a hash code for a unique width and height
  12720. */
  12721. getHashCode(): number;
  12722. /**
  12723. * Updates the current size from the given one.
  12724. * @param src the given size
  12725. */
  12726. copyFrom(src: Size): void;
  12727. /**
  12728. * Updates in place the current Size from the given floats.
  12729. * @param width width of the new size
  12730. * @param height height of the new size
  12731. * @returns the updated Size.
  12732. */
  12733. copyFromFloats(width: number, height: number): Size;
  12734. /**
  12735. * Updates in place the current Size from the given floats.
  12736. * @param width width to set
  12737. * @param height height to set
  12738. * @returns the updated Size.
  12739. */
  12740. set(width: number, height: number): Size;
  12741. /**
  12742. * Multiplies the width and height by numbers
  12743. * @param w factor to multiple the width by
  12744. * @param h factor to multiple the height by
  12745. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  12746. */
  12747. multiplyByFloats(w: number, h: number): Size;
  12748. /**
  12749. * Clones the size
  12750. * @returns a new Size copied from the given one.
  12751. */
  12752. clone(): Size;
  12753. /**
  12754. * True if the current Size and the given one width and height are strictly equal.
  12755. * @param other the other size to compare against
  12756. * @returns True if the current Size and the given one width and height are strictly equal.
  12757. */
  12758. equals(other: Size): boolean;
  12759. /**
  12760. * The surface of the Size : width * height (float).
  12761. */
  12762. readonly surface: number;
  12763. /**
  12764. * Create a new size of zero
  12765. * @returns a new Size set to (0.0, 0.0)
  12766. */
  12767. static Zero(): Size;
  12768. /**
  12769. * Sums the width and height of two sizes
  12770. * @param otherSize size to add to this size
  12771. * @returns a new Size set as the addition result of the current Size and the given one.
  12772. */
  12773. add(otherSize: Size): Size;
  12774. /**
  12775. * Subtracts the width and height of two
  12776. * @param otherSize size to subtract to this size
  12777. * @returns a new Size set as the subtraction result of the given one from the current Size.
  12778. */
  12779. subtract(otherSize: Size): Size;
  12780. /**
  12781. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  12782. * @param start starting size to lerp between
  12783. * @param end end size to lerp between
  12784. * @param amount amount to lerp between the start and end values
  12785. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  12786. */
  12787. static Lerp(start: Size, end: Size, amount: number): Size;
  12788. }
  12789. }
  12790. declare module "babylonjs/Animations/runtimeAnimation" {
  12791. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  12792. import { Animatable } from "babylonjs/Animations/animatable";
  12793. import { Scene } from "babylonjs/scene";
  12794. /**
  12795. * Defines a runtime animation
  12796. */
  12797. export class RuntimeAnimation {
  12798. private _events;
  12799. /**
  12800. * The current frame of the runtime animation
  12801. */
  12802. private _currentFrame;
  12803. /**
  12804. * The animation used by the runtime animation
  12805. */
  12806. private _animation;
  12807. /**
  12808. * The target of the runtime animation
  12809. */
  12810. private _target;
  12811. /**
  12812. * The initiating animatable
  12813. */
  12814. private _host;
  12815. /**
  12816. * The original value of the runtime animation
  12817. */
  12818. private _originalValue;
  12819. /**
  12820. * The original blend value of the runtime animation
  12821. */
  12822. private _originalBlendValue;
  12823. /**
  12824. * The offsets cache of the runtime animation
  12825. */
  12826. private _offsetsCache;
  12827. /**
  12828. * The high limits cache of the runtime animation
  12829. */
  12830. private _highLimitsCache;
  12831. /**
  12832. * Specifies if the runtime animation has been stopped
  12833. */
  12834. private _stopped;
  12835. /**
  12836. * The blending factor of the runtime animation
  12837. */
  12838. private _blendingFactor;
  12839. /**
  12840. * The BabylonJS scene
  12841. */
  12842. private _scene;
  12843. /**
  12844. * The current value of the runtime animation
  12845. */
  12846. private _currentValue;
  12847. /** @hidden */
  12848. _animationState: _IAnimationState;
  12849. /**
  12850. * The active target of the runtime animation
  12851. */
  12852. private _activeTargets;
  12853. private _currentActiveTarget;
  12854. private _directTarget;
  12855. /**
  12856. * The target path of the runtime animation
  12857. */
  12858. private _targetPath;
  12859. /**
  12860. * The weight of the runtime animation
  12861. */
  12862. private _weight;
  12863. /**
  12864. * The ratio offset of the runtime animation
  12865. */
  12866. private _ratioOffset;
  12867. /**
  12868. * The previous delay of the runtime animation
  12869. */
  12870. private _previousDelay;
  12871. /**
  12872. * The previous ratio of the runtime animation
  12873. */
  12874. private _previousRatio;
  12875. private _enableBlending;
  12876. private _keys;
  12877. private _minFrame;
  12878. private _maxFrame;
  12879. private _minValue;
  12880. private _maxValue;
  12881. private _targetIsArray;
  12882. /**
  12883. * Gets the current frame of the runtime animation
  12884. */
  12885. readonly currentFrame: number;
  12886. /**
  12887. * Gets the weight of the runtime animation
  12888. */
  12889. readonly weight: number;
  12890. /**
  12891. * Gets the current value of the runtime animation
  12892. */
  12893. readonly currentValue: any;
  12894. /**
  12895. * Gets the target path of the runtime animation
  12896. */
  12897. readonly targetPath: string;
  12898. /**
  12899. * Gets the actual target of the runtime animation
  12900. */
  12901. readonly target: any;
  12902. /** @hidden */
  12903. _onLoop: () => void;
  12904. /**
  12905. * Create a new RuntimeAnimation object
  12906. * @param target defines the target of the animation
  12907. * @param animation defines the source animation object
  12908. * @param scene defines the hosting scene
  12909. * @param host defines the initiating Animatable
  12910. */
  12911. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  12912. private _preparePath;
  12913. /**
  12914. * Gets the animation from the runtime animation
  12915. */
  12916. readonly animation: Animation;
  12917. /**
  12918. * Resets the runtime animation to the beginning
  12919. * @param restoreOriginal defines whether to restore the target property to the original value
  12920. */
  12921. reset(restoreOriginal?: boolean): void;
  12922. /**
  12923. * Specifies if the runtime animation is stopped
  12924. * @returns Boolean specifying if the runtime animation is stopped
  12925. */
  12926. isStopped(): boolean;
  12927. /**
  12928. * Disposes of the runtime animation
  12929. */
  12930. dispose(): void;
  12931. /**
  12932. * Apply the interpolated value to the target
  12933. * @param currentValue defines the value computed by the animation
  12934. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  12935. */
  12936. setValue(currentValue: any, weight: number): void;
  12937. private _getOriginalValues;
  12938. private _setValue;
  12939. /**
  12940. * Gets the loop pmode of the runtime animation
  12941. * @returns Loop Mode
  12942. */
  12943. private _getCorrectLoopMode;
  12944. /**
  12945. * Move the current animation to a given frame
  12946. * @param frame defines the frame to move to
  12947. */
  12948. goToFrame(frame: number): void;
  12949. /**
  12950. * @hidden Internal use only
  12951. */
  12952. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  12953. /**
  12954. * Execute the current animation
  12955. * @param delay defines the delay to add to the current frame
  12956. * @param from defines the lower bound of the animation range
  12957. * @param to defines the upper bound of the animation range
  12958. * @param loop defines if the current animation must loop
  12959. * @param speedRatio defines the current speed ratio
  12960. * @param weight defines the weight of the animation (default is -1 so no weight)
  12961. * @param onLoop optional callback called when animation loops
  12962. * @returns a boolean indicating if the animation is running
  12963. */
  12964. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  12965. }
  12966. }
  12967. declare module "babylonjs/Animations/animatable" {
  12968. import { Animation } from "babylonjs/Animations/animation";
  12969. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  12970. import { Nullable } from "babylonjs/types";
  12971. import { Observable } from "babylonjs/Misc/observable";
  12972. import { Scene } from "babylonjs/scene";
  12973. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  12974. import { Node } from "babylonjs/node";
  12975. /**
  12976. * Class used to store an actual running animation
  12977. */
  12978. export class Animatable {
  12979. /** defines the target object */
  12980. target: any;
  12981. /** defines the starting frame number (default is 0) */
  12982. fromFrame: number;
  12983. /** defines the ending frame number (default is 100) */
  12984. toFrame: number;
  12985. /** defines if the animation must loop (default is false) */
  12986. loopAnimation: boolean;
  12987. /** defines a callback to call when animation ends if it is not looping */
  12988. onAnimationEnd?: (() => void) | null | undefined;
  12989. /** defines a callback to call when animation loops */
  12990. onAnimationLoop?: (() => void) | null | undefined;
  12991. private _localDelayOffset;
  12992. private _pausedDelay;
  12993. private _runtimeAnimations;
  12994. private _paused;
  12995. private _scene;
  12996. private _speedRatio;
  12997. private _weight;
  12998. private _syncRoot;
  12999. /**
  13000. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13001. * This will only apply for non looping animation (default is true)
  13002. */
  13003. disposeOnEnd: boolean;
  13004. /**
  13005. * Gets a boolean indicating if the animation has started
  13006. */
  13007. animationStarted: boolean;
  13008. /**
  13009. * Observer raised when the animation ends
  13010. */
  13011. onAnimationEndObservable: Observable<Animatable>;
  13012. /**
  13013. * Observer raised when the animation loops
  13014. */
  13015. onAnimationLoopObservable: Observable<Animatable>;
  13016. /**
  13017. * Gets the root Animatable used to synchronize and normalize animations
  13018. */
  13019. readonly syncRoot: Nullable<Animatable>;
  13020. /**
  13021. * Gets the current frame of the first RuntimeAnimation
  13022. * Used to synchronize Animatables
  13023. */
  13024. readonly masterFrame: number;
  13025. /**
  13026. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13027. */
  13028. weight: number;
  13029. /**
  13030. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13031. */
  13032. speedRatio: number;
  13033. /**
  13034. * Creates a new Animatable
  13035. * @param scene defines the hosting scene
  13036. * @param target defines the target object
  13037. * @param fromFrame defines the starting frame number (default is 0)
  13038. * @param toFrame defines the ending frame number (default is 100)
  13039. * @param loopAnimation defines if the animation must loop (default is false)
  13040. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13041. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13042. * @param animations defines a group of animation to add to the new Animatable
  13043. * @param onAnimationLoop defines a callback to call when animation loops
  13044. */
  13045. constructor(scene: Scene,
  13046. /** defines the target object */
  13047. target: any,
  13048. /** defines the starting frame number (default is 0) */
  13049. fromFrame?: number,
  13050. /** defines the ending frame number (default is 100) */
  13051. toFrame?: number,
  13052. /** defines if the animation must loop (default is false) */
  13053. loopAnimation?: boolean, speedRatio?: number,
  13054. /** defines a callback to call when animation ends if it is not looping */
  13055. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13056. /** defines a callback to call when animation loops */
  13057. onAnimationLoop?: (() => void) | null | undefined);
  13058. /**
  13059. * Synchronize and normalize current Animatable with a source Animatable
  13060. * This is useful when using animation weights and when animations are not of the same length
  13061. * @param root defines the root Animatable to synchronize with
  13062. * @returns the current Animatable
  13063. */
  13064. syncWith(root: Animatable): Animatable;
  13065. /**
  13066. * Gets the list of runtime animations
  13067. * @returns an array of RuntimeAnimation
  13068. */
  13069. getAnimations(): RuntimeAnimation[];
  13070. /**
  13071. * Adds more animations to the current animatable
  13072. * @param target defines the target of the animations
  13073. * @param animations defines the new animations to add
  13074. */
  13075. appendAnimations(target: any, animations: Animation[]): void;
  13076. /**
  13077. * Gets the source animation for a specific property
  13078. * @param property defines the propertyu to look for
  13079. * @returns null or the source animation for the given property
  13080. */
  13081. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13082. /**
  13083. * Gets the runtime animation for a specific property
  13084. * @param property defines the propertyu to look for
  13085. * @returns null or the runtime animation for the given property
  13086. */
  13087. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13088. /**
  13089. * Resets the animatable to its original state
  13090. */
  13091. reset(): void;
  13092. /**
  13093. * Allows the animatable to blend with current running animations
  13094. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13095. * @param blendingSpeed defines the blending speed to use
  13096. */
  13097. enableBlending(blendingSpeed: number): void;
  13098. /**
  13099. * Disable animation blending
  13100. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13101. */
  13102. disableBlending(): void;
  13103. /**
  13104. * Jump directly to a given frame
  13105. * @param frame defines the frame to jump to
  13106. */
  13107. goToFrame(frame: number): void;
  13108. /**
  13109. * Pause the animation
  13110. */
  13111. pause(): void;
  13112. /**
  13113. * Restart the animation
  13114. */
  13115. restart(): void;
  13116. private _raiseOnAnimationEnd;
  13117. /**
  13118. * Stop and delete the current animation
  13119. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13120. * @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)
  13121. */
  13122. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13123. /**
  13124. * Wait asynchronously for the animation to end
  13125. * @returns a promise which will be fullfilled when the animation ends
  13126. */
  13127. waitAsync(): Promise<Animatable>;
  13128. /** @hidden */
  13129. _animate(delay: number): boolean;
  13130. }
  13131. module "babylonjs/scene" {
  13132. interface Scene {
  13133. /** @hidden */
  13134. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13135. /** @hidden */
  13136. _processLateAnimationBindingsForMatrices(holder: {
  13137. totalWeight: number;
  13138. animations: RuntimeAnimation[];
  13139. originalValue: Matrix;
  13140. }): any;
  13141. /** @hidden */
  13142. _processLateAnimationBindingsForQuaternions(holder: {
  13143. totalWeight: number;
  13144. animations: RuntimeAnimation[];
  13145. originalValue: Quaternion;
  13146. }, refQuaternion: Quaternion): Quaternion;
  13147. /** @hidden */
  13148. _processLateAnimationBindings(): void;
  13149. /**
  13150. * Will start the animation sequence of a given target
  13151. * @param target defines the target
  13152. * @param from defines from which frame should animation start
  13153. * @param to defines until which frame should animation run.
  13154. * @param weight defines the weight to apply to the animation (1.0 by default)
  13155. * @param loop defines if the animation loops
  13156. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13157. * @param onAnimationEnd defines the function to be executed when the animation ends
  13158. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13159. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13160. * @param onAnimationLoop defines the callback to call when an animation loops
  13161. * @returns the animatable object created for this animation
  13162. */
  13163. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13164. /**
  13165. * Will start the animation sequence of a given target
  13166. * @param target defines the target
  13167. * @param from defines from which frame should animation start
  13168. * @param to defines until which frame should animation run.
  13169. * @param loop defines if the animation loops
  13170. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13171. * @param onAnimationEnd defines the function to be executed when the animation ends
  13172. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13173. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13174. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13175. * @param onAnimationLoop defines the callback to call when an animation loops
  13176. * @returns the animatable object created for this animation
  13177. */
  13178. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13179. /**
  13180. * Will start the animation sequence of a given target and its hierarchy
  13181. * @param target defines the target
  13182. * @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.
  13183. * @param from defines from which frame should animation start
  13184. * @param to defines until which frame should animation run.
  13185. * @param loop defines if the animation loops
  13186. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13187. * @param onAnimationEnd defines the function to be executed when the animation ends
  13188. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13189. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13190. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13191. * @param onAnimationLoop defines the callback to call when an animation loops
  13192. * @returns the list of created animatables
  13193. */
  13194. 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[];
  13195. /**
  13196. * Begin a new animation on a given node
  13197. * @param target defines the target where the animation will take place
  13198. * @param animations defines the list of animations to start
  13199. * @param from defines the initial value
  13200. * @param to defines the final value
  13201. * @param loop defines if you want animation to loop (off by default)
  13202. * @param speedRatio defines the speed ratio to apply to all animations
  13203. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13204. * @param onAnimationLoop defines the callback to call when an animation loops
  13205. * @returns the list of created animatables
  13206. */
  13207. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13208. /**
  13209. * Begin a new animation on a given node and its hierarchy
  13210. * @param target defines the root node where the animation will take place
  13211. * @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.
  13212. * @param animations defines the list of animations to start
  13213. * @param from defines the initial value
  13214. * @param to defines the final value
  13215. * @param loop defines if you want animation to loop (off by default)
  13216. * @param speedRatio defines the speed ratio to apply to all animations
  13217. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13218. * @param onAnimationLoop defines the callback to call when an animation loops
  13219. * @returns the list of animatables created for all nodes
  13220. */
  13221. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13222. /**
  13223. * Gets the animatable associated with a specific target
  13224. * @param target defines the target of the animatable
  13225. * @returns the required animatable if found
  13226. */
  13227. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13228. /**
  13229. * Gets all animatables associated with a given target
  13230. * @param target defines the target to look animatables for
  13231. * @returns an array of Animatables
  13232. */
  13233. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13234. /**
  13235. * Stops and removes all animations that have been applied to the scene
  13236. */
  13237. stopAllAnimations(): void;
  13238. }
  13239. }
  13240. module "babylonjs/Bones/bone" {
  13241. interface Bone {
  13242. /**
  13243. * Copy an animation range from another bone
  13244. * @param source defines the source bone
  13245. * @param rangeName defines the range name to copy
  13246. * @param frameOffset defines the frame offset
  13247. * @param rescaleAsRequired defines if rescaling must be applied if required
  13248. * @param skelDimensionsRatio defines the scaling ratio
  13249. * @returns true if operation was successful
  13250. */
  13251. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13252. }
  13253. }
  13254. }
  13255. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13256. /**
  13257. * Class used to override all child animations of a given target
  13258. */
  13259. export class AnimationPropertiesOverride {
  13260. /**
  13261. * Gets or sets a value indicating if animation blending must be used
  13262. */
  13263. enableBlending: boolean;
  13264. /**
  13265. * Gets or sets the blending speed to use when enableBlending is true
  13266. */
  13267. blendingSpeed: number;
  13268. /**
  13269. * Gets or sets the default loop mode to use
  13270. */
  13271. loopMode: number;
  13272. }
  13273. }
  13274. declare module "babylonjs/Bones/skeleton" {
  13275. import { Bone } from "babylonjs/Bones/bone";
  13276. import { Observable } from "babylonjs/Misc/observable";
  13277. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13278. import { Scene } from "babylonjs/scene";
  13279. import { Nullable } from "babylonjs/types";
  13280. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13281. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13282. import { Animatable } from "babylonjs/Animations/animatable";
  13283. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13284. import { Animation } from "babylonjs/Animations/animation";
  13285. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13286. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13287. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13288. /**
  13289. * Class used to handle skinning animations
  13290. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13291. */
  13292. export class Skeleton implements IAnimatable {
  13293. /** defines the skeleton name */
  13294. name: string;
  13295. /** defines the skeleton Id */
  13296. id: string;
  13297. /**
  13298. * Defines the list of child bones
  13299. */
  13300. bones: Bone[];
  13301. /**
  13302. * Defines an estimate of the dimension of the skeleton at rest
  13303. */
  13304. dimensionsAtRest: Vector3;
  13305. /**
  13306. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13307. */
  13308. needInitialSkinMatrix: boolean;
  13309. /**
  13310. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13311. */
  13312. overrideMesh: Nullable<AbstractMesh>;
  13313. /**
  13314. * Gets the list of animations attached to this skeleton
  13315. */
  13316. animations: Array<Animation>;
  13317. private _scene;
  13318. private _isDirty;
  13319. private _transformMatrices;
  13320. private _transformMatrixTexture;
  13321. private _meshesWithPoseMatrix;
  13322. private _animatables;
  13323. private _identity;
  13324. private _synchronizedWithMesh;
  13325. private _ranges;
  13326. private _lastAbsoluteTransformsUpdateId;
  13327. private _canUseTextureForBones;
  13328. private _uniqueId;
  13329. /** @hidden */
  13330. _numBonesWithLinkedTransformNode: number;
  13331. /** @hidden */
  13332. _hasWaitingData: Nullable<boolean>;
  13333. /**
  13334. * Specifies if the skeleton should be serialized
  13335. */
  13336. doNotSerialize: boolean;
  13337. private _useTextureToStoreBoneMatrices;
  13338. /**
  13339. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13340. * Please note that this option is not available if the hardware does not support it
  13341. */
  13342. useTextureToStoreBoneMatrices: boolean;
  13343. private _animationPropertiesOverride;
  13344. /**
  13345. * Gets or sets the animation properties override
  13346. */
  13347. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13348. /**
  13349. * List of inspectable custom properties (used by the Inspector)
  13350. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13351. */
  13352. inspectableCustomProperties: IInspectable[];
  13353. /**
  13354. * An observable triggered before computing the skeleton's matrices
  13355. */
  13356. onBeforeComputeObservable: Observable<Skeleton>;
  13357. /**
  13358. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13359. */
  13360. readonly isUsingTextureForMatrices: boolean;
  13361. /**
  13362. * Gets the unique ID of this skeleton
  13363. */
  13364. readonly uniqueId: number;
  13365. /**
  13366. * Creates a new skeleton
  13367. * @param name defines the skeleton name
  13368. * @param id defines the skeleton Id
  13369. * @param scene defines the hosting scene
  13370. */
  13371. constructor(
  13372. /** defines the skeleton name */
  13373. name: string,
  13374. /** defines the skeleton Id */
  13375. id: string, scene: Scene);
  13376. /**
  13377. * Gets the current object class name.
  13378. * @return the class name
  13379. */
  13380. getClassName(): string;
  13381. /**
  13382. * Returns an array containing the root bones
  13383. * @returns an array containing the root bones
  13384. */
  13385. getChildren(): Array<Bone>;
  13386. /**
  13387. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13388. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13389. * @returns a Float32Array containing matrices data
  13390. */
  13391. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13392. /**
  13393. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13394. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13395. * @returns a raw texture containing the data
  13396. */
  13397. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13398. /**
  13399. * Gets the current hosting scene
  13400. * @returns a scene object
  13401. */
  13402. getScene(): Scene;
  13403. /**
  13404. * Gets a string representing the current skeleton data
  13405. * @param fullDetails defines a boolean indicating if we want a verbose version
  13406. * @returns a string representing the current skeleton data
  13407. */
  13408. toString(fullDetails?: boolean): string;
  13409. /**
  13410. * Get bone's index searching by name
  13411. * @param name defines bone's name to search for
  13412. * @return the indice of the bone. Returns -1 if not found
  13413. */
  13414. getBoneIndexByName(name: string): number;
  13415. /**
  13416. * Creater a new animation range
  13417. * @param name defines the name of the range
  13418. * @param from defines the start key
  13419. * @param to defines the end key
  13420. */
  13421. createAnimationRange(name: string, from: number, to: number): void;
  13422. /**
  13423. * Delete a specific animation range
  13424. * @param name defines the name of the range
  13425. * @param deleteFrames defines if frames must be removed as well
  13426. */
  13427. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13428. /**
  13429. * Gets a specific animation range
  13430. * @param name defines the name of the range to look for
  13431. * @returns the requested animation range or null if not found
  13432. */
  13433. getAnimationRange(name: string): Nullable<AnimationRange>;
  13434. /**
  13435. * Gets the list of all animation ranges defined on this skeleton
  13436. * @returns an array
  13437. */
  13438. getAnimationRanges(): Nullable<AnimationRange>[];
  13439. /**
  13440. * Copy animation range from a source skeleton.
  13441. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13442. * @param source defines the source skeleton
  13443. * @param name defines the name of the range to copy
  13444. * @param rescaleAsRequired defines if rescaling must be applied if required
  13445. * @returns true if operation was successful
  13446. */
  13447. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13448. /**
  13449. * Forces the skeleton to go to rest pose
  13450. */
  13451. returnToRest(): void;
  13452. private _getHighestAnimationFrame;
  13453. /**
  13454. * Begin a specific animation range
  13455. * @param name defines the name of the range to start
  13456. * @param loop defines if looping must be turned on (false by default)
  13457. * @param speedRatio defines the speed ratio to apply (1 by default)
  13458. * @param onAnimationEnd defines a callback which will be called when animation will end
  13459. * @returns a new animatable
  13460. */
  13461. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13462. /** @hidden */
  13463. _markAsDirty(): void;
  13464. /** @hidden */
  13465. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13466. /** @hidden */
  13467. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13468. private _computeTransformMatrices;
  13469. /**
  13470. * Build all resources required to render a skeleton
  13471. */
  13472. prepare(): void;
  13473. /**
  13474. * Gets the list of animatables currently running for this skeleton
  13475. * @returns an array of animatables
  13476. */
  13477. getAnimatables(): IAnimatable[];
  13478. /**
  13479. * Clone the current skeleton
  13480. * @param name defines the name of the new skeleton
  13481. * @param id defines the id of the new skeleton
  13482. * @returns the new skeleton
  13483. */
  13484. clone(name: string, id: string): Skeleton;
  13485. /**
  13486. * Enable animation blending for this skeleton
  13487. * @param blendingSpeed defines the blending speed to apply
  13488. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13489. */
  13490. enableBlending(blendingSpeed?: number): void;
  13491. /**
  13492. * Releases all resources associated with the current skeleton
  13493. */
  13494. dispose(): void;
  13495. /**
  13496. * Serialize the skeleton in a JSON object
  13497. * @returns a JSON object
  13498. */
  13499. serialize(): any;
  13500. /**
  13501. * Creates a new skeleton from serialized data
  13502. * @param parsedSkeleton defines the serialized data
  13503. * @param scene defines the hosting scene
  13504. * @returns a new skeleton
  13505. */
  13506. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13507. /**
  13508. * Compute all node absolute transforms
  13509. * @param forceUpdate defines if computation must be done even if cache is up to date
  13510. */
  13511. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13512. /**
  13513. * Gets the root pose matrix
  13514. * @returns a matrix
  13515. */
  13516. getPoseMatrix(): Nullable<Matrix>;
  13517. /**
  13518. * Sorts bones per internal index
  13519. */
  13520. sortBones(): void;
  13521. private _sortBones;
  13522. }
  13523. }
  13524. declare module "babylonjs/Bones/bone" {
  13525. import { Skeleton } from "babylonjs/Bones/skeleton";
  13526. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13527. import { Nullable } from "babylonjs/types";
  13528. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13529. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13530. import { Node } from "babylonjs/node";
  13531. import { Space } from "babylonjs/Maths/math.axis";
  13532. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13533. /**
  13534. * Class used to store bone information
  13535. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13536. */
  13537. export class Bone extends Node {
  13538. /**
  13539. * defines the bone name
  13540. */
  13541. name: string;
  13542. private static _tmpVecs;
  13543. private static _tmpQuat;
  13544. private static _tmpMats;
  13545. /**
  13546. * Gets the list of child bones
  13547. */
  13548. children: Bone[];
  13549. /** Gets the animations associated with this bone */
  13550. animations: import("babylonjs/Animations/animation").Animation[];
  13551. /**
  13552. * Gets or sets bone length
  13553. */
  13554. length: number;
  13555. /**
  13556. * @hidden Internal only
  13557. * Set this value to map this bone to a different index in the transform matrices
  13558. * Set this value to -1 to exclude the bone from the transform matrices
  13559. */
  13560. _index: Nullable<number>;
  13561. private _skeleton;
  13562. private _localMatrix;
  13563. private _restPose;
  13564. private _baseMatrix;
  13565. private _absoluteTransform;
  13566. private _invertedAbsoluteTransform;
  13567. private _parent;
  13568. private _scalingDeterminant;
  13569. private _worldTransform;
  13570. private _localScaling;
  13571. private _localRotation;
  13572. private _localPosition;
  13573. private _needToDecompose;
  13574. private _needToCompose;
  13575. /** @hidden */
  13576. _linkedTransformNode: Nullable<TransformNode>;
  13577. /** @hidden */
  13578. _waitingTransformNodeId: Nullable<string>;
  13579. /** @hidden */
  13580. /** @hidden */
  13581. _matrix: Matrix;
  13582. /**
  13583. * Create a new bone
  13584. * @param name defines the bone name
  13585. * @param skeleton defines the parent skeleton
  13586. * @param parentBone defines the parent (can be null if the bone is the root)
  13587. * @param localMatrix defines the local matrix
  13588. * @param restPose defines the rest pose matrix
  13589. * @param baseMatrix defines the base matrix
  13590. * @param index defines index of the bone in the hiearchy
  13591. */
  13592. constructor(
  13593. /**
  13594. * defines the bone name
  13595. */
  13596. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13597. /**
  13598. * Gets the current object class name.
  13599. * @return the class name
  13600. */
  13601. getClassName(): string;
  13602. /**
  13603. * Gets the parent skeleton
  13604. * @returns a skeleton
  13605. */
  13606. getSkeleton(): Skeleton;
  13607. /**
  13608. * Gets parent bone
  13609. * @returns a bone or null if the bone is the root of the bone hierarchy
  13610. */
  13611. getParent(): Nullable<Bone>;
  13612. /**
  13613. * Returns an array containing the root bones
  13614. * @returns an array containing the root bones
  13615. */
  13616. getChildren(): Array<Bone>;
  13617. /**
  13618. * Sets the parent bone
  13619. * @param parent defines the parent (can be null if the bone is the root)
  13620. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13621. */
  13622. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13623. /**
  13624. * Gets the local matrix
  13625. * @returns a matrix
  13626. */
  13627. getLocalMatrix(): Matrix;
  13628. /**
  13629. * Gets the base matrix (initial matrix which remains unchanged)
  13630. * @returns a matrix
  13631. */
  13632. getBaseMatrix(): Matrix;
  13633. /**
  13634. * Gets the rest pose matrix
  13635. * @returns a matrix
  13636. */
  13637. getRestPose(): Matrix;
  13638. /**
  13639. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13640. */
  13641. getWorldMatrix(): Matrix;
  13642. /**
  13643. * Sets the local matrix to rest pose matrix
  13644. */
  13645. returnToRest(): void;
  13646. /**
  13647. * Gets the inverse of the absolute transform matrix.
  13648. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13649. * @returns a matrix
  13650. */
  13651. getInvertedAbsoluteTransform(): Matrix;
  13652. /**
  13653. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13654. * @returns a matrix
  13655. */
  13656. getAbsoluteTransform(): Matrix;
  13657. /**
  13658. * Links with the given transform node.
  13659. * The local matrix of this bone is copied from the transform node every frame.
  13660. * @param transformNode defines the transform node to link to
  13661. */
  13662. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13663. /**
  13664. * Gets the node used to drive the bone's transformation
  13665. * @returns a transform node or null
  13666. */
  13667. getTransformNode(): Nullable<TransformNode>;
  13668. /** Gets or sets current position (in local space) */
  13669. position: Vector3;
  13670. /** Gets or sets current rotation (in local space) */
  13671. rotation: Vector3;
  13672. /** Gets or sets current rotation quaternion (in local space) */
  13673. rotationQuaternion: Quaternion;
  13674. /** Gets or sets current scaling (in local space) */
  13675. scaling: Vector3;
  13676. /**
  13677. * Gets the animation properties override
  13678. */
  13679. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13680. private _decompose;
  13681. private _compose;
  13682. /**
  13683. * Update the base and local matrices
  13684. * @param matrix defines the new base or local matrix
  13685. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13686. * @param updateLocalMatrix defines if the local matrix should be updated
  13687. */
  13688. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  13689. /** @hidden */
  13690. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  13691. /**
  13692. * Flag the bone as dirty (Forcing it to update everything)
  13693. */
  13694. markAsDirty(): void;
  13695. /** @hidden */
  13696. _markAsDirtyAndCompose(): void;
  13697. private _markAsDirtyAndDecompose;
  13698. /**
  13699. * Translate the bone in local or world space
  13700. * @param vec The amount to translate the bone
  13701. * @param space The space that the translation is in
  13702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13703. */
  13704. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13705. /**
  13706. * Set the postion of the bone in local or world space
  13707. * @param position The position to set the bone
  13708. * @param space The space that the position is in
  13709. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13710. */
  13711. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13712. /**
  13713. * Set the absolute position of the bone (world space)
  13714. * @param position The position to set the bone
  13715. * @param mesh The mesh that this bone is attached to
  13716. */
  13717. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  13718. /**
  13719. * Scale the bone on the x, y and z axes (in local space)
  13720. * @param x The amount to scale the bone on the x axis
  13721. * @param y The amount to scale the bone on the y axis
  13722. * @param z The amount to scale the bone on the z axis
  13723. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  13724. */
  13725. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  13726. /**
  13727. * Set the bone scaling in local space
  13728. * @param scale defines the scaling vector
  13729. */
  13730. setScale(scale: Vector3): void;
  13731. /**
  13732. * Gets the current scaling in local space
  13733. * @returns the current scaling vector
  13734. */
  13735. getScale(): Vector3;
  13736. /**
  13737. * Gets the current scaling in local space and stores it in a target vector
  13738. * @param result defines the target vector
  13739. */
  13740. getScaleToRef(result: Vector3): void;
  13741. /**
  13742. * Set the yaw, pitch, and roll of the bone in local or world space
  13743. * @param yaw The rotation of the bone on the y axis
  13744. * @param pitch The rotation of the bone on the x axis
  13745. * @param roll The rotation of the bone on the z axis
  13746. * @param space The space that the axes of rotation are in
  13747. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13748. */
  13749. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  13750. /**
  13751. * Add a rotation to the bone on an axis in local or world space
  13752. * @param axis The axis to rotate the bone on
  13753. * @param amount The amount to rotate the bone
  13754. * @param space The space that the axis is in
  13755. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13756. */
  13757. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  13758. /**
  13759. * Set the rotation of the bone to a particular axis angle in local or world space
  13760. * @param axis The axis to rotate the bone on
  13761. * @param angle The angle that the bone should be rotated to
  13762. * @param space The space that the axis is in
  13763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13764. */
  13765. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  13766. /**
  13767. * Set the euler rotation of the bone in local of world space
  13768. * @param rotation The euler rotation that the bone should be set to
  13769. * @param space The space that the rotation is in
  13770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13771. */
  13772. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13773. /**
  13774. * Set the quaternion rotation of the bone in local of world space
  13775. * @param quat The quaternion rotation that the bone should be set to
  13776. * @param space The space that the rotation is in
  13777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13778. */
  13779. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  13780. /**
  13781. * Set the rotation matrix of the bone in local of world space
  13782. * @param rotMat The rotation matrix that the bone should be set to
  13783. * @param space The space that the rotation is in
  13784. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13785. */
  13786. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  13787. private _rotateWithMatrix;
  13788. private _getNegativeRotationToRef;
  13789. /**
  13790. * Get the position of the bone in local or world space
  13791. * @param space The space that the returned position is in
  13792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13793. * @returns The position of the bone
  13794. */
  13795. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  13796. /**
  13797. * Copy the position of the bone to a vector3 in local or world space
  13798. * @param space The space that the returned position is in
  13799. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13800. * @param result The vector3 to copy the position to
  13801. */
  13802. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  13803. /**
  13804. * Get the absolute position of the bone (world space)
  13805. * @param mesh The mesh that this bone is attached to
  13806. * @returns The absolute position of the bone
  13807. */
  13808. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  13809. /**
  13810. * Copy the absolute position of the bone (world space) to the result param
  13811. * @param mesh The mesh that this bone is attached to
  13812. * @param result The vector3 to copy the absolute position to
  13813. */
  13814. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  13815. /**
  13816. * Compute the absolute transforms of this bone and its children
  13817. */
  13818. computeAbsoluteTransforms(): void;
  13819. /**
  13820. * Get the world direction from an axis that is in the local space of the bone
  13821. * @param localAxis The local direction that is used to compute the world direction
  13822. * @param mesh The mesh that this bone is attached to
  13823. * @returns The world direction
  13824. */
  13825. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  13826. /**
  13827. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  13828. * @param localAxis The local direction that is used to compute the world direction
  13829. * @param mesh The mesh that this bone is attached to
  13830. * @param result The vector3 that the world direction will be copied to
  13831. */
  13832. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13833. /**
  13834. * Get the euler rotation of the bone in local or world space
  13835. * @param space The space that the rotation should be in
  13836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13837. * @returns The euler rotation
  13838. */
  13839. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  13840. /**
  13841. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  13842. * @param space The space that the rotation should be in
  13843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13844. * @param result The vector3 that the rotation should be copied to
  13845. */
  13846. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13847. /**
  13848. * Get the quaternion rotation of the bone in either local or world space
  13849. * @param space The space that the rotation should be in
  13850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13851. * @returns The quaternion rotation
  13852. */
  13853. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  13854. /**
  13855. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  13856. * @param space The space that the rotation should be in
  13857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13858. * @param result The quaternion that the rotation should be copied to
  13859. */
  13860. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  13861. /**
  13862. * Get the rotation matrix of the bone in local or world space
  13863. * @param space The space that the rotation should be in
  13864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13865. * @returns The rotation matrix
  13866. */
  13867. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  13868. /**
  13869. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  13870. * @param space The space that the rotation should be in
  13871. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13872. * @param result The quaternion that the rotation should be copied to
  13873. */
  13874. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  13875. /**
  13876. * Get the world position of a point that is in the local space of the bone
  13877. * @param position The local position
  13878. * @param mesh The mesh that this bone is attached to
  13879. * @returns The world position
  13880. */
  13881. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  13882. /**
  13883. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  13884. * @param position The local position
  13885. * @param mesh The mesh that this bone is attached to
  13886. * @param result The vector3 that the world position should be copied to
  13887. */
  13888. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13889. /**
  13890. * Get the local position of a point that is in world space
  13891. * @param position The world position
  13892. * @param mesh The mesh that this bone is attached to
  13893. * @returns The local position
  13894. */
  13895. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  13896. /**
  13897. * Get the local position of a point that is in world space and copy it to the result param
  13898. * @param position The world position
  13899. * @param mesh The mesh that this bone is attached to
  13900. * @param result The vector3 that the local position should be copied to
  13901. */
  13902. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  13903. }
  13904. }
  13905. declare module "babylonjs/Meshes/transformNode" {
  13906. import { DeepImmutable } from "babylonjs/types";
  13907. import { Observable } from "babylonjs/Misc/observable";
  13908. import { Nullable } from "babylonjs/types";
  13909. import { Camera } from "babylonjs/Cameras/camera";
  13910. import { Scene } from "babylonjs/scene";
  13911. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  13912. import { Node } from "babylonjs/node";
  13913. import { Bone } from "babylonjs/Bones/bone";
  13914. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13915. import { Space } from "babylonjs/Maths/math.axis";
  13916. /**
  13917. * 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.
  13918. * @see https://doc.babylonjs.com/how_to/transformnode
  13919. */
  13920. export class TransformNode extends Node {
  13921. /**
  13922. * Object will not rotate to face the camera
  13923. */
  13924. static BILLBOARDMODE_NONE: number;
  13925. /**
  13926. * Object will rotate to face the camera but only on the x axis
  13927. */
  13928. static BILLBOARDMODE_X: number;
  13929. /**
  13930. * Object will rotate to face the camera but only on the y axis
  13931. */
  13932. static BILLBOARDMODE_Y: number;
  13933. /**
  13934. * Object will rotate to face the camera but only on the z axis
  13935. */
  13936. static BILLBOARDMODE_Z: number;
  13937. /**
  13938. * Object will rotate to face the camera
  13939. */
  13940. static BILLBOARDMODE_ALL: number;
  13941. /**
  13942. * Object will rotate to face the camera's position instead of orientation
  13943. */
  13944. static BILLBOARDMODE_USE_POSITION: number;
  13945. private _forward;
  13946. private _forwardInverted;
  13947. private _up;
  13948. private _right;
  13949. private _rightInverted;
  13950. private _position;
  13951. private _rotation;
  13952. private _rotationQuaternion;
  13953. protected _scaling: Vector3;
  13954. protected _isDirty: boolean;
  13955. private _transformToBoneReferal;
  13956. private _isAbsoluteSynced;
  13957. private _billboardMode;
  13958. /**
  13959. * Gets or sets the billboard mode. Default is 0.
  13960. *
  13961. * | Value | Type | Description |
  13962. * | --- | --- | --- |
  13963. * | 0 | BILLBOARDMODE_NONE | |
  13964. * | 1 | BILLBOARDMODE_X | |
  13965. * | 2 | BILLBOARDMODE_Y | |
  13966. * | 4 | BILLBOARDMODE_Z | |
  13967. * | 7 | BILLBOARDMODE_ALL | |
  13968. *
  13969. */
  13970. billboardMode: number;
  13971. private _preserveParentRotationForBillboard;
  13972. /**
  13973. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  13974. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  13975. */
  13976. preserveParentRotationForBillboard: boolean;
  13977. /**
  13978. * 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
  13979. */
  13980. scalingDeterminant: number;
  13981. private _infiniteDistance;
  13982. /**
  13983. * Gets or sets the distance of the object to max, often used by skybox
  13984. */
  13985. infiniteDistance: boolean;
  13986. /**
  13987. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  13988. * By default the system will update normals to compensate
  13989. */
  13990. ignoreNonUniformScaling: boolean;
  13991. /**
  13992. * 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
  13993. */
  13994. reIntegrateRotationIntoRotationQuaternion: boolean;
  13995. /** @hidden */
  13996. _poseMatrix: Nullable<Matrix>;
  13997. /** @hidden */
  13998. _localMatrix: Matrix;
  13999. private _usePivotMatrix;
  14000. private _absolutePosition;
  14001. private _absoluteScaling;
  14002. private _absoluteRotationQuaternion;
  14003. private _pivotMatrix;
  14004. private _pivotMatrixInverse;
  14005. protected _postMultiplyPivotMatrix: boolean;
  14006. protected _isWorldMatrixFrozen: boolean;
  14007. /** @hidden */
  14008. _indexInSceneTransformNodesArray: number;
  14009. /**
  14010. * An event triggered after the world matrix is updated
  14011. */
  14012. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14013. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14014. /**
  14015. * Gets a string identifying the name of the class
  14016. * @returns "TransformNode" string
  14017. */
  14018. getClassName(): string;
  14019. /**
  14020. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14021. */
  14022. position: Vector3;
  14023. /**
  14024. * 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)).
  14025. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14026. */
  14027. rotation: Vector3;
  14028. /**
  14029. * 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)).
  14030. */
  14031. scaling: Vector3;
  14032. /**
  14033. * 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).
  14034. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14035. */
  14036. rotationQuaternion: Nullable<Quaternion>;
  14037. /**
  14038. * The forward direction of that transform in world space.
  14039. */
  14040. readonly forward: Vector3;
  14041. /**
  14042. * The up direction of that transform in world space.
  14043. */
  14044. readonly up: Vector3;
  14045. /**
  14046. * The right direction of that transform in world space.
  14047. */
  14048. readonly right: Vector3;
  14049. /**
  14050. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14051. * @param matrix the matrix to copy the pose from
  14052. * @returns this TransformNode.
  14053. */
  14054. updatePoseMatrix(matrix: Matrix): TransformNode;
  14055. /**
  14056. * Returns the mesh Pose matrix.
  14057. * @returns the pose matrix
  14058. */
  14059. getPoseMatrix(): Matrix;
  14060. /** @hidden */
  14061. _isSynchronized(): boolean;
  14062. /** @hidden */
  14063. _initCache(): void;
  14064. /**
  14065. * Flag the transform node as dirty (Forcing it to update everything)
  14066. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14067. * @returns this transform node
  14068. */
  14069. markAsDirty(property: string): TransformNode;
  14070. /**
  14071. * Returns the current mesh absolute position.
  14072. * Returns a Vector3.
  14073. */
  14074. readonly absolutePosition: Vector3;
  14075. /**
  14076. * Returns the current mesh absolute scaling.
  14077. * Returns a Vector3.
  14078. */
  14079. readonly absoluteScaling: Vector3;
  14080. /**
  14081. * Returns the current mesh absolute rotation.
  14082. * Returns a Quaternion.
  14083. */
  14084. readonly absoluteRotationQuaternion: Quaternion;
  14085. /**
  14086. * Sets a new matrix to apply before all other transformation
  14087. * @param matrix defines the transform matrix
  14088. * @returns the current TransformNode
  14089. */
  14090. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14091. /**
  14092. * Sets a new pivot matrix to the current node
  14093. * @param matrix defines the new pivot matrix to use
  14094. * @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
  14095. * @returns the current TransformNode
  14096. */
  14097. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14098. /**
  14099. * Returns the mesh pivot matrix.
  14100. * Default : Identity.
  14101. * @returns the matrix
  14102. */
  14103. getPivotMatrix(): Matrix;
  14104. /**
  14105. * Prevents the World matrix to be computed any longer.
  14106. * @returns the TransformNode.
  14107. */
  14108. freezeWorldMatrix(): TransformNode;
  14109. /**
  14110. * Allows back the World matrix computation.
  14111. * @returns the TransformNode.
  14112. */
  14113. unfreezeWorldMatrix(): this;
  14114. /**
  14115. * True if the World matrix has been frozen.
  14116. */
  14117. readonly isWorldMatrixFrozen: boolean;
  14118. /**
  14119. * Retuns the mesh absolute position in the World.
  14120. * @returns a Vector3.
  14121. */
  14122. getAbsolutePosition(): Vector3;
  14123. /**
  14124. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14125. * @param absolutePosition the absolute position to set
  14126. * @returns the TransformNode.
  14127. */
  14128. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14129. /**
  14130. * Sets the mesh position in its local space.
  14131. * @param vector3 the position to set in localspace
  14132. * @returns the TransformNode.
  14133. */
  14134. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14135. /**
  14136. * Returns the mesh position in the local space from the current World matrix values.
  14137. * @returns a new Vector3.
  14138. */
  14139. getPositionExpressedInLocalSpace(): Vector3;
  14140. /**
  14141. * Translates the mesh along the passed Vector3 in its local space.
  14142. * @param vector3 the distance to translate in localspace
  14143. * @returns the TransformNode.
  14144. */
  14145. locallyTranslate(vector3: Vector3): TransformNode;
  14146. private static _lookAtVectorCache;
  14147. /**
  14148. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14149. * @param targetPoint the position (must be in same space as current mesh) to look at
  14150. * @param yawCor optional yaw (y-axis) correction in radians
  14151. * @param pitchCor optional pitch (x-axis) correction in radians
  14152. * @param rollCor optional roll (z-axis) correction in radians
  14153. * @param space the choosen space of the target
  14154. * @returns the TransformNode.
  14155. */
  14156. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14157. /**
  14158. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14159. * This Vector3 is expressed in the World space.
  14160. * @param localAxis axis to rotate
  14161. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14162. */
  14163. getDirection(localAxis: Vector3): Vector3;
  14164. /**
  14165. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14166. * localAxis is expressed in the mesh local space.
  14167. * result is computed in the Wordl space from the mesh World matrix.
  14168. * @param localAxis axis to rotate
  14169. * @param result the resulting transformnode
  14170. * @returns this TransformNode.
  14171. */
  14172. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14173. /**
  14174. * Sets this transform node rotation to the given local axis.
  14175. * @param localAxis the axis in local space
  14176. * @param yawCor optional yaw (y-axis) correction in radians
  14177. * @param pitchCor optional pitch (x-axis) correction in radians
  14178. * @param rollCor optional roll (z-axis) correction in radians
  14179. * @returns this TransformNode
  14180. */
  14181. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14182. /**
  14183. * Sets a new pivot point to the current node
  14184. * @param point defines the new pivot point to use
  14185. * @param space defines if the point is in world or local space (local by default)
  14186. * @returns the current TransformNode
  14187. */
  14188. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14189. /**
  14190. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14191. * @returns the pivot point
  14192. */
  14193. getPivotPoint(): Vector3;
  14194. /**
  14195. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14196. * @param result the vector3 to store the result
  14197. * @returns this TransformNode.
  14198. */
  14199. getPivotPointToRef(result: Vector3): TransformNode;
  14200. /**
  14201. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14202. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14203. */
  14204. getAbsolutePivotPoint(): Vector3;
  14205. /**
  14206. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14207. * @param result vector3 to store the result
  14208. * @returns this TransformNode.
  14209. */
  14210. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14211. /**
  14212. * Defines the passed node as the parent of the current node.
  14213. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14214. * @see https://doc.babylonjs.com/how_to/parenting
  14215. * @param node the node ot set as the parent
  14216. * @returns this TransformNode.
  14217. */
  14218. setParent(node: Nullable<Node>): TransformNode;
  14219. private _nonUniformScaling;
  14220. /**
  14221. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14222. */
  14223. readonly nonUniformScaling: boolean;
  14224. /** @hidden */
  14225. _updateNonUniformScalingState(value: boolean): boolean;
  14226. /**
  14227. * Attach the current TransformNode to another TransformNode associated with a bone
  14228. * @param bone Bone affecting the TransformNode
  14229. * @param affectedTransformNode TransformNode associated with the bone
  14230. * @returns this object
  14231. */
  14232. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14233. /**
  14234. * Detach the transform node if its associated with a bone
  14235. * @returns this object
  14236. */
  14237. detachFromBone(): TransformNode;
  14238. private static _rotationAxisCache;
  14239. /**
  14240. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14241. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14242. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14243. * The passed axis is also normalized.
  14244. * @param axis the axis to rotate around
  14245. * @param amount the amount to rotate in radians
  14246. * @param space Space to rotate in (Default: local)
  14247. * @returns the TransformNode.
  14248. */
  14249. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14250. /**
  14251. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14252. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14253. * The passed axis is also normalized. .
  14254. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14255. * @param point the point to rotate around
  14256. * @param axis the axis to rotate around
  14257. * @param amount the amount to rotate in radians
  14258. * @returns the TransformNode
  14259. */
  14260. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14261. /**
  14262. * Translates the mesh along the axis vector for the passed distance in the given space.
  14263. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14264. * @param axis the axis to translate in
  14265. * @param distance the distance to translate
  14266. * @param space Space to rotate in (Default: local)
  14267. * @returns the TransformNode.
  14268. */
  14269. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14270. /**
  14271. * Adds a rotation step to the mesh current rotation.
  14272. * x, y, z are Euler angles expressed in radians.
  14273. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14274. * This means this rotation is made in the mesh local space only.
  14275. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14276. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14277. * ```javascript
  14278. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14279. * ```
  14280. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14281. * 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.
  14282. * @param x Rotation to add
  14283. * @param y Rotation to add
  14284. * @param z Rotation to add
  14285. * @returns the TransformNode.
  14286. */
  14287. addRotation(x: number, y: number, z: number): TransformNode;
  14288. /**
  14289. * @hidden
  14290. */
  14291. protected _getEffectiveParent(): Nullable<Node>;
  14292. /**
  14293. * Computes the world matrix of the node
  14294. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14295. * @returns the world matrix
  14296. */
  14297. computeWorldMatrix(force?: boolean): Matrix;
  14298. protected _afterComputeWorldMatrix(): void;
  14299. /**
  14300. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14301. * @param func callback function to add
  14302. *
  14303. * @returns the TransformNode.
  14304. */
  14305. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14306. /**
  14307. * Removes a registered callback function.
  14308. * @param func callback function to remove
  14309. * @returns the TransformNode.
  14310. */
  14311. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14312. /**
  14313. * Gets the position of the current mesh in camera space
  14314. * @param camera defines the camera to use
  14315. * @returns a position
  14316. */
  14317. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14318. /**
  14319. * Returns the distance from the mesh to the active camera
  14320. * @param camera defines the camera to use
  14321. * @returns the distance
  14322. */
  14323. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14324. /**
  14325. * Clone the current transform node
  14326. * @param name Name of the new clone
  14327. * @param newParent New parent for the clone
  14328. * @param doNotCloneChildren Do not clone children hierarchy
  14329. * @returns the new transform node
  14330. */
  14331. clone(name: string, newParent: Node, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14332. /**
  14333. * Serializes the objects information.
  14334. * @param currentSerializationObject defines the object to serialize in
  14335. * @returns the serialized object
  14336. */
  14337. serialize(currentSerializationObject?: any): any;
  14338. /**
  14339. * Returns a new TransformNode object parsed from the source provided.
  14340. * @param parsedTransformNode is the source.
  14341. * @param scene the scne the object belongs to
  14342. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14343. * @returns a new TransformNode object parsed from the source provided.
  14344. */
  14345. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14346. /**
  14347. * Get all child-transformNodes of this node
  14348. * @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
  14349. * @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
  14350. * @returns an array of TransformNode
  14351. */
  14352. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14353. /**
  14354. * Releases resources associated with this transform node.
  14355. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14356. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14357. */
  14358. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14359. /**
  14360. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14361. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14362. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14363. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14364. * @returns the current mesh
  14365. */
  14366. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14367. private _syncAbsoluteScalingAndRotation;
  14368. }
  14369. }
  14370. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14371. import { Observable } from "babylonjs/Misc/observable";
  14372. import { Nullable } from "babylonjs/types";
  14373. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14374. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14375. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14376. import { Ray } from "babylonjs/Culling/ray";
  14377. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14378. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14379. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14380. /**
  14381. * Defines the types of pose enabled controllers that are supported
  14382. */
  14383. export enum PoseEnabledControllerType {
  14384. /**
  14385. * HTC Vive
  14386. */
  14387. VIVE = 0,
  14388. /**
  14389. * Oculus Rift
  14390. */
  14391. OCULUS = 1,
  14392. /**
  14393. * Windows mixed reality
  14394. */
  14395. WINDOWS = 2,
  14396. /**
  14397. * Samsung gear VR
  14398. */
  14399. GEAR_VR = 3,
  14400. /**
  14401. * Google Daydream
  14402. */
  14403. DAYDREAM = 4,
  14404. /**
  14405. * Generic
  14406. */
  14407. GENERIC = 5
  14408. }
  14409. /**
  14410. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14411. */
  14412. export interface MutableGamepadButton {
  14413. /**
  14414. * Value of the button/trigger
  14415. */
  14416. value: number;
  14417. /**
  14418. * If the button/trigger is currently touched
  14419. */
  14420. touched: boolean;
  14421. /**
  14422. * If the button/trigger is currently pressed
  14423. */
  14424. pressed: boolean;
  14425. }
  14426. /**
  14427. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14428. * @hidden
  14429. */
  14430. export interface ExtendedGamepadButton extends GamepadButton {
  14431. /**
  14432. * If the button/trigger is currently pressed
  14433. */
  14434. readonly pressed: boolean;
  14435. /**
  14436. * If the button/trigger is currently touched
  14437. */
  14438. readonly touched: boolean;
  14439. /**
  14440. * Value of the button/trigger
  14441. */
  14442. readonly value: number;
  14443. }
  14444. /** @hidden */
  14445. export interface _GamePadFactory {
  14446. /**
  14447. * Returns wether or not the current gamepad can be created for this type of controller.
  14448. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14449. * @returns true if it can be created, otherwise false
  14450. */
  14451. canCreate(gamepadInfo: any): boolean;
  14452. /**
  14453. * Creates a new instance of the Gamepad.
  14454. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14455. * @returns the new gamepad instance
  14456. */
  14457. create(gamepadInfo: any): Gamepad;
  14458. }
  14459. /**
  14460. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14461. */
  14462. export class PoseEnabledControllerHelper {
  14463. /** @hidden */
  14464. static _ControllerFactories: _GamePadFactory[];
  14465. /** @hidden */
  14466. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14467. /**
  14468. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14469. * @param vrGamepad the gamepad to initialized
  14470. * @returns a vr controller of the type the gamepad identified as
  14471. */
  14472. static InitiateController(vrGamepad: any): Gamepad;
  14473. }
  14474. /**
  14475. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14476. */
  14477. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14478. /**
  14479. * If the controller is used in a webXR session
  14480. */
  14481. isXR: boolean;
  14482. private _deviceRoomPosition;
  14483. private _deviceRoomRotationQuaternion;
  14484. /**
  14485. * The device position in babylon space
  14486. */
  14487. devicePosition: Vector3;
  14488. /**
  14489. * The device rotation in babylon space
  14490. */
  14491. deviceRotationQuaternion: Quaternion;
  14492. /**
  14493. * The scale factor of the device in babylon space
  14494. */
  14495. deviceScaleFactor: number;
  14496. /**
  14497. * (Likely devicePosition should be used instead) The device position in its room space
  14498. */
  14499. position: Vector3;
  14500. /**
  14501. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14502. */
  14503. rotationQuaternion: Quaternion;
  14504. /**
  14505. * The type of controller (Eg. Windows mixed reality)
  14506. */
  14507. controllerType: PoseEnabledControllerType;
  14508. protected _calculatedPosition: Vector3;
  14509. private _calculatedRotation;
  14510. /**
  14511. * The raw pose from the device
  14512. */
  14513. rawPose: DevicePose;
  14514. private _trackPosition;
  14515. private _maxRotationDistFromHeadset;
  14516. private _draggedRoomRotation;
  14517. /**
  14518. * @hidden
  14519. */
  14520. _disableTrackPosition(fixedPosition: Vector3): void;
  14521. /**
  14522. * Internal, the mesh attached to the controller
  14523. * @hidden
  14524. */
  14525. _mesh: Nullable<AbstractMesh>;
  14526. private _poseControlledCamera;
  14527. private _leftHandSystemQuaternion;
  14528. /**
  14529. * Internal, matrix used to convert room space to babylon space
  14530. * @hidden
  14531. */
  14532. _deviceToWorld: Matrix;
  14533. /**
  14534. * Node to be used when casting a ray from the controller
  14535. * @hidden
  14536. */
  14537. _pointingPoseNode: Nullable<TransformNode>;
  14538. /**
  14539. * Name of the child mesh that can be used to cast a ray from the controller
  14540. */
  14541. static readonly POINTING_POSE: string;
  14542. /**
  14543. * Creates a new PoseEnabledController from a gamepad
  14544. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14545. */
  14546. constructor(browserGamepad: any);
  14547. private _workingMatrix;
  14548. /**
  14549. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14550. */
  14551. update(): void;
  14552. /**
  14553. * Updates only the pose device and mesh without doing any button event checking
  14554. */
  14555. protected _updatePoseAndMesh(): void;
  14556. /**
  14557. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14558. * @param poseData raw pose fromthe device
  14559. */
  14560. updateFromDevice(poseData: DevicePose): void;
  14561. /**
  14562. * @hidden
  14563. */
  14564. _meshAttachedObservable: Observable<AbstractMesh>;
  14565. /**
  14566. * Attaches a mesh to the controller
  14567. * @param mesh the mesh to be attached
  14568. */
  14569. attachToMesh(mesh: AbstractMesh): void;
  14570. /**
  14571. * Attaches the controllers mesh to a camera
  14572. * @param camera the camera the mesh should be attached to
  14573. */
  14574. attachToPoseControlledCamera(camera: TargetCamera): void;
  14575. /**
  14576. * Disposes of the controller
  14577. */
  14578. dispose(): void;
  14579. /**
  14580. * The mesh that is attached to the controller
  14581. */
  14582. readonly mesh: Nullable<AbstractMesh>;
  14583. /**
  14584. * Gets the ray of the controller in the direction the controller is pointing
  14585. * @param length the length the resulting ray should be
  14586. * @returns a ray in the direction the controller is pointing
  14587. */
  14588. getForwardRay(length?: number): Ray;
  14589. }
  14590. }
  14591. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14592. import { Observable } from "babylonjs/Misc/observable";
  14593. import { Scene } from "babylonjs/scene";
  14594. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14595. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14596. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14597. /**
  14598. * Defines the WebVRController object that represents controllers tracked in 3D space
  14599. */
  14600. export abstract class WebVRController extends PoseEnabledController {
  14601. /**
  14602. * Internal, the default controller model for the controller
  14603. */
  14604. protected _defaultModel: AbstractMesh;
  14605. /**
  14606. * Fired when the trigger state has changed
  14607. */
  14608. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14609. /**
  14610. * Fired when the main button state has changed
  14611. */
  14612. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14613. /**
  14614. * Fired when the secondary button state has changed
  14615. */
  14616. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14617. /**
  14618. * Fired when the pad state has changed
  14619. */
  14620. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14621. /**
  14622. * Fired when controllers stick values have changed
  14623. */
  14624. onPadValuesChangedObservable: Observable<StickValues>;
  14625. /**
  14626. * Array of button availible on the controller
  14627. */
  14628. protected _buttons: Array<MutableGamepadButton>;
  14629. private _onButtonStateChange;
  14630. /**
  14631. * Fired when a controller button's state has changed
  14632. * @param callback the callback containing the button that was modified
  14633. */
  14634. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14635. /**
  14636. * X and Y axis corresponding to the controllers joystick
  14637. */
  14638. pad: StickValues;
  14639. /**
  14640. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14641. */
  14642. hand: string;
  14643. /**
  14644. * The default controller model for the controller
  14645. */
  14646. readonly defaultModel: AbstractMesh;
  14647. /**
  14648. * Creates a new WebVRController from a gamepad
  14649. * @param vrGamepad the gamepad that the WebVRController should be created from
  14650. */
  14651. constructor(vrGamepad: any);
  14652. /**
  14653. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14654. */
  14655. update(): void;
  14656. /**
  14657. * Function to be called when a button is modified
  14658. */
  14659. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14660. /**
  14661. * Loads a mesh and attaches it to the controller
  14662. * @param scene the scene the mesh should be added to
  14663. * @param meshLoaded callback for when the mesh has been loaded
  14664. */
  14665. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  14666. private _setButtonValue;
  14667. private _changes;
  14668. private _checkChanges;
  14669. /**
  14670. * Disposes of th webVRCOntroller
  14671. */
  14672. dispose(): void;
  14673. }
  14674. }
  14675. declare module "babylonjs/Lights/hemisphericLight" {
  14676. import { Nullable } from "babylonjs/types";
  14677. import { Scene } from "babylonjs/scene";
  14678. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14679. import { Color3 } from "babylonjs/Maths/math.color";
  14680. import { Effect } from "babylonjs/Materials/effect";
  14681. import { Light } from "babylonjs/Lights/light";
  14682. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  14683. /**
  14684. * The HemisphericLight simulates the ambient environment light,
  14685. * so the passed direction is the light reflection direction, not the incoming direction.
  14686. */
  14687. export class HemisphericLight extends Light {
  14688. /**
  14689. * The groundColor is the light in the opposite direction to the one specified during creation.
  14690. * 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.
  14691. */
  14692. groundColor: Color3;
  14693. /**
  14694. * The light reflection direction, not the incoming direction.
  14695. */
  14696. direction: Vector3;
  14697. /**
  14698. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  14699. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  14700. * The HemisphericLight can't cast shadows.
  14701. * Documentation : https://doc.babylonjs.com/babylon101/lights
  14702. * @param name The friendly name of the light
  14703. * @param direction The direction of the light reflection
  14704. * @param scene The scene the light belongs to
  14705. */
  14706. constructor(name: string, direction: Vector3, scene: Scene);
  14707. protected _buildUniformLayout(): void;
  14708. /**
  14709. * Returns the string "HemisphericLight".
  14710. * @return The class name
  14711. */
  14712. getClassName(): string;
  14713. /**
  14714. * Sets the HemisphericLight direction towards the passed target (Vector3).
  14715. * Returns the updated direction.
  14716. * @param target The target the direction should point to
  14717. * @return The computed direction
  14718. */
  14719. setDirectionToTarget(target: Vector3): Vector3;
  14720. /**
  14721. * Returns the shadow generator associated to the light.
  14722. * @returns Always null for hemispheric lights because it does not support shadows.
  14723. */
  14724. getShadowGenerator(): Nullable<IShadowGenerator>;
  14725. /**
  14726. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  14727. * @param effect The effect to update
  14728. * @param lightIndex The index of the light in the effect to update
  14729. * @returns The hemispheric light
  14730. */
  14731. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  14732. /**
  14733. * Computes the world matrix of the node
  14734. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14735. * @param useWasUpdatedFlag defines a reserved property
  14736. * @returns the world matrix
  14737. */
  14738. computeWorldMatrix(): Matrix;
  14739. /**
  14740. * Returns the integer 3.
  14741. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  14742. */
  14743. getTypeID(): number;
  14744. /**
  14745. * Prepares the list of defines specific to the light type.
  14746. * @param defines the list of defines
  14747. * @param lightIndex defines the index of the light for the effect
  14748. */
  14749. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  14750. }
  14751. }
  14752. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  14753. /** @hidden */
  14754. export var vrMultiviewToSingleviewPixelShader: {
  14755. name: string;
  14756. shader: string;
  14757. };
  14758. }
  14759. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  14760. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14761. import { Scene } from "babylonjs/scene";
  14762. /**
  14763. * Renders to multiple views with a single draw call
  14764. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  14765. */
  14766. export class MultiviewRenderTarget extends RenderTargetTexture {
  14767. /**
  14768. * Creates a multiview render target
  14769. * @param scene scene used with the render target
  14770. * @param size the size of the render target (used for each view)
  14771. */
  14772. constructor(scene: Scene, size?: number | {
  14773. width: number;
  14774. height: number;
  14775. } | {
  14776. ratio: number;
  14777. });
  14778. /**
  14779. * @hidden
  14780. * @param faceIndex the face index, if its a cube texture
  14781. */
  14782. _bindFrameBuffer(faceIndex?: number): void;
  14783. /**
  14784. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  14785. * @returns the view count
  14786. */
  14787. getViewCount(): number;
  14788. }
  14789. }
  14790. declare module "babylonjs/Maths/math.frustum" {
  14791. import { Matrix } from "babylonjs/Maths/math.vector";
  14792. import { DeepImmutable } from "babylonjs/types";
  14793. import { Plane } from "babylonjs/Maths/math.plane";
  14794. /**
  14795. * Reprasents a camera frustum
  14796. */
  14797. export class Frustum {
  14798. /**
  14799. * Gets the planes representing the frustum
  14800. * @param transform matrix to be applied to the returned planes
  14801. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  14802. */
  14803. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  14804. /**
  14805. * Gets the near frustum plane transformed by the transform matrix
  14806. * @param transform transformation matrix to be applied to the resulting frustum plane
  14807. * @param frustumPlane the resuling frustum plane
  14808. */
  14809. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14810. /**
  14811. * Gets the far frustum plane transformed by the transform matrix
  14812. * @param transform transformation matrix to be applied to the resulting frustum plane
  14813. * @param frustumPlane the resuling frustum plane
  14814. */
  14815. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14816. /**
  14817. * Gets the left frustum plane transformed by the transform matrix
  14818. * @param transform transformation matrix to be applied to the resulting frustum plane
  14819. * @param frustumPlane the resuling frustum plane
  14820. */
  14821. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14822. /**
  14823. * Gets the right frustum plane transformed by the transform matrix
  14824. * @param transform transformation matrix to be applied to the resulting frustum plane
  14825. * @param frustumPlane the resuling frustum plane
  14826. */
  14827. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14828. /**
  14829. * Gets the top frustum plane transformed by the transform matrix
  14830. * @param transform transformation matrix to be applied to the resulting frustum plane
  14831. * @param frustumPlane the resuling frustum plane
  14832. */
  14833. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14834. /**
  14835. * Gets the bottom frustum plane transformed by the transform matrix
  14836. * @param transform transformation matrix to be applied to the resulting frustum plane
  14837. * @param frustumPlane the resuling frustum plane
  14838. */
  14839. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  14840. /**
  14841. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  14842. * @param transform transformation matrix to be applied to the resulting frustum planes
  14843. * @param frustumPlanes the resuling frustum planes
  14844. */
  14845. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  14846. }
  14847. }
  14848. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  14849. import { Camera } from "babylonjs/Cameras/camera";
  14850. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  14851. import { Nullable } from "babylonjs/types";
  14852. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14853. import { Matrix } from "babylonjs/Maths/math.vector";
  14854. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  14855. module "babylonjs/Engines/engine" {
  14856. interface Engine {
  14857. /**
  14858. * Creates a new multiview render target
  14859. * @param width defines the width of the texture
  14860. * @param height defines the height of the texture
  14861. * @returns the created multiview texture
  14862. */
  14863. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  14864. /**
  14865. * Binds a multiview framebuffer to be drawn to
  14866. * @param multiviewTexture texture to bind
  14867. */
  14868. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  14869. }
  14870. }
  14871. module "babylonjs/Cameras/camera" {
  14872. interface Camera {
  14873. /**
  14874. * @hidden
  14875. * 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)
  14876. */
  14877. _useMultiviewToSingleView: boolean;
  14878. /**
  14879. * @hidden
  14880. * 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)
  14881. */
  14882. _multiviewTexture: Nullable<RenderTargetTexture>;
  14883. /**
  14884. * @hidden
  14885. * ensures the multiview texture of the camera exists and has the specified width/height
  14886. * @param width height to set on the multiview texture
  14887. * @param height width to set on the multiview texture
  14888. */
  14889. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  14890. }
  14891. }
  14892. module "babylonjs/scene" {
  14893. interface Scene {
  14894. /** @hidden */
  14895. _transformMatrixR: Matrix;
  14896. /** @hidden */
  14897. _multiviewSceneUbo: Nullable<UniformBuffer>;
  14898. /** @hidden */
  14899. _createMultiviewUbo(): void;
  14900. /** @hidden */
  14901. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  14902. /** @hidden */
  14903. _renderMultiviewToSingleView(camera: Camera): void;
  14904. }
  14905. }
  14906. }
  14907. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  14908. import { Camera } from "babylonjs/Cameras/camera";
  14909. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  14910. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  14911. import "babylonjs/Engines/Extensions/engine.multiview";
  14912. /**
  14913. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  14914. * This will not be used for webXR as it supports displaying texture arrays directly
  14915. */
  14916. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  14917. /**
  14918. * Initializes a VRMultiviewToSingleview
  14919. * @param name name of the post process
  14920. * @param camera camera to be applied to
  14921. * @param scaleFactor scaling factor to the size of the output texture
  14922. */
  14923. constructor(name: string, camera: Camera, scaleFactor: number);
  14924. }
  14925. }
  14926. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  14927. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  14928. import { Nullable } from "babylonjs/types";
  14929. import { Size } from "babylonjs/Maths/math.size";
  14930. import { Observable } from "babylonjs/Misc/observable";
  14931. module "babylonjs/Engines/engine" {
  14932. interface Engine {
  14933. /** @hidden */
  14934. _vrDisplay: any;
  14935. /** @hidden */
  14936. _vrSupported: boolean;
  14937. /** @hidden */
  14938. _oldSize: Size;
  14939. /** @hidden */
  14940. _oldHardwareScaleFactor: number;
  14941. /** @hidden */
  14942. _vrExclusivePointerMode: boolean;
  14943. /** @hidden */
  14944. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  14945. /** @hidden */
  14946. _onVRDisplayPointerRestricted: () => void;
  14947. /** @hidden */
  14948. _onVRDisplayPointerUnrestricted: () => void;
  14949. /** @hidden */
  14950. _onVrDisplayConnect: Nullable<(display: any) => void>;
  14951. /** @hidden */
  14952. _onVrDisplayDisconnect: Nullable<() => void>;
  14953. /** @hidden */
  14954. _onVrDisplayPresentChange: Nullable<() => void>;
  14955. /**
  14956. * Observable signaled when VR display mode changes
  14957. */
  14958. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  14959. /**
  14960. * Observable signaled when VR request present is complete
  14961. */
  14962. onVRRequestPresentComplete: Observable<boolean>;
  14963. /**
  14964. * Observable signaled when VR request present starts
  14965. */
  14966. onVRRequestPresentStart: Observable<Engine>;
  14967. /**
  14968. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  14969. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  14970. */
  14971. isInVRExclusivePointerMode: boolean;
  14972. /**
  14973. * Gets a boolean indicating if a webVR device was detected
  14974. * @returns true if a webVR device was detected
  14975. */
  14976. isVRDevicePresent(): boolean;
  14977. /**
  14978. * Gets the current webVR device
  14979. * @returns the current webVR device (or null)
  14980. */
  14981. getVRDevice(): any;
  14982. /**
  14983. * Initializes a webVR display and starts listening to display change events
  14984. * The onVRDisplayChangedObservable will be notified upon these changes
  14985. * @returns A promise containing a VRDisplay and if vr is supported
  14986. */
  14987. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  14988. /** @hidden */
  14989. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  14990. /**
  14991. * Call this function to switch to webVR mode
  14992. * Will do nothing if webVR is not supported or if there is no webVR device
  14993. * @see http://doc.babylonjs.com/how_to/webvr_camera
  14994. */
  14995. enableVR(): void;
  14996. /** @hidden */
  14997. _onVRFullScreenTriggered(): void;
  14998. }
  14999. }
  15000. }
  15001. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15002. import { Nullable } from "babylonjs/types";
  15003. import { Observable } from "babylonjs/Misc/observable";
  15004. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15005. import { Scene } from "babylonjs/scene";
  15006. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15007. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15008. import { Node } from "babylonjs/node";
  15009. import { Ray } from "babylonjs/Culling/ray";
  15010. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15011. import "babylonjs/Engines/Extensions/engine.webVR";
  15012. /**
  15013. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15014. * IMPORTANT!! The data is right-hand data.
  15015. * @export
  15016. * @interface DevicePose
  15017. */
  15018. export interface DevicePose {
  15019. /**
  15020. * The position of the device, values in array are [x,y,z].
  15021. */
  15022. readonly position: Nullable<Float32Array>;
  15023. /**
  15024. * The linearVelocity of the device, values in array are [x,y,z].
  15025. */
  15026. readonly linearVelocity: Nullable<Float32Array>;
  15027. /**
  15028. * The linearAcceleration of the device, values in array are [x,y,z].
  15029. */
  15030. readonly linearAcceleration: Nullable<Float32Array>;
  15031. /**
  15032. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15033. */
  15034. readonly orientation: Nullable<Float32Array>;
  15035. /**
  15036. * The angularVelocity of the device, values in array are [x,y,z].
  15037. */
  15038. readonly angularVelocity: Nullable<Float32Array>;
  15039. /**
  15040. * The angularAcceleration of the device, values in array are [x,y,z].
  15041. */
  15042. readonly angularAcceleration: Nullable<Float32Array>;
  15043. }
  15044. /**
  15045. * Interface representing a pose controlled object in Babylon.
  15046. * A pose controlled object has both regular pose values as well as pose values
  15047. * from an external device such as a VR head mounted display
  15048. */
  15049. export interface PoseControlled {
  15050. /**
  15051. * The position of the object in babylon space.
  15052. */
  15053. position: Vector3;
  15054. /**
  15055. * The rotation quaternion of the object in babylon space.
  15056. */
  15057. rotationQuaternion: Quaternion;
  15058. /**
  15059. * The position of the device in babylon space.
  15060. */
  15061. devicePosition?: Vector3;
  15062. /**
  15063. * The rotation quaternion of the device in babylon space.
  15064. */
  15065. deviceRotationQuaternion: Quaternion;
  15066. /**
  15067. * The raw pose coming from the device.
  15068. */
  15069. rawPose: Nullable<DevicePose>;
  15070. /**
  15071. * The scale of the device to be used when translating from device space to babylon space.
  15072. */
  15073. deviceScaleFactor: number;
  15074. /**
  15075. * Updates the poseControlled values based on the input device pose.
  15076. * @param poseData the pose data to update the object with
  15077. */
  15078. updateFromDevice(poseData: DevicePose): void;
  15079. }
  15080. /**
  15081. * Set of options to customize the webVRCamera
  15082. */
  15083. export interface WebVROptions {
  15084. /**
  15085. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15086. */
  15087. trackPosition?: boolean;
  15088. /**
  15089. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15090. */
  15091. positionScale?: number;
  15092. /**
  15093. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15094. */
  15095. displayName?: string;
  15096. /**
  15097. * Should the native controller meshes be initialized. (default: true)
  15098. */
  15099. controllerMeshes?: boolean;
  15100. /**
  15101. * Creating a default HemiLight only on controllers. (default: true)
  15102. */
  15103. defaultLightingOnControllers?: boolean;
  15104. /**
  15105. * If you don't want to use the default VR button of the helper. (default: false)
  15106. */
  15107. useCustomVRButton?: boolean;
  15108. /**
  15109. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15110. */
  15111. customVRButton?: HTMLButtonElement;
  15112. /**
  15113. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15114. */
  15115. rayLength?: number;
  15116. /**
  15117. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15118. */
  15119. defaultHeight?: number;
  15120. /**
  15121. * If multiview should be used if availible (default: false)
  15122. */
  15123. useMultiview?: boolean;
  15124. }
  15125. /**
  15126. * This represents a WebVR camera.
  15127. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15128. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15129. */
  15130. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15131. private webVROptions;
  15132. /**
  15133. * @hidden
  15134. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15135. */
  15136. _vrDevice: any;
  15137. /**
  15138. * The rawPose of the vrDevice.
  15139. */
  15140. rawPose: Nullable<DevicePose>;
  15141. private _onVREnabled;
  15142. private _specsVersion;
  15143. private _attached;
  15144. private _frameData;
  15145. protected _descendants: Array<Node>;
  15146. private _deviceRoomPosition;
  15147. /** @hidden */
  15148. _deviceRoomRotationQuaternion: Quaternion;
  15149. private _standingMatrix;
  15150. /**
  15151. * Represents device position in babylon space.
  15152. */
  15153. devicePosition: Vector3;
  15154. /**
  15155. * Represents device rotation in babylon space.
  15156. */
  15157. deviceRotationQuaternion: Quaternion;
  15158. /**
  15159. * The scale of the device to be used when translating from device space to babylon space.
  15160. */
  15161. deviceScaleFactor: number;
  15162. private _deviceToWorld;
  15163. private _worldToDevice;
  15164. /**
  15165. * References to the webVR controllers for the vrDevice.
  15166. */
  15167. controllers: Array<WebVRController>;
  15168. /**
  15169. * Emits an event when a controller is attached.
  15170. */
  15171. onControllersAttachedObservable: Observable<WebVRController[]>;
  15172. /**
  15173. * Emits an event when a controller's mesh has been loaded;
  15174. */
  15175. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15176. /**
  15177. * Emits an event when the HMD's pose has been updated.
  15178. */
  15179. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15180. private _poseSet;
  15181. /**
  15182. * If the rig cameras be used as parent instead of this camera.
  15183. */
  15184. rigParenting: boolean;
  15185. private _lightOnControllers;
  15186. private _defaultHeight?;
  15187. /**
  15188. * Instantiates a WebVRFreeCamera.
  15189. * @param name The name of the WebVRFreeCamera
  15190. * @param position The starting anchor position for the camera
  15191. * @param scene The scene the camera belongs to
  15192. * @param webVROptions a set of customizable options for the webVRCamera
  15193. */
  15194. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15195. /**
  15196. * Gets the device distance from the ground in meters.
  15197. * @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.
  15198. */
  15199. deviceDistanceToRoomGround(): number;
  15200. /**
  15201. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15202. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15203. */
  15204. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15205. /**
  15206. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15207. * @returns A promise with a boolean set to if the standing matrix is supported.
  15208. */
  15209. useStandingMatrixAsync(): Promise<boolean>;
  15210. /**
  15211. * Disposes the camera
  15212. */
  15213. dispose(): void;
  15214. /**
  15215. * Gets a vrController by name.
  15216. * @param name The name of the controller to retreive
  15217. * @returns the controller matching the name specified or null if not found
  15218. */
  15219. getControllerByName(name: string): Nullable<WebVRController>;
  15220. private _leftController;
  15221. /**
  15222. * The controller corresponding to the users left hand.
  15223. */
  15224. readonly leftController: Nullable<WebVRController>;
  15225. private _rightController;
  15226. /**
  15227. * The controller corresponding to the users right hand.
  15228. */
  15229. readonly rightController: Nullable<WebVRController>;
  15230. /**
  15231. * Casts a ray forward from the vrCamera's gaze.
  15232. * @param length Length of the ray (default: 100)
  15233. * @returns the ray corresponding to the gaze
  15234. */
  15235. getForwardRay(length?: number): Ray;
  15236. /**
  15237. * @hidden
  15238. * Updates the camera based on device's frame data
  15239. */
  15240. _checkInputs(): void;
  15241. /**
  15242. * Updates the poseControlled values based on the input device pose.
  15243. * @param poseData Pose coming from the device
  15244. */
  15245. updateFromDevice(poseData: DevicePose): void;
  15246. private _htmlElementAttached;
  15247. private _detachIfAttached;
  15248. /**
  15249. * WebVR's attach control will start broadcasting frames to the device.
  15250. * Note that in certain browsers (chrome for example) this function must be called
  15251. * within a user-interaction callback. Example:
  15252. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15253. *
  15254. * @param element html element to attach the vrDevice to
  15255. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15256. */
  15257. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15258. /**
  15259. * Detaches the camera from the html element and disables VR
  15260. *
  15261. * @param element html element to detach from
  15262. */
  15263. detachControl(element: HTMLElement): void;
  15264. /**
  15265. * @returns the name of this class
  15266. */
  15267. getClassName(): string;
  15268. /**
  15269. * Calls resetPose on the vrDisplay
  15270. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15271. */
  15272. resetToCurrentRotation(): void;
  15273. /**
  15274. * @hidden
  15275. * Updates the rig cameras (left and right eye)
  15276. */
  15277. _updateRigCameras(): void;
  15278. private _workingVector;
  15279. private _oneVector;
  15280. private _workingMatrix;
  15281. private updateCacheCalled;
  15282. private _correctPositionIfNotTrackPosition;
  15283. /**
  15284. * @hidden
  15285. * Updates the cached values of the camera
  15286. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15287. */
  15288. _updateCache(ignoreParentClass?: boolean): void;
  15289. /**
  15290. * @hidden
  15291. * Get current device position in babylon world
  15292. */
  15293. _computeDevicePosition(): void;
  15294. /**
  15295. * Updates the current device position and rotation in the babylon world
  15296. */
  15297. update(): void;
  15298. /**
  15299. * @hidden
  15300. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15301. * @returns an identity matrix
  15302. */
  15303. _getViewMatrix(): Matrix;
  15304. private _tmpMatrix;
  15305. /**
  15306. * This function is called by the two RIG cameras.
  15307. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15308. * @hidden
  15309. */
  15310. _getWebVRViewMatrix(): Matrix;
  15311. /** @hidden */
  15312. _getWebVRProjectionMatrix(): Matrix;
  15313. private _onGamepadConnectedObserver;
  15314. private _onGamepadDisconnectedObserver;
  15315. private _updateCacheWhenTrackingDisabledObserver;
  15316. /**
  15317. * Initializes the controllers and their meshes
  15318. */
  15319. initControllers(): void;
  15320. }
  15321. }
  15322. declare module "babylonjs/PostProcesses/postProcess" {
  15323. import { Nullable } from "babylonjs/types";
  15324. import { SmartArray } from "babylonjs/Misc/smartArray";
  15325. import { Observable } from "babylonjs/Misc/observable";
  15326. import { Vector2 } from "babylonjs/Maths/math.vector";
  15327. import { Camera } from "babylonjs/Cameras/camera";
  15328. import { Effect } from "babylonjs/Materials/effect";
  15329. import "babylonjs/Shaders/postprocess.vertex";
  15330. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15331. import { Engine } from "babylonjs/Engines/engine";
  15332. import { Color4 } from "babylonjs/Maths/math.color";
  15333. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15334. /**
  15335. * Size options for a post process
  15336. */
  15337. export type PostProcessOptions = {
  15338. width: number;
  15339. height: number;
  15340. };
  15341. /**
  15342. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15343. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15344. */
  15345. export class PostProcess {
  15346. /** Name of the PostProcess. */
  15347. name: string;
  15348. /**
  15349. * Gets or sets the unique id of the post process
  15350. */
  15351. uniqueId: number;
  15352. /**
  15353. * Width of the texture to apply the post process on
  15354. */
  15355. width: number;
  15356. /**
  15357. * Height of the texture to apply the post process on
  15358. */
  15359. height: number;
  15360. /**
  15361. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15362. * @hidden
  15363. */
  15364. _outputTexture: Nullable<InternalTexture>;
  15365. /**
  15366. * Sampling mode used by the shader
  15367. * See https://doc.babylonjs.com/classes/3.1/texture
  15368. */
  15369. renderTargetSamplingMode: number;
  15370. /**
  15371. * Clear color to use when screen clearing
  15372. */
  15373. clearColor: Color4;
  15374. /**
  15375. * If the buffer needs to be cleared before applying the post process. (default: true)
  15376. * Should be set to false if shader will overwrite all previous pixels.
  15377. */
  15378. autoClear: boolean;
  15379. /**
  15380. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15381. */
  15382. alphaMode: number;
  15383. /**
  15384. * Sets the setAlphaBlendConstants of the babylon engine
  15385. */
  15386. alphaConstants: Color4;
  15387. /**
  15388. * Animations to be used for the post processing
  15389. */
  15390. animations: import("babylonjs/Animations/animation").Animation[];
  15391. /**
  15392. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15393. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15394. */
  15395. enablePixelPerfectMode: boolean;
  15396. /**
  15397. * Force the postprocess to be applied without taking in account viewport
  15398. */
  15399. forceFullscreenViewport: boolean;
  15400. /**
  15401. * List of inspectable custom properties (used by the Inspector)
  15402. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15403. */
  15404. inspectableCustomProperties: IInspectable[];
  15405. /**
  15406. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15407. *
  15408. * | Value | Type | Description |
  15409. * | ----- | ----------------------------------- | ----------- |
  15410. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15411. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15412. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15413. *
  15414. */
  15415. scaleMode: number;
  15416. /**
  15417. * Force textures to be a power of two (default: false)
  15418. */
  15419. alwaysForcePOT: boolean;
  15420. private _samples;
  15421. /**
  15422. * Number of sample textures (default: 1)
  15423. */
  15424. samples: number;
  15425. /**
  15426. * Modify the scale of the post process to be the same as the viewport (default: false)
  15427. */
  15428. adaptScaleToCurrentViewport: boolean;
  15429. private _camera;
  15430. private _scene;
  15431. private _engine;
  15432. private _options;
  15433. private _reusable;
  15434. private _textureType;
  15435. /**
  15436. * Smart array of input and output textures for the post process.
  15437. * @hidden
  15438. */
  15439. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15440. /**
  15441. * The index in _textures that corresponds to the output texture.
  15442. * @hidden
  15443. */
  15444. _currentRenderTextureInd: number;
  15445. private _effect;
  15446. private _samplers;
  15447. private _fragmentUrl;
  15448. private _vertexUrl;
  15449. private _parameters;
  15450. private _scaleRatio;
  15451. protected _indexParameters: any;
  15452. private _shareOutputWithPostProcess;
  15453. private _texelSize;
  15454. private _forcedOutputTexture;
  15455. /**
  15456. * Returns the fragment url or shader name used in the post process.
  15457. * @returns the fragment url or name in the shader store.
  15458. */
  15459. getEffectName(): string;
  15460. /**
  15461. * An event triggered when the postprocess is activated.
  15462. */
  15463. onActivateObservable: Observable<Camera>;
  15464. private _onActivateObserver;
  15465. /**
  15466. * A function that is added to the onActivateObservable
  15467. */
  15468. onActivate: Nullable<(camera: Camera) => void>;
  15469. /**
  15470. * An event triggered when the postprocess changes its size.
  15471. */
  15472. onSizeChangedObservable: Observable<PostProcess>;
  15473. private _onSizeChangedObserver;
  15474. /**
  15475. * A function that is added to the onSizeChangedObservable
  15476. */
  15477. onSizeChanged: (postProcess: PostProcess) => void;
  15478. /**
  15479. * An event triggered when the postprocess applies its effect.
  15480. */
  15481. onApplyObservable: Observable<Effect>;
  15482. private _onApplyObserver;
  15483. /**
  15484. * A function that is added to the onApplyObservable
  15485. */
  15486. onApply: (effect: Effect) => void;
  15487. /**
  15488. * An event triggered before rendering the postprocess
  15489. */
  15490. onBeforeRenderObservable: Observable<Effect>;
  15491. private _onBeforeRenderObserver;
  15492. /**
  15493. * A function that is added to the onBeforeRenderObservable
  15494. */
  15495. onBeforeRender: (effect: Effect) => void;
  15496. /**
  15497. * An event triggered after rendering the postprocess
  15498. */
  15499. onAfterRenderObservable: Observable<Effect>;
  15500. private _onAfterRenderObserver;
  15501. /**
  15502. * A function that is added to the onAfterRenderObservable
  15503. */
  15504. onAfterRender: (efect: Effect) => void;
  15505. /**
  15506. * 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
  15507. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15508. */
  15509. inputTexture: InternalTexture;
  15510. /**
  15511. * Gets the camera which post process is applied to.
  15512. * @returns The camera the post process is applied to.
  15513. */
  15514. getCamera(): Camera;
  15515. /**
  15516. * Gets the texel size of the postprocess.
  15517. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15518. */
  15519. readonly texelSize: Vector2;
  15520. /**
  15521. * Creates a new instance PostProcess
  15522. * @param name The name of the PostProcess.
  15523. * @param fragmentUrl The url of the fragment shader to be used.
  15524. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15525. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15526. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15527. * @param camera The camera to apply the render pass to.
  15528. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15529. * @param engine The engine which the post process will be applied. (default: current engine)
  15530. * @param reusable If the post process can be reused on the same frame. (default: false)
  15531. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15532. * @param textureType Type of textures used when performing the post process. (default: 0)
  15533. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15534. * @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
  15535. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15536. */
  15537. constructor(
  15538. /** Name of the PostProcess. */
  15539. 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);
  15540. /**
  15541. * Gets a string idenfifying the name of the class
  15542. * @returns "PostProcess" string
  15543. */
  15544. getClassName(): string;
  15545. /**
  15546. * Gets the engine which this post process belongs to.
  15547. * @returns The engine the post process was enabled with.
  15548. */
  15549. getEngine(): Engine;
  15550. /**
  15551. * The effect that is created when initializing the post process.
  15552. * @returns The created effect corresponding the the postprocess.
  15553. */
  15554. getEffect(): Effect;
  15555. /**
  15556. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15557. * @param postProcess The post process to share the output with.
  15558. * @returns This post process.
  15559. */
  15560. shareOutputWith(postProcess: PostProcess): PostProcess;
  15561. /**
  15562. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15563. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15564. */
  15565. useOwnOutput(): void;
  15566. /**
  15567. * Updates the effect with the current post process compile time values and recompiles the shader.
  15568. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15569. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15570. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15571. * @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
  15572. * @param onCompiled Called when the shader has been compiled.
  15573. * @param onError Called if there is an error when compiling a shader.
  15574. */
  15575. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15576. /**
  15577. * The post process is reusable if it can be used multiple times within one frame.
  15578. * @returns If the post process is reusable
  15579. */
  15580. isReusable(): boolean;
  15581. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15582. markTextureDirty(): void;
  15583. /**
  15584. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15585. * 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.
  15586. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15587. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15588. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15589. * @returns The target texture that was bound to be written to.
  15590. */
  15591. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15592. /**
  15593. * If the post process is supported.
  15594. */
  15595. readonly isSupported: boolean;
  15596. /**
  15597. * The aspect ratio of the output texture.
  15598. */
  15599. readonly aspectRatio: number;
  15600. /**
  15601. * Get a value indicating if the post-process is ready to be used
  15602. * @returns true if the post-process is ready (shader is compiled)
  15603. */
  15604. isReady(): boolean;
  15605. /**
  15606. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15607. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15608. */
  15609. apply(): Nullable<Effect>;
  15610. private _disposeTextures;
  15611. /**
  15612. * Disposes the post process.
  15613. * @param camera The camera to dispose the post process on.
  15614. */
  15615. dispose(camera?: Camera): void;
  15616. }
  15617. }
  15618. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15619. /** @hidden */
  15620. export var kernelBlurVaryingDeclaration: {
  15621. name: string;
  15622. shader: string;
  15623. };
  15624. }
  15625. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15626. /** @hidden */
  15627. export var kernelBlurFragment: {
  15628. name: string;
  15629. shader: string;
  15630. };
  15631. }
  15632. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15633. /** @hidden */
  15634. export var kernelBlurFragment2: {
  15635. name: string;
  15636. shader: string;
  15637. };
  15638. }
  15639. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  15640. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15641. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  15642. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  15643. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  15644. /** @hidden */
  15645. export var kernelBlurPixelShader: {
  15646. name: string;
  15647. shader: string;
  15648. };
  15649. }
  15650. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  15651. /** @hidden */
  15652. export var kernelBlurVertex: {
  15653. name: string;
  15654. shader: string;
  15655. };
  15656. }
  15657. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  15658. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15659. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  15660. /** @hidden */
  15661. export var kernelBlurVertexShader: {
  15662. name: string;
  15663. shader: string;
  15664. };
  15665. }
  15666. declare module "babylonjs/PostProcesses/blurPostProcess" {
  15667. import { Vector2 } from "babylonjs/Maths/math.vector";
  15668. import { Nullable } from "babylonjs/types";
  15669. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  15670. import { Camera } from "babylonjs/Cameras/camera";
  15671. import { Effect } from "babylonjs/Materials/effect";
  15672. import { Engine } from "babylonjs/Engines/engine";
  15673. import "babylonjs/Shaders/kernelBlur.fragment";
  15674. import "babylonjs/Shaders/kernelBlur.vertex";
  15675. /**
  15676. * The Blur Post Process which blurs an image based on a kernel and direction.
  15677. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  15678. */
  15679. export class BlurPostProcess extends PostProcess {
  15680. /** The direction in which to blur the image. */
  15681. direction: Vector2;
  15682. private blockCompilation;
  15683. protected _kernel: number;
  15684. protected _idealKernel: number;
  15685. protected _packedFloat: boolean;
  15686. private _staticDefines;
  15687. /**
  15688. * Sets the length in pixels of the blur sample region
  15689. */
  15690. /**
  15691. * Gets the length in pixels of the blur sample region
  15692. */
  15693. kernel: number;
  15694. /**
  15695. * Sets wether or not the blur needs to unpack/repack floats
  15696. */
  15697. /**
  15698. * Gets wether or not the blur is unpacking/repacking floats
  15699. */
  15700. packedFloat: boolean;
  15701. /**
  15702. * Creates a new instance BlurPostProcess
  15703. * @param name The name of the effect.
  15704. * @param direction The direction in which to blur the image.
  15705. * @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.
  15706. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15707. * @param camera The camera to apply the render pass to.
  15708. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15709. * @param engine The engine which the post process will be applied. (default: current engine)
  15710. * @param reusable If the post process can be reused on the same frame. (default: false)
  15711. * @param textureType Type of textures used when performing the post process. (default: 0)
  15712. * @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)
  15713. */
  15714. constructor(name: string,
  15715. /** The direction in which to blur the image. */
  15716. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  15717. /**
  15718. * Updates the effect with the current post process compile time values and recompiles the shader.
  15719. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15720. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15721. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15722. * @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
  15723. * @param onCompiled Called when the shader has been compiled.
  15724. * @param onError Called if there is an error when compiling a shader.
  15725. */
  15726. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15727. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15728. /**
  15729. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  15730. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  15731. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  15732. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  15733. * The gaps between physical kernels are compensated for in the weighting of the samples
  15734. * @param idealKernel Ideal blur kernel.
  15735. * @return Nearest best kernel.
  15736. */
  15737. protected _nearestBestKernel(idealKernel: number): number;
  15738. /**
  15739. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  15740. * @param x The point on the Gaussian distribution to sample.
  15741. * @return the value of the Gaussian function at x.
  15742. */
  15743. protected _gaussianWeight(x: number): number;
  15744. /**
  15745. * Generates a string that can be used as a floating point number in GLSL.
  15746. * @param x Value to print.
  15747. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  15748. * @return GLSL float string.
  15749. */
  15750. protected _glslFloat(x: number, decimalFigures?: number): string;
  15751. }
  15752. }
  15753. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  15754. import { Scene } from "babylonjs/scene";
  15755. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15756. import { Plane } from "babylonjs/Maths/math.plane";
  15757. /**
  15758. * Mirror texture can be used to simulate the view from a mirror in a scene.
  15759. * It will dynamically be rendered every frame to adapt to the camera point of view.
  15760. * You can then easily use it as a reflectionTexture on a flat surface.
  15761. * In case the surface is not a plane, please consider relying on reflection probes.
  15762. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15763. */
  15764. export class MirrorTexture extends RenderTargetTexture {
  15765. private scene;
  15766. /**
  15767. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  15768. * 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.
  15769. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15770. */
  15771. mirrorPlane: Plane;
  15772. /**
  15773. * Define the blur ratio used to blur the reflection if needed.
  15774. */
  15775. blurRatio: number;
  15776. /**
  15777. * Define the adaptive blur kernel used to blur the reflection if needed.
  15778. * This will autocompute the closest best match for the `blurKernel`
  15779. */
  15780. adaptiveBlurKernel: number;
  15781. /**
  15782. * Define the blur kernel used to blur the reflection if needed.
  15783. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  15784. */
  15785. blurKernel: number;
  15786. /**
  15787. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  15788. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  15789. */
  15790. blurKernelX: number;
  15791. /**
  15792. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  15793. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  15794. */
  15795. blurKernelY: number;
  15796. private _autoComputeBlurKernel;
  15797. protected _onRatioRescale(): void;
  15798. private _updateGammaSpace;
  15799. private _imageProcessingConfigChangeObserver;
  15800. private _transformMatrix;
  15801. private _mirrorMatrix;
  15802. private _savedViewMatrix;
  15803. private _blurX;
  15804. private _blurY;
  15805. private _adaptiveBlurKernel;
  15806. private _blurKernelX;
  15807. private _blurKernelY;
  15808. private _blurRatio;
  15809. /**
  15810. * Instantiates a Mirror Texture.
  15811. * Mirror texture can be used to simulate the view from a mirror in a scene.
  15812. * It will dynamically be rendered every frame to adapt to the camera point of view.
  15813. * You can then easily use it as a reflectionTexture on a flat surface.
  15814. * In case the surface is not a plane, please consider relying on reflection probes.
  15815. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15816. * @param name
  15817. * @param size
  15818. * @param scene
  15819. * @param generateMipMaps
  15820. * @param type
  15821. * @param samplingMode
  15822. * @param generateDepthBuffer
  15823. */
  15824. constructor(name: string, size: number | {
  15825. width: number;
  15826. height: number;
  15827. } | {
  15828. ratio: number;
  15829. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  15830. private _preparePostProcesses;
  15831. /**
  15832. * Clone the mirror texture.
  15833. * @returns the cloned texture
  15834. */
  15835. clone(): MirrorTexture;
  15836. /**
  15837. * Serialize the texture to a JSON representation you could use in Parse later on
  15838. * @returns the serialized JSON representation
  15839. */
  15840. serialize(): any;
  15841. /**
  15842. * Dispose the texture and release its associated resources.
  15843. */
  15844. dispose(): void;
  15845. }
  15846. }
  15847. declare module "babylonjs/Materials/Textures/texture" {
  15848. import { Observable } from "babylonjs/Misc/observable";
  15849. import { Nullable } from "babylonjs/types";
  15850. import { Scene } from "babylonjs/scene";
  15851. import { Matrix } from "babylonjs/Maths/math.vector";
  15852. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  15853. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15854. import { Engine } from "babylonjs/Engines/engine";
  15855. /**
  15856. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  15857. * @see http://doc.babylonjs.com/babylon101/materials#texture
  15858. */
  15859. export class Texture extends BaseTexture {
  15860. /** @hidden */
  15861. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  15862. /** @hidden */
  15863. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  15864. /** @hidden */
  15865. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  15866. /** nearest is mag = nearest and min = nearest and mip = linear */
  15867. static readonly NEAREST_SAMPLINGMODE: number;
  15868. /** nearest is mag = nearest and min = nearest and mip = linear */
  15869. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  15870. /** Bilinear is mag = linear and min = linear and mip = nearest */
  15871. static readonly BILINEAR_SAMPLINGMODE: number;
  15872. /** Bilinear is mag = linear and min = linear and mip = nearest */
  15873. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  15874. /** Trilinear is mag = linear and min = linear and mip = linear */
  15875. static readonly TRILINEAR_SAMPLINGMODE: number;
  15876. /** Trilinear is mag = linear and min = linear and mip = linear */
  15877. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  15878. /** mag = nearest and min = nearest and mip = nearest */
  15879. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  15880. /** mag = nearest and min = linear and mip = nearest */
  15881. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  15882. /** mag = nearest and min = linear and mip = linear */
  15883. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  15884. /** mag = nearest and min = linear and mip = none */
  15885. static readonly NEAREST_LINEAR: number;
  15886. /** mag = nearest and min = nearest and mip = none */
  15887. static readonly NEAREST_NEAREST: number;
  15888. /** mag = linear and min = nearest and mip = nearest */
  15889. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  15890. /** mag = linear and min = nearest and mip = linear */
  15891. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  15892. /** mag = linear and min = linear and mip = none */
  15893. static readonly LINEAR_LINEAR: number;
  15894. /** mag = linear and min = nearest and mip = none */
  15895. static readonly LINEAR_NEAREST: number;
  15896. /** Explicit coordinates mode */
  15897. static readonly EXPLICIT_MODE: number;
  15898. /** Spherical coordinates mode */
  15899. static readonly SPHERICAL_MODE: number;
  15900. /** Planar coordinates mode */
  15901. static readonly PLANAR_MODE: number;
  15902. /** Cubic coordinates mode */
  15903. static readonly CUBIC_MODE: number;
  15904. /** Projection coordinates mode */
  15905. static readonly PROJECTION_MODE: number;
  15906. /** Inverse Cubic coordinates mode */
  15907. static readonly SKYBOX_MODE: number;
  15908. /** Inverse Cubic coordinates mode */
  15909. static readonly INVCUBIC_MODE: number;
  15910. /** Equirectangular coordinates mode */
  15911. static readonly EQUIRECTANGULAR_MODE: number;
  15912. /** Equirectangular Fixed coordinates mode */
  15913. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  15914. /** Equirectangular Fixed Mirrored coordinates mode */
  15915. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  15916. /** Texture is not repeating outside of 0..1 UVs */
  15917. static readonly CLAMP_ADDRESSMODE: number;
  15918. /** Texture is repeating outside of 0..1 UVs */
  15919. static readonly WRAP_ADDRESSMODE: number;
  15920. /** Texture is repeating and mirrored */
  15921. static readonly MIRROR_ADDRESSMODE: number;
  15922. /**
  15923. * 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
  15924. */
  15925. static UseSerializedUrlIfAny: boolean;
  15926. /**
  15927. * Define the url of the texture.
  15928. */
  15929. url: Nullable<string>;
  15930. /**
  15931. * Define an offset on the texture to offset the u coordinates of the UVs
  15932. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  15933. */
  15934. uOffset: number;
  15935. /**
  15936. * Define an offset on the texture to offset the v coordinates of the UVs
  15937. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  15938. */
  15939. vOffset: number;
  15940. /**
  15941. * Define an offset on the texture to scale the u coordinates of the UVs
  15942. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  15943. */
  15944. uScale: number;
  15945. /**
  15946. * Define an offset on the texture to scale the v coordinates of the UVs
  15947. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  15948. */
  15949. vScale: number;
  15950. /**
  15951. * Define an offset on the texture to rotate around the u coordinates of the UVs
  15952. * @see http://doc.babylonjs.com/how_to/more_materials
  15953. */
  15954. uAng: number;
  15955. /**
  15956. * Define an offset on the texture to rotate around the v coordinates of the UVs
  15957. * @see http://doc.babylonjs.com/how_to/more_materials
  15958. */
  15959. vAng: number;
  15960. /**
  15961. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  15962. * @see http://doc.babylonjs.com/how_to/more_materials
  15963. */
  15964. wAng: number;
  15965. /**
  15966. * Defines the center of rotation (U)
  15967. */
  15968. uRotationCenter: number;
  15969. /**
  15970. * Defines the center of rotation (V)
  15971. */
  15972. vRotationCenter: number;
  15973. /**
  15974. * Defines the center of rotation (W)
  15975. */
  15976. wRotationCenter: number;
  15977. /**
  15978. * Are mip maps generated for this texture or not.
  15979. */
  15980. readonly noMipmap: boolean;
  15981. /**
  15982. * List of inspectable custom properties (used by the Inspector)
  15983. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15984. */
  15985. inspectableCustomProperties: Nullable<IInspectable[]>;
  15986. private _noMipmap;
  15987. /** @hidden */
  15988. _invertY: boolean;
  15989. private _rowGenerationMatrix;
  15990. private _cachedTextureMatrix;
  15991. private _projectionModeMatrix;
  15992. private _t0;
  15993. private _t1;
  15994. private _t2;
  15995. private _cachedUOffset;
  15996. private _cachedVOffset;
  15997. private _cachedUScale;
  15998. private _cachedVScale;
  15999. private _cachedUAng;
  16000. private _cachedVAng;
  16001. private _cachedWAng;
  16002. private _cachedProjectionMatrixId;
  16003. private _cachedCoordinatesMode;
  16004. /** @hidden */
  16005. protected _initialSamplingMode: number;
  16006. /** @hidden */
  16007. _buffer: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>;
  16008. private _deleteBuffer;
  16009. protected _format: Nullable<number>;
  16010. private _delayedOnLoad;
  16011. private _delayedOnError;
  16012. /**
  16013. * Observable triggered once the texture has been loaded.
  16014. */
  16015. onLoadObservable: Observable<Texture>;
  16016. protected _isBlocking: boolean;
  16017. /**
  16018. * Is the texture preventing material to render while loading.
  16019. * If false, a default texture will be used instead of the loading one during the preparation step.
  16020. */
  16021. isBlocking: boolean;
  16022. /**
  16023. * Get the current sampling mode associated with the texture.
  16024. */
  16025. readonly samplingMode: number;
  16026. /**
  16027. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16028. */
  16029. readonly invertY: boolean;
  16030. /**
  16031. * Instantiates a new texture.
  16032. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16033. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16034. * @param url define the url of the picture to load as a texture
  16035. * @param scene define the scene or engine the texture will belong to
  16036. * @param noMipmap define if the texture will require mip maps or not
  16037. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16038. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16039. * @param onLoad define a callback triggered when the texture has been loaded
  16040. * @param onError define a callback triggered when an error occurred during the loading session
  16041. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16042. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16043. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16044. */
  16045. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | Engine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>, deleteBuffer?: boolean, format?: number);
  16046. /**
  16047. * Update the url (and optional buffer) of this texture if url was null during construction.
  16048. * @param url the url of the texture
  16049. * @param buffer the buffer of the texture (defaults to null)
  16050. * @param onLoad callback called when the texture is loaded (defaults to null)
  16051. */
  16052. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16053. /**
  16054. * Finish the loading sequence of a texture flagged as delayed load.
  16055. * @hidden
  16056. */
  16057. delayLoad(): void;
  16058. private _prepareRowForTextureGeneration;
  16059. /**
  16060. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16061. * @returns the transform matrix of the texture.
  16062. */
  16063. getTextureMatrix(): Matrix;
  16064. /**
  16065. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16066. * @returns The reflection texture transform
  16067. */
  16068. getReflectionTextureMatrix(): Matrix;
  16069. /**
  16070. * Clones the texture.
  16071. * @returns the cloned texture
  16072. */
  16073. clone(): Texture;
  16074. /**
  16075. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16076. * @returns The JSON representation of the texture
  16077. */
  16078. serialize(): any;
  16079. /**
  16080. * Get the current class name of the texture useful for serialization or dynamic coding.
  16081. * @returns "Texture"
  16082. */
  16083. getClassName(): string;
  16084. /**
  16085. * Dispose the texture and release its associated resources.
  16086. */
  16087. dispose(): void;
  16088. /**
  16089. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16090. * @param parsedTexture Define the JSON representation of the texture
  16091. * @param scene Define the scene the parsed texture should be instantiated in
  16092. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16093. * @returns The parsed texture if successful
  16094. */
  16095. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16096. /**
  16097. * Creates a texture from its base 64 representation.
  16098. * @param data Define the base64 payload without the data: prefix
  16099. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16100. * @param scene Define the scene the texture should belong to
  16101. * @param noMipmap Forces the texture to not create mip map information if true
  16102. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16103. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16104. * @param onLoad define a callback triggered when the texture has been loaded
  16105. * @param onError define a callback triggered when an error occurred during the loading session
  16106. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16107. * @returns the created texture
  16108. */
  16109. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16110. /**
  16111. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16112. * @param data Define the base64 payload without the data: prefix
  16113. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16114. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16115. * @param scene Define the scene the texture should belong to
  16116. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16117. * @param noMipmap Forces the texture to not create mip map information if true
  16118. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16119. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16120. * @param onLoad define a callback triggered when the texture has been loaded
  16121. * @param onError define a callback triggered when an error occurred during the loading session
  16122. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16123. * @returns the created texture
  16124. */
  16125. 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;
  16126. }
  16127. }
  16128. declare module "babylonjs/PostProcesses/postProcessManager" {
  16129. import { Nullable } from "babylonjs/types";
  16130. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16131. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16132. import { Scene } from "babylonjs/scene";
  16133. /**
  16134. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16135. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16136. */
  16137. export class PostProcessManager {
  16138. private _scene;
  16139. private _indexBuffer;
  16140. private _vertexBuffers;
  16141. /**
  16142. * Creates a new instance PostProcess
  16143. * @param scene The scene that the post process is associated with.
  16144. */
  16145. constructor(scene: Scene);
  16146. private _prepareBuffers;
  16147. private _buildIndexBuffer;
  16148. /**
  16149. * Rebuilds the vertex buffers of the manager.
  16150. * @hidden
  16151. */
  16152. _rebuild(): void;
  16153. /**
  16154. * Prepares a frame to be run through a post process.
  16155. * @param sourceTexture The input texture to the post procesess. (default: null)
  16156. * @param postProcesses An array of post processes to be run. (default: null)
  16157. * @returns True if the post processes were able to be run.
  16158. * @hidden
  16159. */
  16160. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16161. /**
  16162. * Manually render a set of post processes to a texture.
  16163. * @param postProcesses An array of post processes to be run.
  16164. * @param targetTexture The target texture to render to.
  16165. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16166. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16167. * @param lodLevel defines which lod of the texture to render to
  16168. */
  16169. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16170. /**
  16171. * Finalize the result of the output of the postprocesses.
  16172. * @param doNotPresent If true the result will not be displayed to the screen.
  16173. * @param targetTexture The target texture to render to.
  16174. * @param faceIndex The index of the face to bind the target texture to.
  16175. * @param postProcesses The array of post processes to render.
  16176. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16177. * @hidden
  16178. */
  16179. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16180. /**
  16181. * Disposes of the post process manager.
  16182. */
  16183. dispose(): void;
  16184. }
  16185. }
  16186. declare module "babylonjs/Misc/gradients" {
  16187. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16188. /** Interface used by value gradients (color, factor, ...) */
  16189. export interface IValueGradient {
  16190. /**
  16191. * Gets or sets the gradient value (between 0 and 1)
  16192. */
  16193. gradient: number;
  16194. }
  16195. /** Class used to store color4 gradient */
  16196. export class ColorGradient implements IValueGradient {
  16197. /**
  16198. * Gets or sets the gradient value (between 0 and 1)
  16199. */
  16200. gradient: number;
  16201. /**
  16202. * Gets or sets first associated color
  16203. */
  16204. color1: Color4;
  16205. /**
  16206. * Gets or sets second associated color
  16207. */
  16208. color2?: Color4;
  16209. /**
  16210. * Will get a color picked randomly between color1 and color2.
  16211. * If color2 is undefined then color1 will be used
  16212. * @param result defines the target Color4 to store the result in
  16213. */
  16214. getColorToRef(result: Color4): void;
  16215. }
  16216. /** Class used to store color 3 gradient */
  16217. export class Color3Gradient implements IValueGradient {
  16218. /**
  16219. * Gets or sets the gradient value (between 0 and 1)
  16220. */
  16221. gradient: number;
  16222. /**
  16223. * Gets or sets the associated color
  16224. */
  16225. color: Color3;
  16226. }
  16227. /** Class used to store factor gradient */
  16228. export class FactorGradient implements IValueGradient {
  16229. /**
  16230. * Gets or sets the gradient value (between 0 and 1)
  16231. */
  16232. gradient: number;
  16233. /**
  16234. * Gets or sets first associated factor
  16235. */
  16236. factor1: number;
  16237. /**
  16238. * Gets or sets second associated factor
  16239. */
  16240. factor2?: number;
  16241. /**
  16242. * Will get a number picked randomly between factor1 and factor2.
  16243. * If factor2 is undefined then factor1 will be used
  16244. * @returns the picked number
  16245. */
  16246. getFactor(): number;
  16247. }
  16248. /**
  16249. * Helper used to simplify some generic gradient tasks
  16250. */
  16251. export class GradientHelper {
  16252. /**
  16253. * Gets the current gradient from an array of IValueGradient
  16254. * @param ratio defines the current ratio to get
  16255. * @param gradients defines the array of IValueGradient
  16256. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16257. */
  16258. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16259. }
  16260. }
  16261. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16262. import { Scene } from "babylonjs/scene";
  16263. import { ISceneComponent } from "babylonjs/sceneComponent";
  16264. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16265. module "babylonjs/abstractScene" {
  16266. interface AbstractScene {
  16267. /**
  16268. * The list of procedural textures added to the scene
  16269. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16270. */
  16271. proceduralTextures: Array<ProceduralTexture>;
  16272. }
  16273. }
  16274. /**
  16275. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16276. * in a given scene.
  16277. */
  16278. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16279. /**
  16280. * The component name helpfull to identify the component in the list of scene components.
  16281. */
  16282. readonly name: string;
  16283. /**
  16284. * The scene the component belongs to.
  16285. */
  16286. scene: Scene;
  16287. /**
  16288. * Creates a new instance of the component for the given scene
  16289. * @param scene Defines the scene to register the component in
  16290. */
  16291. constructor(scene: Scene);
  16292. /**
  16293. * Registers the component in a given scene
  16294. */
  16295. register(): void;
  16296. /**
  16297. * Rebuilds the elements related to this component in case of
  16298. * context lost for instance.
  16299. */
  16300. rebuild(): void;
  16301. /**
  16302. * Disposes the component and the associated ressources.
  16303. */
  16304. dispose(): void;
  16305. private _beforeClear;
  16306. }
  16307. }
  16308. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  16309. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16310. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16311. module "babylonjs/Engines/engine" {
  16312. interface Engine {
  16313. /**
  16314. * Creates a new render target cube texture
  16315. * @param size defines the size of the texture
  16316. * @param options defines the options used to create the texture
  16317. * @returns a new render target cube texture stored in an InternalTexture
  16318. */
  16319. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16320. }
  16321. }
  16322. }
  16323. declare module "babylonjs/Shaders/procedural.vertex" {
  16324. /** @hidden */
  16325. export var proceduralVertexShader: {
  16326. name: string;
  16327. shader: string;
  16328. };
  16329. }
  16330. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16331. import { Observable } from "babylonjs/Misc/observable";
  16332. import { Nullable } from "babylonjs/types";
  16333. import { Scene } from "babylonjs/scene";
  16334. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16335. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16336. import { Effect } from "babylonjs/Materials/effect";
  16337. import { Texture } from "babylonjs/Materials/Textures/texture";
  16338. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16339. import "babylonjs/Shaders/procedural.vertex";
  16340. /**
  16341. * 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.
  16342. * This is the base class of any Procedural texture and contains most of the shareable code.
  16343. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16344. */
  16345. export class ProceduralTexture extends Texture {
  16346. isCube: boolean;
  16347. /**
  16348. * Define if the texture is enabled or not (disabled texture will not render)
  16349. */
  16350. isEnabled: boolean;
  16351. /**
  16352. * Define if the texture must be cleared before rendering (default is true)
  16353. */
  16354. autoClear: boolean;
  16355. /**
  16356. * Callback called when the texture is generated
  16357. */
  16358. onGenerated: () => void;
  16359. /**
  16360. * Event raised when the texture is generated
  16361. */
  16362. onGeneratedObservable: Observable<ProceduralTexture>;
  16363. /** @hidden */
  16364. _generateMipMaps: boolean;
  16365. /** @hidden **/
  16366. _effect: Effect;
  16367. /** @hidden */
  16368. _textures: {
  16369. [key: string]: Texture;
  16370. };
  16371. private _size;
  16372. private _currentRefreshId;
  16373. private _refreshRate;
  16374. private _vertexBuffers;
  16375. private _indexBuffer;
  16376. private _uniforms;
  16377. private _samplers;
  16378. private _fragment;
  16379. private _floats;
  16380. private _ints;
  16381. private _floatsArrays;
  16382. private _colors3;
  16383. private _colors4;
  16384. private _vectors2;
  16385. private _vectors3;
  16386. private _matrices;
  16387. private _fallbackTexture;
  16388. private _fallbackTextureUsed;
  16389. private _engine;
  16390. private _cachedDefines;
  16391. private _contentUpdateId;
  16392. private _contentData;
  16393. /**
  16394. * Instantiates a new procedural texture.
  16395. * 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.
  16396. * This is the base class of any Procedural texture and contains most of the shareable code.
  16397. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16398. * @param name Define the name of the texture
  16399. * @param size Define the size of the texture to create
  16400. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16401. * @param scene Define the scene the texture belongs to
  16402. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16403. * @param generateMipMaps Define if the texture should creates mip maps or not
  16404. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16405. */
  16406. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16407. /**
  16408. * The effect that is created when initializing the post process.
  16409. * @returns The created effect corresponding the the postprocess.
  16410. */
  16411. getEffect(): Effect;
  16412. /**
  16413. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16414. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16415. */
  16416. getContent(): Nullable<ArrayBufferView>;
  16417. private _createIndexBuffer;
  16418. /** @hidden */
  16419. _rebuild(): void;
  16420. /**
  16421. * Resets the texture in order to recreate its associated resources.
  16422. * This can be called in case of context loss
  16423. */
  16424. reset(): void;
  16425. protected _getDefines(): string;
  16426. /**
  16427. * Is the texture ready to be used ? (rendered at least once)
  16428. * @returns true if ready, otherwise, false.
  16429. */
  16430. isReady(): boolean;
  16431. /**
  16432. * Resets the refresh counter of the texture and start bak from scratch.
  16433. * Could be useful to regenerate the texture if it is setup to render only once.
  16434. */
  16435. resetRefreshCounter(): void;
  16436. /**
  16437. * Set the fragment shader to use in order to render the texture.
  16438. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16439. */
  16440. setFragment(fragment: any): void;
  16441. /**
  16442. * Define the refresh rate of the texture or the rendering frequency.
  16443. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16444. */
  16445. refreshRate: number;
  16446. /** @hidden */
  16447. _shouldRender(): boolean;
  16448. /**
  16449. * Get the size the texture is rendering at.
  16450. * @returns the size (texture is always squared)
  16451. */
  16452. getRenderSize(): number;
  16453. /**
  16454. * Resize the texture to new value.
  16455. * @param size Define the new size the texture should have
  16456. * @param generateMipMaps Define whether the new texture should create mip maps
  16457. */
  16458. resize(size: number, generateMipMaps: boolean): void;
  16459. private _checkUniform;
  16460. /**
  16461. * Set a texture in the shader program used to render.
  16462. * @param name Define the name of the uniform samplers as defined in the shader
  16463. * @param texture Define the texture to bind to this sampler
  16464. * @return the texture itself allowing "fluent" like uniform updates
  16465. */
  16466. setTexture(name: string, texture: Texture): ProceduralTexture;
  16467. /**
  16468. * Set a float in the shader.
  16469. * @param name Define the name of the uniform as defined in the shader
  16470. * @param value Define the value to give to the uniform
  16471. * @return the texture itself allowing "fluent" like uniform updates
  16472. */
  16473. setFloat(name: string, value: number): ProceduralTexture;
  16474. /**
  16475. * Set a int in the shader.
  16476. * @param name Define the name of the uniform as defined in the shader
  16477. * @param value Define the value to give to the uniform
  16478. * @return the texture itself allowing "fluent" like uniform updates
  16479. */
  16480. setInt(name: string, value: number): ProceduralTexture;
  16481. /**
  16482. * Set an array of floats in the shader.
  16483. * @param name Define the name of the uniform as defined in the shader
  16484. * @param value Define the value to give to the uniform
  16485. * @return the texture itself allowing "fluent" like uniform updates
  16486. */
  16487. setFloats(name: string, value: number[]): ProceduralTexture;
  16488. /**
  16489. * Set a vec3 in the shader from a Color3.
  16490. * @param name Define the name of the uniform as defined in the shader
  16491. * @param value Define the value to give to the uniform
  16492. * @return the texture itself allowing "fluent" like uniform updates
  16493. */
  16494. setColor3(name: string, value: Color3): ProceduralTexture;
  16495. /**
  16496. * Set a vec4 in the shader from a Color4.
  16497. * @param name Define the name of the uniform as defined in the shader
  16498. * @param value Define the value to give to the uniform
  16499. * @return the texture itself allowing "fluent" like uniform updates
  16500. */
  16501. setColor4(name: string, value: Color4): ProceduralTexture;
  16502. /**
  16503. * Set a vec2 in the shader from a Vector2.
  16504. * @param name Define the name of the uniform as defined in the shader
  16505. * @param value Define the value to give to the uniform
  16506. * @return the texture itself allowing "fluent" like uniform updates
  16507. */
  16508. setVector2(name: string, value: Vector2): ProceduralTexture;
  16509. /**
  16510. * Set a vec3 in the shader from a Vector3.
  16511. * @param name Define the name of the uniform as defined in the shader
  16512. * @param value Define the value to give to the uniform
  16513. * @return the texture itself allowing "fluent" like uniform updates
  16514. */
  16515. setVector3(name: string, value: Vector3): ProceduralTexture;
  16516. /**
  16517. * Set a mat4 in the shader from a MAtrix.
  16518. * @param name Define the name of the uniform as defined in the shader
  16519. * @param value Define the value to give to the uniform
  16520. * @return the texture itself allowing "fluent" like uniform updates
  16521. */
  16522. setMatrix(name: string, value: Matrix): ProceduralTexture;
  16523. /**
  16524. * Render the texture to its associated render target.
  16525. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  16526. */
  16527. render(useCameraPostProcess?: boolean): void;
  16528. /**
  16529. * Clone the texture.
  16530. * @returns the cloned texture
  16531. */
  16532. clone(): ProceduralTexture;
  16533. /**
  16534. * Dispose the texture and release its asoociated resources.
  16535. */
  16536. dispose(): void;
  16537. }
  16538. }
  16539. declare module "babylonjs/Particles/baseParticleSystem" {
  16540. import { Nullable } from "babylonjs/types";
  16541. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  16542. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16543. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  16544. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16545. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16546. import { Scene } from "babylonjs/scene";
  16547. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  16548. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  16549. import { Texture } from "babylonjs/Materials/Textures/texture";
  16550. import { Color4 } from "babylonjs/Maths/math.color";
  16551. import { Animation } from "babylonjs/Animations/animation";
  16552. /**
  16553. * This represents the base class for particle system in Babylon.
  16554. * 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.
  16555. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  16556. * @example https://doc.babylonjs.com/babylon101/particles
  16557. */
  16558. export class BaseParticleSystem {
  16559. /**
  16560. * Source color is added to the destination color without alpha affecting the result
  16561. */
  16562. static BLENDMODE_ONEONE: number;
  16563. /**
  16564. * Blend current color and particle color using particle’s alpha
  16565. */
  16566. static BLENDMODE_STANDARD: number;
  16567. /**
  16568. * Add current color and particle color multiplied by particle’s alpha
  16569. */
  16570. static BLENDMODE_ADD: number;
  16571. /**
  16572. * Multiply current color with particle color
  16573. */
  16574. static BLENDMODE_MULTIPLY: number;
  16575. /**
  16576. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  16577. */
  16578. static BLENDMODE_MULTIPLYADD: number;
  16579. /**
  16580. * List of animations used by the particle system.
  16581. */
  16582. animations: Animation[];
  16583. /**
  16584. * The id of the Particle system.
  16585. */
  16586. id: string;
  16587. /**
  16588. * The friendly name of the Particle system.
  16589. */
  16590. name: string;
  16591. /**
  16592. * The rendering group used by the Particle system to chose when to render.
  16593. */
  16594. renderingGroupId: number;
  16595. /**
  16596. * The emitter represents the Mesh or position we are attaching the particle system to.
  16597. */
  16598. emitter: Nullable<AbstractMesh | Vector3>;
  16599. /**
  16600. * The maximum number of particles to emit per frame
  16601. */
  16602. emitRate: number;
  16603. /**
  16604. * If you want to launch only a few particles at once, that can be done, as well.
  16605. */
  16606. manualEmitCount: number;
  16607. /**
  16608. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  16609. */
  16610. updateSpeed: number;
  16611. /**
  16612. * The amount of time the particle system is running (depends of the overall update speed).
  16613. */
  16614. targetStopDuration: number;
  16615. /**
  16616. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  16617. */
  16618. disposeOnStop: boolean;
  16619. /**
  16620. * Minimum power of emitting particles.
  16621. */
  16622. minEmitPower: number;
  16623. /**
  16624. * Maximum power of emitting particles.
  16625. */
  16626. maxEmitPower: number;
  16627. /**
  16628. * Minimum life time of emitting particles.
  16629. */
  16630. minLifeTime: number;
  16631. /**
  16632. * Maximum life time of emitting particles.
  16633. */
  16634. maxLifeTime: number;
  16635. /**
  16636. * Minimum Size of emitting particles.
  16637. */
  16638. minSize: number;
  16639. /**
  16640. * Maximum Size of emitting particles.
  16641. */
  16642. maxSize: number;
  16643. /**
  16644. * Minimum scale of emitting particles on X axis.
  16645. */
  16646. minScaleX: number;
  16647. /**
  16648. * Maximum scale of emitting particles on X axis.
  16649. */
  16650. maxScaleX: number;
  16651. /**
  16652. * Minimum scale of emitting particles on Y axis.
  16653. */
  16654. minScaleY: number;
  16655. /**
  16656. * Maximum scale of emitting particles on Y axis.
  16657. */
  16658. maxScaleY: number;
  16659. /**
  16660. * Gets or sets the minimal initial rotation in radians.
  16661. */
  16662. minInitialRotation: number;
  16663. /**
  16664. * Gets or sets the maximal initial rotation in radians.
  16665. */
  16666. maxInitialRotation: number;
  16667. /**
  16668. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  16669. */
  16670. minAngularSpeed: number;
  16671. /**
  16672. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  16673. */
  16674. maxAngularSpeed: number;
  16675. /**
  16676. * The texture used to render each particle. (this can be a spritesheet)
  16677. */
  16678. particleTexture: Nullable<Texture>;
  16679. /**
  16680. * The layer mask we are rendering the particles through.
  16681. */
  16682. layerMask: number;
  16683. /**
  16684. * This can help using your own shader to render the particle system.
  16685. * The according effect will be created
  16686. */
  16687. customShader: any;
  16688. /**
  16689. * By default particle system starts as soon as they are created. This prevents the
  16690. * automatic start to happen and let you decide when to start emitting particles.
  16691. */
  16692. preventAutoStart: boolean;
  16693. private _noiseTexture;
  16694. /**
  16695. * Gets or sets a texture used to add random noise to particle positions
  16696. */
  16697. noiseTexture: Nullable<ProceduralTexture>;
  16698. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  16699. noiseStrength: Vector3;
  16700. /**
  16701. * Callback triggered when the particle animation is ending.
  16702. */
  16703. onAnimationEnd: Nullable<() => void>;
  16704. /**
  16705. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  16706. */
  16707. blendMode: number;
  16708. /**
  16709. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  16710. * to override the particles.
  16711. */
  16712. forceDepthWrite: boolean;
  16713. /** 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 */
  16714. preWarmCycles: number;
  16715. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  16716. preWarmStepOffset: number;
  16717. /**
  16718. * 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)
  16719. */
  16720. spriteCellChangeSpeed: number;
  16721. /**
  16722. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  16723. */
  16724. startSpriteCellID: number;
  16725. /**
  16726. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  16727. */
  16728. endSpriteCellID: number;
  16729. /**
  16730. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  16731. */
  16732. spriteCellWidth: number;
  16733. /**
  16734. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  16735. */
  16736. spriteCellHeight: number;
  16737. /**
  16738. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  16739. */
  16740. spriteRandomStartCell: boolean;
  16741. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  16742. translationPivot: Vector2;
  16743. /** @hidden */
  16744. protected _isAnimationSheetEnabled: boolean;
  16745. /**
  16746. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  16747. */
  16748. beginAnimationOnStart: boolean;
  16749. /**
  16750. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  16751. */
  16752. beginAnimationFrom: number;
  16753. /**
  16754. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  16755. */
  16756. beginAnimationTo: number;
  16757. /**
  16758. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  16759. */
  16760. beginAnimationLoop: boolean;
  16761. /**
  16762. * Gets or sets a world offset applied to all particles
  16763. */
  16764. worldOffset: Vector3;
  16765. /**
  16766. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  16767. */
  16768. isAnimationSheetEnabled: boolean;
  16769. /**
  16770. * Get hosting scene
  16771. * @returns the scene
  16772. */
  16773. getScene(): Scene;
  16774. /**
  16775. * You can use gravity if you want to give an orientation to your particles.
  16776. */
  16777. gravity: Vector3;
  16778. protected _colorGradients: Nullable<Array<ColorGradient>>;
  16779. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  16780. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  16781. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  16782. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  16783. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  16784. protected _dragGradients: Nullable<Array<FactorGradient>>;
  16785. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  16786. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  16787. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  16788. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  16789. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  16790. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  16791. /**
  16792. * Defines the delay in milliseconds before starting the system (0 by default)
  16793. */
  16794. startDelay: number;
  16795. /**
  16796. * Gets the current list of drag gradients.
  16797. * You must use addDragGradient and removeDragGradient to udpate this list
  16798. * @returns the list of drag gradients
  16799. */
  16800. getDragGradients(): Nullable<Array<FactorGradient>>;
  16801. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  16802. limitVelocityDamping: number;
  16803. /**
  16804. * Gets the current list of limit velocity gradients.
  16805. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  16806. * @returns the list of limit velocity gradients
  16807. */
  16808. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  16809. /**
  16810. * Gets the current list of color gradients.
  16811. * You must use addColorGradient and removeColorGradient to udpate this list
  16812. * @returns the list of color gradients
  16813. */
  16814. getColorGradients(): Nullable<Array<ColorGradient>>;
  16815. /**
  16816. * Gets the current list of size gradients.
  16817. * You must use addSizeGradient and removeSizeGradient to udpate this list
  16818. * @returns the list of size gradients
  16819. */
  16820. getSizeGradients(): Nullable<Array<FactorGradient>>;
  16821. /**
  16822. * Gets the current list of color remap gradients.
  16823. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  16824. * @returns the list of color remap gradients
  16825. */
  16826. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  16827. /**
  16828. * Gets the current list of alpha remap gradients.
  16829. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  16830. * @returns the list of alpha remap gradients
  16831. */
  16832. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  16833. /**
  16834. * Gets the current list of life time gradients.
  16835. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  16836. * @returns the list of life time gradients
  16837. */
  16838. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  16839. /**
  16840. * Gets the current list of angular speed gradients.
  16841. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  16842. * @returns the list of angular speed gradients
  16843. */
  16844. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  16845. /**
  16846. * Gets the current list of velocity gradients.
  16847. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  16848. * @returns the list of velocity gradients
  16849. */
  16850. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  16851. /**
  16852. * Gets the current list of start size gradients.
  16853. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  16854. * @returns the list of start size gradients
  16855. */
  16856. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  16857. /**
  16858. * Gets the current list of emit rate gradients.
  16859. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  16860. * @returns the list of emit rate gradients
  16861. */
  16862. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  16863. /**
  16864. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16865. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16866. */
  16867. direction1: Vector3;
  16868. /**
  16869. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16870. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16871. */
  16872. direction2: Vector3;
  16873. /**
  16874. * 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.
  16875. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16876. */
  16877. minEmitBox: Vector3;
  16878. /**
  16879. * 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.
  16880. * This only works when particleEmitterTyps is a BoxParticleEmitter
  16881. */
  16882. maxEmitBox: Vector3;
  16883. /**
  16884. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  16885. */
  16886. color1: Color4;
  16887. /**
  16888. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  16889. */
  16890. color2: Color4;
  16891. /**
  16892. * Color the particle will have at the end of its lifetime
  16893. */
  16894. colorDead: Color4;
  16895. /**
  16896. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  16897. */
  16898. textureMask: Color4;
  16899. /**
  16900. * The particle emitter type defines the emitter used by the particle system.
  16901. * It can be for example box, sphere, or cone...
  16902. */
  16903. particleEmitterType: IParticleEmitterType;
  16904. /** @hidden */
  16905. _isSubEmitter: boolean;
  16906. /**
  16907. * Gets or sets the billboard mode to use when isBillboardBased = true.
  16908. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  16909. */
  16910. billboardMode: number;
  16911. protected _isBillboardBased: boolean;
  16912. /**
  16913. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  16914. */
  16915. isBillboardBased: boolean;
  16916. /**
  16917. * The scene the particle system belongs to.
  16918. */
  16919. protected _scene: Scene;
  16920. /**
  16921. * Local cache of defines for image processing.
  16922. */
  16923. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  16924. /**
  16925. * Default configuration related to image processing available in the standard Material.
  16926. */
  16927. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  16928. /**
  16929. * Gets the image processing configuration used either in this material.
  16930. */
  16931. /**
  16932. * Sets the Default image processing configuration used either in the this material.
  16933. *
  16934. * If sets to null, the scene one is in use.
  16935. */
  16936. imageProcessingConfiguration: ImageProcessingConfiguration;
  16937. /**
  16938. * Attaches a new image processing configuration to the Standard Material.
  16939. * @param configuration
  16940. */
  16941. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  16942. /** @hidden */
  16943. protected _reset(): void;
  16944. /** @hidden */
  16945. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  16946. /**
  16947. * Instantiates a particle system.
  16948. * 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.
  16949. * @param name The name of the particle system
  16950. */
  16951. constructor(name: string);
  16952. /**
  16953. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  16954. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  16955. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  16956. * @returns the emitter
  16957. */
  16958. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  16959. /**
  16960. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  16961. * @param radius The radius of the hemisphere to emit from
  16962. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  16963. * @returns the emitter
  16964. */
  16965. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  16966. /**
  16967. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  16968. * @param radius The radius of the sphere to emit from
  16969. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  16970. * @returns the emitter
  16971. */
  16972. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  16973. /**
  16974. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  16975. * @param radius The radius of the sphere to emit from
  16976. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  16977. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  16978. * @returns the emitter
  16979. */
  16980. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  16981. /**
  16982. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  16983. * @param radius The radius of the emission cylinder
  16984. * @param height The height of the emission cylinder
  16985. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  16986. * @param directionRandomizer How much to randomize the particle direction [0-1]
  16987. * @returns the emitter
  16988. */
  16989. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  16990. /**
  16991. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  16992. * @param radius The radius of the cylinder to emit from
  16993. * @param height The height of the emission cylinder
  16994. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  16995. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  16996. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  16997. * @returns the emitter
  16998. */
  16999. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17000. /**
  17001. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17002. * @param radius The radius of the cone to emit from
  17003. * @param angle The base angle of the cone
  17004. * @returns the emitter
  17005. */
  17006. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17007. /**
  17008. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17009. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17010. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17011. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17012. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17013. * @returns the emitter
  17014. */
  17015. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17016. }
  17017. }
  17018. declare module "babylonjs/Particles/subEmitter" {
  17019. import { Scene } from "babylonjs/scene";
  17020. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17021. /**
  17022. * Type of sub emitter
  17023. */
  17024. export enum SubEmitterType {
  17025. /**
  17026. * Attached to the particle over it's lifetime
  17027. */
  17028. ATTACHED = 0,
  17029. /**
  17030. * Created when the particle dies
  17031. */
  17032. END = 1
  17033. }
  17034. /**
  17035. * Sub emitter class used to emit particles from an existing particle
  17036. */
  17037. export class SubEmitter {
  17038. /**
  17039. * the particle system to be used by the sub emitter
  17040. */
  17041. particleSystem: ParticleSystem;
  17042. /**
  17043. * Type of the submitter (Default: END)
  17044. */
  17045. type: SubEmitterType;
  17046. /**
  17047. * 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)
  17048. * Note: This only is supported when using an emitter of type Mesh
  17049. */
  17050. inheritDirection: boolean;
  17051. /**
  17052. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17053. */
  17054. inheritedVelocityAmount: number;
  17055. /**
  17056. * Creates a sub emitter
  17057. * @param particleSystem the particle system to be used by the sub emitter
  17058. */
  17059. constructor(
  17060. /**
  17061. * the particle system to be used by the sub emitter
  17062. */
  17063. particleSystem: ParticleSystem);
  17064. /**
  17065. * Clones the sub emitter
  17066. * @returns the cloned sub emitter
  17067. */
  17068. clone(): SubEmitter;
  17069. /**
  17070. * Serialize current object to a JSON object
  17071. * @returns the serialized object
  17072. */
  17073. serialize(): any;
  17074. /** @hidden */
  17075. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17076. /**
  17077. * Creates a new SubEmitter from a serialized JSON version
  17078. * @param serializationObject defines the JSON object to read from
  17079. * @param scene defines the hosting scene
  17080. * @param rootUrl defines the rootUrl for data loading
  17081. * @returns a new SubEmitter
  17082. */
  17083. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17084. /** Release associated resources */
  17085. dispose(): void;
  17086. }
  17087. }
  17088. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17089. /** @hidden */
  17090. export var clipPlaneFragmentDeclaration: {
  17091. name: string;
  17092. shader: string;
  17093. };
  17094. }
  17095. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17096. /** @hidden */
  17097. export var imageProcessingDeclaration: {
  17098. name: string;
  17099. shader: string;
  17100. };
  17101. }
  17102. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17103. /** @hidden */
  17104. export var imageProcessingFunctions: {
  17105. name: string;
  17106. shader: string;
  17107. };
  17108. }
  17109. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17110. /** @hidden */
  17111. export var clipPlaneFragment: {
  17112. name: string;
  17113. shader: string;
  17114. };
  17115. }
  17116. declare module "babylonjs/Shaders/particles.fragment" {
  17117. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17118. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17119. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17120. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17121. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17122. /** @hidden */
  17123. export var particlesPixelShader: {
  17124. name: string;
  17125. shader: string;
  17126. };
  17127. }
  17128. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17129. /** @hidden */
  17130. export var clipPlaneVertexDeclaration: {
  17131. name: string;
  17132. shader: string;
  17133. };
  17134. }
  17135. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17136. /** @hidden */
  17137. export var clipPlaneVertex: {
  17138. name: string;
  17139. shader: string;
  17140. };
  17141. }
  17142. declare module "babylonjs/Shaders/particles.vertex" {
  17143. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17144. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17145. /** @hidden */
  17146. export var particlesVertexShader: {
  17147. name: string;
  17148. shader: string;
  17149. };
  17150. }
  17151. declare module "babylonjs/Particles/particleSystem" {
  17152. import { Nullable } from "babylonjs/types";
  17153. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17154. import { Observable } from "babylonjs/Misc/observable";
  17155. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17156. import { Effect } from "babylonjs/Materials/effect";
  17157. import { Scene, IDisposable } from "babylonjs/scene";
  17158. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17159. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17160. import { Particle } from "babylonjs/Particles/particle";
  17161. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17162. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17163. import "babylonjs/Shaders/particles.fragment";
  17164. import "babylonjs/Shaders/particles.vertex";
  17165. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17166. /**
  17167. * This represents a particle system in Babylon.
  17168. * 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.
  17169. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17170. * @example https://doc.babylonjs.com/babylon101/particles
  17171. */
  17172. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17173. /**
  17174. * Billboard mode will only apply to Y axis
  17175. */
  17176. static readonly BILLBOARDMODE_Y: number;
  17177. /**
  17178. * Billboard mode will apply to all axes
  17179. */
  17180. static readonly BILLBOARDMODE_ALL: number;
  17181. /**
  17182. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17183. */
  17184. static readonly BILLBOARDMODE_STRETCHED: number;
  17185. /**
  17186. * This function can be defined to provide custom update for active particles.
  17187. * This function will be called instead of regular update (age, position, color, etc.).
  17188. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17189. */
  17190. updateFunction: (particles: Particle[]) => void;
  17191. private _emitterWorldMatrix;
  17192. /**
  17193. * This function can be defined to specify initial direction for every new particle.
  17194. * It by default use the emitterType defined function
  17195. */
  17196. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17197. /**
  17198. * This function can be defined to specify initial position for every new particle.
  17199. * It by default use the emitterType defined function
  17200. */
  17201. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17202. /**
  17203. * @hidden
  17204. */
  17205. _inheritedVelocityOffset: Vector3;
  17206. /**
  17207. * An event triggered when the system is disposed
  17208. */
  17209. onDisposeObservable: Observable<ParticleSystem>;
  17210. private _onDisposeObserver;
  17211. /**
  17212. * Sets a callback that will be triggered when the system is disposed
  17213. */
  17214. onDispose: () => void;
  17215. private _particles;
  17216. private _epsilon;
  17217. private _capacity;
  17218. private _stockParticles;
  17219. private _newPartsExcess;
  17220. private _vertexData;
  17221. private _vertexBuffer;
  17222. private _vertexBuffers;
  17223. private _spriteBuffer;
  17224. private _indexBuffer;
  17225. private _effect;
  17226. private _customEffect;
  17227. private _cachedDefines;
  17228. private _scaledColorStep;
  17229. private _colorDiff;
  17230. private _scaledDirection;
  17231. private _scaledGravity;
  17232. private _currentRenderId;
  17233. private _alive;
  17234. private _useInstancing;
  17235. private _started;
  17236. private _stopped;
  17237. private _actualFrame;
  17238. private _scaledUpdateSpeed;
  17239. private _vertexBufferSize;
  17240. /** @hidden */
  17241. _currentEmitRateGradient: Nullable<FactorGradient>;
  17242. /** @hidden */
  17243. _currentEmitRate1: number;
  17244. /** @hidden */
  17245. _currentEmitRate2: number;
  17246. /** @hidden */
  17247. _currentStartSizeGradient: Nullable<FactorGradient>;
  17248. /** @hidden */
  17249. _currentStartSize1: number;
  17250. /** @hidden */
  17251. _currentStartSize2: number;
  17252. private readonly _rawTextureWidth;
  17253. private _rampGradientsTexture;
  17254. private _useRampGradients;
  17255. /** Gets or sets a boolean indicating that ramp gradients must be used
  17256. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17257. */
  17258. useRampGradients: boolean;
  17259. /**
  17260. * 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.
  17261. * 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: [])
  17262. */
  17263. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17264. private _subEmitters;
  17265. /**
  17266. * @hidden
  17267. * If the particle systems emitter should be disposed when the particle system is disposed
  17268. */
  17269. _disposeEmitterOnDispose: boolean;
  17270. /**
  17271. * The current active Sub-systems, this property is used by the root particle system only.
  17272. */
  17273. activeSubSystems: Array<ParticleSystem>;
  17274. private _rootParticleSystem;
  17275. /**
  17276. * Gets the current list of active particles
  17277. */
  17278. readonly particles: Particle[];
  17279. /**
  17280. * Returns the string "ParticleSystem"
  17281. * @returns a string containing the class name
  17282. */
  17283. getClassName(): string;
  17284. /**
  17285. * Instantiates a particle system.
  17286. * 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.
  17287. * @param name The name of the particle system
  17288. * @param capacity The max number of particles alive at the same time
  17289. * @param scene The scene the particle system belongs to
  17290. * @param customEffect a custom effect used to change the way particles are rendered by default
  17291. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17292. * @param epsilon Offset used to render the particles
  17293. */
  17294. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17295. private _addFactorGradient;
  17296. private _removeFactorGradient;
  17297. /**
  17298. * Adds a new life time gradient
  17299. * @param gradient defines the gradient to use (between 0 and 1)
  17300. * @param factor defines the life time factor to affect to the specified gradient
  17301. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17302. * @returns the current particle system
  17303. */
  17304. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17305. /**
  17306. * Remove a specific life time gradient
  17307. * @param gradient defines the gradient to remove
  17308. * @returns the current particle system
  17309. */
  17310. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17311. /**
  17312. * Adds a new size gradient
  17313. * @param gradient defines the gradient to use (between 0 and 1)
  17314. * @param factor defines the size factor to affect to the specified gradient
  17315. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17316. * @returns the current particle system
  17317. */
  17318. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17319. /**
  17320. * Remove a specific size gradient
  17321. * @param gradient defines the gradient to remove
  17322. * @returns the current particle system
  17323. */
  17324. removeSizeGradient(gradient: number): IParticleSystem;
  17325. /**
  17326. * Adds a new color remap gradient
  17327. * @param gradient defines the gradient to use (between 0 and 1)
  17328. * @param min defines the color remap minimal range
  17329. * @param max defines the color remap maximal range
  17330. * @returns the current particle system
  17331. */
  17332. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17333. /**
  17334. * Remove a specific color remap gradient
  17335. * @param gradient defines the gradient to remove
  17336. * @returns the current particle system
  17337. */
  17338. removeColorRemapGradient(gradient: number): IParticleSystem;
  17339. /**
  17340. * Adds a new alpha remap gradient
  17341. * @param gradient defines the gradient to use (between 0 and 1)
  17342. * @param min defines the alpha remap minimal range
  17343. * @param max defines the alpha remap maximal range
  17344. * @returns the current particle system
  17345. */
  17346. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17347. /**
  17348. * Remove a specific alpha remap gradient
  17349. * @param gradient defines the gradient to remove
  17350. * @returns the current particle system
  17351. */
  17352. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17353. /**
  17354. * Adds a new angular speed gradient
  17355. * @param gradient defines the gradient to use (between 0 and 1)
  17356. * @param factor defines the angular speed to affect to the specified gradient
  17357. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17358. * @returns the current particle system
  17359. */
  17360. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17361. /**
  17362. * Remove a specific angular speed gradient
  17363. * @param gradient defines the gradient to remove
  17364. * @returns the current particle system
  17365. */
  17366. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17367. /**
  17368. * Adds a new velocity gradient
  17369. * @param gradient defines the gradient to use (between 0 and 1)
  17370. * @param factor defines the velocity to affect to the specified gradient
  17371. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17372. * @returns the current particle system
  17373. */
  17374. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17375. /**
  17376. * Remove a specific velocity gradient
  17377. * @param gradient defines the gradient to remove
  17378. * @returns the current particle system
  17379. */
  17380. removeVelocityGradient(gradient: number): IParticleSystem;
  17381. /**
  17382. * Adds a new limit velocity gradient
  17383. * @param gradient defines the gradient to use (between 0 and 1)
  17384. * @param factor defines the limit velocity value to affect to the specified gradient
  17385. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17386. * @returns the current particle system
  17387. */
  17388. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17389. /**
  17390. * Remove a specific limit velocity gradient
  17391. * @param gradient defines the gradient to remove
  17392. * @returns the current particle system
  17393. */
  17394. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17395. /**
  17396. * Adds a new drag gradient
  17397. * @param gradient defines the gradient to use (between 0 and 1)
  17398. * @param factor defines the drag value to affect to the specified gradient
  17399. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17400. * @returns the current particle system
  17401. */
  17402. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17403. /**
  17404. * Remove a specific drag gradient
  17405. * @param gradient defines the gradient to remove
  17406. * @returns the current particle system
  17407. */
  17408. removeDragGradient(gradient: number): IParticleSystem;
  17409. /**
  17410. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17411. * @param gradient defines the gradient to use (between 0 and 1)
  17412. * @param factor defines the emit rate value to affect to the specified gradient
  17413. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17414. * @returns the current particle system
  17415. */
  17416. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17417. /**
  17418. * Remove a specific emit rate gradient
  17419. * @param gradient defines the gradient to remove
  17420. * @returns the current particle system
  17421. */
  17422. removeEmitRateGradient(gradient: number): IParticleSystem;
  17423. /**
  17424. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17425. * @param gradient defines the gradient to use (between 0 and 1)
  17426. * @param factor defines the start size value to affect to the specified gradient
  17427. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17428. * @returns the current particle system
  17429. */
  17430. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17431. /**
  17432. * Remove a specific start size gradient
  17433. * @param gradient defines the gradient to remove
  17434. * @returns the current particle system
  17435. */
  17436. removeStartSizeGradient(gradient: number): IParticleSystem;
  17437. private _createRampGradientTexture;
  17438. /**
  17439. * Gets the current list of ramp gradients.
  17440. * You must use addRampGradient and removeRampGradient to udpate this list
  17441. * @returns the list of ramp gradients
  17442. */
  17443. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17444. /**
  17445. * Adds a new ramp gradient used to remap particle colors
  17446. * @param gradient defines the gradient to use (between 0 and 1)
  17447. * @param color defines the color to affect to the specified gradient
  17448. * @returns the current particle system
  17449. */
  17450. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17451. /**
  17452. * Remove a specific ramp gradient
  17453. * @param gradient defines the gradient to remove
  17454. * @returns the current particle system
  17455. */
  17456. removeRampGradient(gradient: number): ParticleSystem;
  17457. /**
  17458. * Adds a new color gradient
  17459. * @param gradient defines the gradient to use (between 0 and 1)
  17460. * @param color1 defines the color to affect to the specified gradient
  17461. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17462. * @returns this particle system
  17463. */
  17464. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17465. /**
  17466. * Remove a specific color gradient
  17467. * @param gradient defines the gradient to remove
  17468. * @returns this particle system
  17469. */
  17470. removeColorGradient(gradient: number): IParticleSystem;
  17471. private _fetchR;
  17472. protected _reset(): void;
  17473. private _resetEffect;
  17474. private _createVertexBuffers;
  17475. private _createIndexBuffer;
  17476. /**
  17477. * Gets the maximum number of particles active at the same time.
  17478. * @returns The max number of active particles.
  17479. */
  17480. getCapacity(): number;
  17481. /**
  17482. * Gets whether there are still active particles in the system.
  17483. * @returns True if it is alive, otherwise false.
  17484. */
  17485. isAlive(): boolean;
  17486. /**
  17487. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17488. * @returns True if it has been started, otherwise false.
  17489. */
  17490. isStarted(): boolean;
  17491. private _prepareSubEmitterInternalArray;
  17492. /**
  17493. * Starts the particle system and begins to emit
  17494. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17495. */
  17496. start(delay?: number): void;
  17497. /**
  17498. * Stops the particle system.
  17499. * @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.
  17500. */
  17501. stop(stopSubEmitters?: boolean): void;
  17502. /**
  17503. * Remove all active particles
  17504. */
  17505. reset(): void;
  17506. /**
  17507. * @hidden (for internal use only)
  17508. */
  17509. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  17510. /**
  17511. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  17512. * Its lifetime will start back at 0.
  17513. */
  17514. recycleParticle: (particle: Particle) => void;
  17515. private _stopSubEmitters;
  17516. private _createParticle;
  17517. private _removeFromRoot;
  17518. private _emitFromParticle;
  17519. private _update;
  17520. /** @hidden */
  17521. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  17522. /** @hidden */
  17523. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  17524. /** @hidden */
  17525. private _getEffect;
  17526. /**
  17527. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  17528. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  17529. */
  17530. animate(preWarmOnly?: boolean): void;
  17531. private _appendParticleVertices;
  17532. /**
  17533. * Rebuilds the particle system.
  17534. */
  17535. rebuild(): void;
  17536. /**
  17537. * Is this system ready to be used/rendered
  17538. * @return true if the system is ready
  17539. */
  17540. isReady(): boolean;
  17541. private _render;
  17542. /**
  17543. * Renders the particle system in its current state.
  17544. * @returns the current number of particles
  17545. */
  17546. render(): number;
  17547. /**
  17548. * Disposes the particle system and free the associated resources
  17549. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  17550. */
  17551. dispose(disposeTexture?: boolean): void;
  17552. /**
  17553. * Clones the particle system.
  17554. * @param name The name of the cloned object
  17555. * @param newEmitter The new emitter to use
  17556. * @returns the cloned particle system
  17557. */
  17558. clone(name: string, newEmitter: any): ParticleSystem;
  17559. /**
  17560. * Serializes the particle system to a JSON object.
  17561. * @returns the JSON object
  17562. */
  17563. serialize(): any;
  17564. /** @hidden */
  17565. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  17566. /** @hidden */
  17567. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  17568. /**
  17569. * Parses a JSON object to create a particle system.
  17570. * @param parsedParticleSystem The JSON object to parse
  17571. * @param scene The scene to create the particle system in
  17572. * @param rootUrl The root url to use to load external dependencies like texture
  17573. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  17574. * @returns the Parsed particle system
  17575. */
  17576. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  17577. }
  17578. }
  17579. declare module "babylonjs/Particles/particle" {
  17580. import { Nullable } from "babylonjs/types";
  17581. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  17582. import { Color4 } from "babylonjs/Maths/math.color";
  17583. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17584. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17585. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  17586. /**
  17587. * A particle represents one of the element emitted by a particle system.
  17588. * This is mainly define by its coordinates, direction, velocity and age.
  17589. */
  17590. export class Particle {
  17591. /**
  17592. * The particle system the particle belongs to.
  17593. */
  17594. particleSystem: ParticleSystem;
  17595. private static _Count;
  17596. /**
  17597. * Unique ID of the particle
  17598. */
  17599. id: number;
  17600. /**
  17601. * The world position of the particle in the scene.
  17602. */
  17603. position: Vector3;
  17604. /**
  17605. * The world direction of the particle in the scene.
  17606. */
  17607. direction: Vector3;
  17608. /**
  17609. * The color of the particle.
  17610. */
  17611. color: Color4;
  17612. /**
  17613. * The color change of the particle per step.
  17614. */
  17615. colorStep: Color4;
  17616. /**
  17617. * Defines how long will the life of the particle be.
  17618. */
  17619. lifeTime: number;
  17620. /**
  17621. * The current age of the particle.
  17622. */
  17623. age: number;
  17624. /**
  17625. * The current size of the particle.
  17626. */
  17627. size: number;
  17628. /**
  17629. * The current scale of the particle.
  17630. */
  17631. scale: Vector2;
  17632. /**
  17633. * The current angle of the particle.
  17634. */
  17635. angle: number;
  17636. /**
  17637. * Defines how fast is the angle changing.
  17638. */
  17639. angularSpeed: number;
  17640. /**
  17641. * Defines the cell index used by the particle to be rendered from a sprite.
  17642. */
  17643. cellIndex: number;
  17644. /**
  17645. * The information required to support color remapping
  17646. */
  17647. remapData: Vector4;
  17648. /** @hidden */
  17649. _randomCellOffset?: number;
  17650. /** @hidden */
  17651. _initialDirection: Nullable<Vector3>;
  17652. /** @hidden */
  17653. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  17654. /** @hidden */
  17655. _initialStartSpriteCellID: number;
  17656. /** @hidden */
  17657. _initialEndSpriteCellID: number;
  17658. /** @hidden */
  17659. _currentColorGradient: Nullable<ColorGradient>;
  17660. /** @hidden */
  17661. _currentColor1: Color4;
  17662. /** @hidden */
  17663. _currentColor2: Color4;
  17664. /** @hidden */
  17665. _currentSizeGradient: Nullable<FactorGradient>;
  17666. /** @hidden */
  17667. _currentSize1: number;
  17668. /** @hidden */
  17669. _currentSize2: number;
  17670. /** @hidden */
  17671. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  17672. /** @hidden */
  17673. _currentAngularSpeed1: number;
  17674. /** @hidden */
  17675. _currentAngularSpeed2: number;
  17676. /** @hidden */
  17677. _currentVelocityGradient: Nullable<FactorGradient>;
  17678. /** @hidden */
  17679. _currentVelocity1: number;
  17680. /** @hidden */
  17681. _currentVelocity2: number;
  17682. /** @hidden */
  17683. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  17684. /** @hidden */
  17685. _currentLimitVelocity1: number;
  17686. /** @hidden */
  17687. _currentLimitVelocity2: number;
  17688. /** @hidden */
  17689. _currentDragGradient: Nullable<FactorGradient>;
  17690. /** @hidden */
  17691. _currentDrag1: number;
  17692. /** @hidden */
  17693. _currentDrag2: number;
  17694. /** @hidden */
  17695. _randomNoiseCoordinates1: Vector3;
  17696. /** @hidden */
  17697. _randomNoiseCoordinates2: Vector3;
  17698. /**
  17699. * Creates a new instance Particle
  17700. * @param particleSystem the particle system the particle belongs to
  17701. */
  17702. constructor(
  17703. /**
  17704. * The particle system the particle belongs to.
  17705. */
  17706. particleSystem: ParticleSystem);
  17707. private updateCellInfoFromSystem;
  17708. /**
  17709. * Defines how the sprite cell index is updated for the particle
  17710. */
  17711. updateCellIndex(): void;
  17712. /** @hidden */
  17713. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  17714. /** @hidden */
  17715. _inheritParticleInfoToSubEmitters(): void;
  17716. /** @hidden */
  17717. _reset(): void;
  17718. /**
  17719. * Copy the properties of particle to another one.
  17720. * @param other the particle to copy the information to.
  17721. */
  17722. copyTo(other: Particle): void;
  17723. }
  17724. }
  17725. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  17726. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17727. import { Effect } from "babylonjs/Materials/effect";
  17728. import { Particle } from "babylonjs/Particles/particle";
  17729. /**
  17730. * Particle emitter represents a volume emitting particles.
  17731. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  17732. */
  17733. export interface IParticleEmitterType {
  17734. /**
  17735. * Called by the particle System when the direction is computed for the created particle.
  17736. * @param worldMatrix is the world matrix of the particle system
  17737. * @param directionToUpdate is the direction vector to update with the result
  17738. * @param particle is the particle we are computed the direction for
  17739. */
  17740. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  17741. /**
  17742. * Called by the particle System when the position is computed for the created particle.
  17743. * @param worldMatrix is the world matrix of the particle system
  17744. * @param positionToUpdate is the position vector to update with the result
  17745. * @param particle is the particle we are computed the position for
  17746. */
  17747. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  17748. /**
  17749. * Clones the current emitter and returns a copy of it
  17750. * @returns the new emitter
  17751. */
  17752. clone(): IParticleEmitterType;
  17753. /**
  17754. * Called by the GPUParticleSystem to setup the update shader
  17755. * @param effect defines the update shader
  17756. */
  17757. applyToShader(effect: Effect): void;
  17758. /**
  17759. * Returns a string to use to update the GPU particles update shader
  17760. * @returns the effect defines string
  17761. */
  17762. getEffectDefines(): string;
  17763. /**
  17764. * Returns a string representing the class name
  17765. * @returns a string containing the class name
  17766. */
  17767. getClassName(): string;
  17768. /**
  17769. * Serializes the particle system to a JSON object.
  17770. * @returns the JSON object
  17771. */
  17772. serialize(): any;
  17773. /**
  17774. * Parse properties from a JSON object
  17775. * @param serializationObject defines the JSON object
  17776. */
  17777. parse(serializationObject: any): void;
  17778. }
  17779. }
  17780. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  17781. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17782. import { Effect } from "babylonjs/Materials/effect";
  17783. import { Particle } from "babylonjs/Particles/particle";
  17784. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  17785. /**
  17786. * Particle emitter emitting particles from the inside of a box.
  17787. * It emits the particles randomly between 2 given directions.
  17788. */
  17789. export class BoxParticleEmitter implements IParticleEmitterType {
  17790. /**
  17791. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17792. */
  17793. direction1: Vector3;
  17794. /**
  17795. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17796. */
  17797. direction2: Vector3;
  17798. /**
  17799. * 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.
  17800. */
  17801. minEmitBox: Vector3;
  17802. /**
  17803. * 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.
  17804. */
  17805. maxEmitBox: Vector3;
  17806. /**
  17807. * Creates a new instance BoxParticleEmitter
  17808. */
  17809. constructor();
  17810. /**
  17811. * Called by the particle System when the direction is computed for the created particle.
  17812. * @param worldMatrix is the world matrix of the particle system
  17813. * @param directionToUpdate is the direction vector to update with the result
  17814. * @param particle is the particle we are computed the direction for
  17815. */
  17816. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  17817. /**
  17818. * Called by the particle System when the position is computed for the created particle.
  17819. * @param worldMatrix is the world matrix of the particle system
  17820. * @param positionToUpdate is the position vector to update with the result
  17821. * @param particle is the particle we are computed the position for
  17822. */
  17823. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  17824. /**
  17825. * Clones the current emitter and returns a copy of it
  17826. * @returns the new emitter
  17827. */
  17828. clone(): BoxParticleEmitter;
  17829. /**
  17830. * Called by the GPUParticleSystem to setup the update shader
  17831. * @param effect defines the update shader
  17832. */
  17833. applyToShader(effect: Effect): void;
  17834. /**
  17835. * Returns a string to use to update the GPU particles update shader
  17836. * @returns a string containng the defines string
  17837. */
  17838. getEffectDefines(): string;
  17839. /**
  17840. * Returns the string "BoxParticleEmitter"
  17841. * @returns a string containing the class name
  17842. */
  17843. getClassName(): string;
  17844. /**
  17845. * Serializes the particle system to a JSON object.
  17846. * @returns the JSON object
  17847. */
  17848. serialize(): any;
  17849. /**
  17850. * Parse properties from a JSON object
  17851. * @param serializationObject defines the JSON object
  17852. */
  17853. parse(serializationObject: any): void;
  17854. }
  17855. }
  17856. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  17857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17858. import { Effect } from "babylonjs/Materials/effect";
  17859. import { Particle } from "babylonjs/Particles/particle";
  17860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  17861. /**
  17862. * Particle emitter emitting particles from the inside of a cone.
  17863. * It emits the particles alongside the cone volume from the base to the particle.
  17864. * The emission direction might be randomized.
  17865. */
  17866. export class ConeParticleEmitter implements IParticleEmitterType {
  17867. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  17868. directionRandomizer: number;
  17869. private _radius;
  17870. private _angle;
  17871. private _height;
  17872. /**
  17873. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  17874. */
  17875. radiusRange: number;
  17876. /**
  17877. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  17878. */
  17879. heightRange: number;
  17880. /**
  17881. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  17882. */
  17883. emitFromSpawnPointOnly: boolean;
  17884. /**
  17885. * Gets or sets the radius of the emission cone
  17886. */
  17887. radius: number;
  17888. /**
  17889. * Gets or sets the angle of the emission cone
  17890. */
  17891. angle: number;
  17892. private _buildHeight;
  17893. /**
  17894. * Creates a new instance ConeParticleEmitter
  17895. * @param radius the radius of the emission cone (1 by default)
  17896. * @param angle the cone base angle (PI by default)
  17897. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  17898. */
  17899. constructor(radius?: number, angle?: number,
  17900. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  17901. directionRandomizer?: number);
  17902. /**
  17903. * Called by the particle System when the direction is computed for the created particle.
  17904. * @param worldMatrix is the world matrix of the particle system
  17905. * @param directionToUpdate is the direction vector to update with the result
  17906. * @param particle is the particle we are computed the direction for
  17907. */
  17908. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  17909. /**
  17910. * Called by the particle System when the position is computed for the created particle.
  17911. * @param worldMatrix is the world matrix of the particle system
  17912. * @param positionToUpdate is the position vector to update with the result
  17913. * @param particle is the particle we are computed the position for
  17914. */
  17915. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  17916. /**
  17917. * Clones the current emitter and returns a copy of it
  17918. * @returns the new emitter
  17919. */
  17920. clone(): ConeParticleEmitter;
  17921. /**
  17922. * Called by the GPUParticleSystem to setup the update shader
  17923. * @param effect defines the update shader
  17924. */
  17925. applyToShader(effect: Effect): void;
  17926. /**
  17927. * Returns a string to use to update the GPU particles update shader
  17928. * @returns a string containng the defines string
  17929. */
  17930. getEffectDefines(): string;
  17931. /**
  17932. * Returns the string "ConeParticleEmitter"
  17933. * @returns a string containing the class name
  17934. */
  17935. getClassName(): string;
  17936. /**
  17937. * Serializes the particle system to a JSON object.
  17938. * @returns the JSON object
  17939. */
  17940. serialize(): any;
  17941. /**
  17942. * Parse properties from a JSON object
  17943. * @param serializationObject defines the JSON object
  17944. */
  17945. parse(serializationObject: any): void;
  17946. }
  17947. }
  17948. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  17949. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17950. import { Effect } from "babylonjs/Materials/effect";
  17951. import { Particle } from "babylonjs/Particles/particle";
  17952. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  17953. /**
  17954. * Particle emitter emitting particles from the inside of a cylinder.
  17955. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  17956. */
  17957. export class CylinderParticleEmitter implements IParticleEmitterType {
  17958. /**
  17959. * The radius of the emission cylinder.
  17960. */
  17961. radius: number;
  17962. /**
  17963. * The height of the emission cylinder.
  17964. */
  17965. height: number;
  17966. /**
  17967. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  17968. */
  17969. radiusRange: number;
  17970. /**
  17971. * How much to randomize the particle direction [0-1].
  17972. */
  17973. directionRandomizer: number;
  17974. /**
  17975. * Creates a new instance CylinderParticleEmitter
  17976. * @param radius the radius of the emission cylinder (1 by default)
  17977. * @param height the height of the emission cylinder (1 by default)
  17978. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17979. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  17980. */
  17981. constructor(
  17982. /**
  17983. * The radius of the emission cylinder.
  17984. */
  17985. radius?: number,
  17986. /**
  17987. * The height of the emission cylinder.
  17988. */
  17989. height?: number,
  17990. /**
  17991. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  17992. */
  17993. radiusRange?: number,
  17994. /**
  17995. * How much to randomize the particle direction [0-1].
  17996. */
  17997. directionRandomizer?: number);
  17998. /**
  17999. * Called by the particle System when the direction is computed for the created particle.
  18000. * @param worldMatrix is the world matrix of the particle system
  18001. * @param directionToUpdate is the direction vector to update with the result
  18002. * @param particle is the particle we are computed the direction for
  18003. */
  18004. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18005. /**
  18006. * Called by the particle System when the position is computed for the created particle.
  18007. * @param worldMatrix is the world matrix of the particle system
  18008. * @param positionToUpdate is the position vector to update with the result
  18009. * @param particle is the particle we are computed the position for
  18010. */
  18011. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18012. /**
  18013. * Clones the current emitter and returns a copy of it
  18014. * @returns the new emitter
  18015. */
  18016. clone(): CylinderParticleEmitter;
  18017. /**
  18018. * Called by the GPUParticleSystem to setup the update shader
  18019. * @param effect defines the update shader
  18020. */
  18021. applyToShader(effect: Effect): void;
  18022. /**
  18023. * Returns a string to use to update the GPU particles update shader
  18024. * @returns a string containng the defines string
  18025. */
  18026. getEffectDefines(): string;
  18027. /**
  18028. * Returns the string "CylinderParticleEmitter"
  18029. * @returns a string containing the class name
  18030. */
  18031. getClassName(): string;
  18032. /**
  18033. * Serializes the particle system to a JSON object.
  18034. * @returns the JSON object
  18035. */
  18036. serialize(): any;
  18037. /**
  18038. * Parse properties from a JSON object
  18039. * @param serializationObject defines the JSON object
  18040. */
  18041. parse(serializationObject: any): void;
  18042. }
  18043. /**
  18044. * Particle emitter emitting particles from the inside of a cylinder.
  18045. * It emits the particles randomly between two vectors.
  18046. */
  18047. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18048. /**
  18049. * The min limit of the emission direction.
  18050. */
  18051. direction1: Vector3;
  18052. /**
  18053. * The max limit of the emission direction.
  18054. */
  18055. direction2: Vector3;
  18056. /**
  18057. * Creates a new instance CylinderDirectedParticleEmitter
  18058. * @param radius the radius of the emission cylinder (1 by default)
  18059. * @param height the height of the emission cylinder (1 by default)
  18060. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18061. * @param direction1 the min limit of the emission direction (up vector by default)
  18062. * @param direction2 the max limit of the emission direction (up vector by default)
  18063. */
  18064. constructor(radius?: number, height?: number, radiusRange?: number,
  18065. /**
  18066. * The min limit of the emission direction.
  18067. */
  18068. direction1?: Vector3,
  18069. /**
  18070. * The max limit of the emission direction.
  18071. */
  18072. direction2?: Vector3);
  18073. /**
  18074. * Called by the particle System when the direction is computed for the created particle.
  18075. * @param worldMatrix is the world matrix of the particle system
  18076. * @param directionToUpdate is the direction vector to update with the result
  18077. * @param particle is the particle we are computed the direction for
  18078. */
  18079. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18080. /**
  18081. * Clones the current emitter and returns a copy of it
  18082. * @returns the new emitter
  18083. */
  18084. clone(): CylinderDirectedParticleEmitter;
  18085. /**
  18086. * Called by the GPUParticleSystem to setup the update shader
  18087. * @param effect defines the update shader
  18088. */
  18089. applyToShader(effect: Effect): void;
  18090. /**
  18091. * Returns a string to use to update the GPU particles update shader
  18092. * @returns a string containng the defines string
  18093. */
  18094. getEffectDefines(): string;
  18095. /**
  18096. * Returns the string "CylinderDirectedParticleEmitter"
  18097. * @returns a string containing the class name
  18098. */
  18099. getClassName(): string;
  18100. /**
  18101. * Serializes the particle system to a JSON object.
  18102. * @returns the JSON object
  18103. */
  18104. serialize(): any;
  18105. /**
  18106. * Parse properties from a JSON object
  18107. * @param serializationObject defines the JSON object
  18108. */
  18109. parse(serializationObject: any): void;
  18110. }
  18111. }
  18112. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18113. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18114. import { Effect } from "babylonjs/Materials/effect";
  18115. import { Particle } from "babylonjs/Particles/particle";
  18116. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18117. /**
  18118. * Particle emitter emitting particles from the inside of a hemisphere.
  18119. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18120. */
  18121. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18122. /**
  18123. * The radius of the emission hemisphere.
  18124. */
  18125. radius: number;
  18126. /**
  18127. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18128. */
  18129. radiusRange: number;
  18130. /**
  18131. * How much to randomize the particle direction [0-1].
  18132. */
  18133. directionRandomizer: number;
  18134. /**
  18135. * Creates a new instance HemisphericParticleEmitter
  18136. * @param radius the radius of the emission hemisphere (1 by default)
  18137. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18138. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18139. */
  18140. constructor(
  18141. /**
  18142. * The radius of the emission hemisphere.
  18143. */
  18144. radius?: number,
  18145. /**
  18146. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18147. */
  18148. radiusRange?: number,
  18149. /**
  18150. * How much to randomize the particle direction [0-1].
  18151. */
  18152. directionRandomizer?: number);
  18153. /**
  18154. * Called by the particle System when the direction is computed for the created particle.
  18155. * @param worldMatrix is the world matrix of the particle system
  18156. * @param directionToUpdate is the direction vector to update with the result
  18157. * @param particle is the particle we are computed the direction for
  18158. */
  18159. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18160. /**
  18161. * Called by the particle System when the position is computed for the created particle.
  18162. * @param worldMatrix is the world matrix of the particle system
  18163. * @param positionToUpdate is the position vector to update with the result
  18164. * @param particle is the particle we are computed the position for
  18165. */
  18166. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18167. /**
  18168. * Clones the current emitter and returns a copy of it
  18169. * @returns the new emitter
  18170. */
  18171. clone(): HemisphericParticleEmitter;
  18172. /**
  18173. * Called by the GPUParticleSystem to setup the update shader
  18174. * @param effect defines the update shader
  18175. */
  18176. applyToShader(effect: Effect): void;
  18177. /**
  18178. * Returns a string to use to update the GPU particles update shader
  18179. * @returns a string containng the defines string
  18180. */
  18181. getEffectDefines(): string;
  18182. /**
  18183. * Returns the string "HemisphericParticleEmitter"
  18184. * @returns a string containing the class name
  18185. */
  18186. getClassName(): string;
  18187. /**
  18188. * Serializes the particle system to a JSON object.
  18189. * @returns the JSON object
  18190. */
  18191. serialize(): any;
  18192. /**
  18193. * Parse properties from a JSON object
  18194. * @param serializationObject defines the JSON object
  18195. */
  18196. parse(serializationObject: any): void;
  18197. }
  18198. }
  18199. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18200. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18201. import { Effect } from "babylonjs/Materials/effect";
  18202. import { Particle } from "babylonjs/Particles/particle";
  18203. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18204. /**
  18205. * Particle emitter emitting particles from a point.
  18206. * It emits the particles randomly between 2 given directions.
  18207. */
  18208. export class PointParticleEmitter implements IParticleEmitterType {
  18209. /**
  18210. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18211. */
  18212. direction1: Vector3;
  18213. /**
  18214. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18215. */
  18216. direction2: Vector3;
  18217. /**
  18218. * Creates a new instance PointParticleEmitter
  18219. */
  18220. constructor();
  18221. /**
  18222. * Called by the particle System when the direction is computed for the created particle.
  18223. * @param worldMatrix is the world matrix of the particle system
  18224. * @param directionToUpdate is the direction vector to update with the result
  18225. * @param particle is the particle we are computed the direction for
  18226. */
  18227. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18228. /**
  18229. * Called by the particle System when the position is computed for the created particle.
  18230. * @param worldMatrix is the world matrix of the particle system
  18231. * @param positionToUpdate is the position vector to update with the result
  18232. * @param particle is the particle we are computed the position for
  18233. */
  18234. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18235. /**
  18236. * Clones the current emitter and returns a copy of it
  18237. * @returns the new emitter
  18238. */
  18239. clone(): PointParticleEmitter;
  18240. /**
  18241. * Called by the GPUParticleSystem to setup the update shader
  18242. * @param effect defines the update shader
  18243. */
  18244. applyToShader(effect: Effect): void;
  18245. /**
  18246. * Returns a string to use to update the GPU particles update shader
  18247. * @returns a string containng the defines string
  18248. */
  18249. getEffectDefines(): string;
  18250. /**
  18251. * Returns the string "PointParticleEmitter"
  18252. * @returns a string containing the class name
  18253. */
  18254. getClassName(): string;
  18255. /**
  18256. * Serializes the particle system to a JSON object.
  18257. * @returns the JSON object
  18258. */
  18259. serialize(): any;
  18260. /**
  18261. * Parse properties from a JSON object
  18262. * @param serializationObject defines the JSON object
  18263. */
  18264. parse(serializationObject: any): void;
  18265. }
  18266. }
  18267. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18268. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18269. import { Effect } from "babylonjs/Materials/effect";
  18270. import { Particle } from "babylonjs/Particles/particle";
  18271. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18272. /**
  18273. * Particle emitter emitting particles from the inside of a sphere.
  18274. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18275. */
  18276. export class SphereParticleEmitter implements IParticleEmitterType {
  18277. /**
  18278. * The radius of the emission sphere.
  18279. */
  18280. radius: number;
  18281. /**
  18282. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18283. */
  18284. radiusRange: number;
  18285. /**
  18286. * How much to randomize the particle direction [0-1].
  18287. */
  18288. directionRandomizer: number;
  18289. /**
  18290. * Creates a new instance SphereParticleEmitter
  18291. * @param radius the radius of the emission sphere (1 by default)
  18292. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18293. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18294. */
  18295. constructor(
  18296. /**
  18297. * The radius of the emission sphere.
  18298. */
  18299. radius?: number,
  18300. /**
  18301. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18302. */
  18303. radiusRange?: number,
  18304. /**
  18305. * How much to randomize the particle direction [0-1].
  18306. */
  18307. directionRandomizer?: number);
  18308. /**
  18309. * Called by the particle System when the direction is computed for the created particle.
  18310. * @param worldMatrix is the world matrix of the particle system
  18311. * @param directionToUpdate is the direction vector to update with the result
  18312. * @param particle is the particle we are computed the direction for
  18313. */
  18314. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18315. /**
  18316. * Called by the particle System when the position is computed for the created particle.
  18317. * @param worldMatrix is the world matrix of the particle system
  18318. * @param positionToUpdate is the position vector to update with the result
  18319. * @param particle is the particle we are computed the position for
  18320. */
  18321. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18322. /**
  18323. * Clones the current emitter and returns a copy of it
  18324. * @returns the new emitter
  18325. */
  18326. clone(): SphereParticleEmitter;
  18327. /**
  18328. * Called by the GPUParticleSystem to setup the update shader
  18329. * @param effect defines the update shader
  18330. */
  18331. applyToShader(effect: Effect): void;
  18332. /**
  18333. * Returns a string to use to update the GPU particles update shader
  18334. * @returns a string containng the defines string
  18335. */
  18336. getEffectDefines(): string;
  18337. /**
  18338. * Returns the string "SphereParticleEmitter"
  18339. * @returns a string containing the class name
  18340. */
  18341. getClassName(): string;
  18342. /**
  18343. * Serializes the particle system to a JSON object.
  18344. * @returns the JSON object
  18345. */
  18346. serialize(): any;
  18347. /**
  18348. * Parse properties from a JSON object
  18349. * @param serializationObject defines the JSON object
  18350. */
  18351. parse(serializationObject: any): void;
  18352. }
  18353. /**
  18354. * Particle emitter emitting particles from the inside of a sphere.
  18355. * It emits the particles randomly between two vectors.
  18356. */
  18357. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18358. /**
  18359. * The min limit of the emission direction.
  18360. */
  18361. direction1: Vector3;
  18362. /**
  18363. * The max limit of the emission direction.
  18364. */
  18365. direction2: Vector3;
  18366. /**
  18367. * Creates a new instance SphereDirectedParticleEmitter
  18368. * @param radius the radius of the emission sphere (1 by default)
  18369. * @param direction1 the min limit of the emission direction (up vector by default)
  18370. * @param direction2 the max limit of the emission direction (up vector by default)
  18371. */
  18372. constructor(radius?: number,
  18373. /**
  18374. * The min limit of the emission direction.
  18375. */
  18376. direction1?: Vector3,
  18377. /**
  18378. * The max limit of the emission direction.
  18379. */
  18380. direction2?: Vector3);
  18381. /**
  18382. * Called by the particle System when the direction is computed for the created particle.
  18383. * @param worldMatrix is the world matrix of the particle system
  18384. * @param directionToUpdate is the direction vector to update with the result
  18385. * @param particle is the particle we are computed the direction for
  18386. */
  18387. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18388. /**
  18389. * Clones the current emitter and returns a copy of it
  18390. * @returns the new emitter
  18391. */
  18392. clone(): SphereDirectedParticleEmitter;
  18393. /**
  18394. * Called by the GPUParticleSystem to setup the update shader
  18395. * @param effect defines the update shader
  18396. */
  18397. applyToShader(effect: Effect): void;
  18398. /**
  18399. * Returns a string to use to update the GPU particles update shader
  18400. * @returns a string containng the defines string
  18401. */
  18402. getEffectDefines(): string;
  18403. /**
  18404. * Returns the string "SphereDirectedParticleEmitter"
  18405. * @returns a string containing the class name
  18406. */
  18407. getClassName(): string;
  18408. /**
  18409. * Serializes the particle system to a JSON object.
  18410. * @returns the JSON object
  18411. */
  18412. serialize(): any;
  18413. /**
  18414. * Parse properties from a JSON object
  18415. * @param serializationObject defines the JSON object
  18416. */
  18417. parse(serializationObject: any): void;
  18418. }
  18419. }
  18420. declare module "babylonjs/Particles/EmitterTypes/index" {
  18421. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18422. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18423. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18424. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18425. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18426. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18427. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18428. }
  18429. declare module "babylonjs/Particles/IParticleSystem" {
  18430. import { Nullable } from "babylonjs/types";
  18431. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18432. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18433. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18434. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18435. import { Texture } from "babylonjs/Materials/Textures/texture";
  18436. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18437. import { Scene } from "babylonjs/scene";
  18438. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18439. import { Animation } from "babylonjs/Animations/animation";
  18440. /**
  18441. * Interface representing a particle system in Babylon.js.
  18442. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18443. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18444. */
  18445. export interface IParticleSystem {
  18446. /**
  18447. * List of animations used by the particle system.
  18448. */
  18449. animations: Animation[];
  18450. /**
  18451. * The id of the Particle system.
  18452. */
  18453. id: string;
  18454. /**
  18455. * The name of the Particle system.
  18456. */
  18457. name: string;
  18458. /**
  18459. * The emitter represents the Mesh or position we are attaching the particle system to.
  18460. */
  18461. emitter: Nullable<AbstractMesh | Vector3>;
  18462. /**
  18463. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18464. */
  18465. isBillboardBased: boolean;
  18466. /**
  18467. * The rendering group used by the Particle system to chose when to render.
  18468. */
  18469. renderingGroupId: number;
  18470. /**
  18471. * The layer mask we are rendering the particles through.
  18472. */
  18473. layerMask: number;
  18474. /**
  18475. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18476. */
  18477. updateSpeed: number;
  18478. /**
  18479. * The amount of time the particle system is running (depends of the overall update speed).
  18480. */
  18481. targetStopDuration: number;
  18482. /**
  18483. * The texture used to render each particle. (this can be a spritesheet)
  18484. */
  18485. particleTexture: Nullable<Texture>;
  18486. /**
  18487. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18488. */
  18489. blendMode: number;
  18490. /**
  18491. * Minimum life time of emitting particles.
  18492. */
  18493. minLifeTime: number;
  18494. /**
  18495. * Maximum life time of emitting particles.
  18496. */
  18497. maxLifeTime: number;
  18498. /**
  18499. * Minimum Size of emitting particles.
  18500. */
  18501. minSize: number;
  18502. /**
  18503. * Maximum Size of emitting particles.
  18504. */
  18505. maxSize: number;
  18506. /**
  18507. * Minimum scale of emitting particles on X axis.
  18508. */
  18509. minScaleX: number;
  18510. /**
  18511. * Maximum scale of emitting particles on X axis.
  18512. */
  18513. maxScaleX: number;
  18514. /**
  18515. * Minimum scale of emitting particles on Y axis.
  18516. */
  18517. minScaleY: number;
  18518. /**
  18519. * Maximum scale of emitting particles on Y axis.
  18520. */
  18521. maxScaleY: number;
  18522. /**
  18523. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18524. */
  18525. color1: Color4;
  18526. /**
  18527. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18528. */
  18529. color2: Color4;
  18530. /**
  18531. * Color the particle will have at the end of its lifetime.
  18532. */
  18533. colorDead: Color4;
  18534. /**
  18535. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  18536. */
  18537. emitRate: number;
  18538. /**
  18539. * You can use gravity if you want to give an orientation to your particles.
  18540. */
  18541. gravity: Vector3;
  18542. /**
  18543. * Minimum power of emitting particles.
  18544. */
  18545. minEmitPower: number;
  18546. /**
  18547. * Maximum power of emitting particles.
  18548. */
  18549. maxEmitPower: number;
  18550. /**
  18551. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  18552. */
  18553. minAngularSpeed: number;
  18554. /**
  18555. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  18556. */
  18557. maxAngularSpeed: number;
  18558. /**
  18559. * Gets or sets the minimal initial rotation in radians.
  18560. */
  18561. minInitialRotation: number;
  18562. /**
  18563. * Gets or sets the maximal initial rotation in radians.
  18564. */
  18565. maxInitialRotation: number;
  18566. /**
  18567. * The particle emitter type defines the emitter used by the particle system.
  18568. * It can be for example box, sphere, or cone...
  18569. */
  18570. particleEmitterType: Nullable<IParticleEmitterType>;
  18571. /**
  18572. * Defines the delay in milliseconds before starting the system (0 by default)
  18573. */
  18574. startDelay: number;
  18575. /**
  18576. * 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
  18577. */
  18578. preWarmCycles: number;
  18579. /**
  18580. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  18581. */
  18582. preWarmStepOffset: number;
  18583. /**
  18584. * 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)
  18585. */
  18586. spriteCellChangeSpeed: number;
  18587. /**
  18588. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  18589. */
  18590. startSpriteCellID: number;
  18591. /**
  18592. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  18593. */
  18594. endSpriteCellID: number;
  18595. /**
  18596. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  18597. */
  18598. spriteCellWidth: number;
  18599. /**
  18600. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  18601. */
  18602. spriteCellHeight: number;
  18603. /**
  18604. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  18605. */
  18606. spriteRandomStartCell: boolean;
  18607. /**
  18608. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  18609. */
  18610. isAnimationSheetEnabled: boolean;
  18611. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  18612. translationPivot: Vector2;
  18613. /**
  18614. * Gets or sets a texture used to add random noise to particle positions
  18615. */
  18616. noiseTexture: Nullable<BaseTexture>;
  18617. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  18618. noiseStrength: Vector3;
  18619. /**
  18620. * Gets or sets the billboard mode to use when isBillboardBased = true.
  18621. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  18622. */
  18623. billboardMode: number;
  18624. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  18625. limitVelocityDamping: number;
  18626. /**
  18627. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  18628. */
  18629. beginAnimationOnStart: boolean;
  18630. /**
  18631. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  18632. */
  18633. beginAnimationFrom: number;
  18634. /**
  18635. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  18636. */
  18637. beginAnimationTo: number;
  18638. /**
  18639. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  18640. */
  18641. beginAnimationLoop: boolean;
  18642. /**
  18643. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  18644. */
  18645. disposeOnStop: boolean;
  18646. /**
  18647. * Gets the maximum number of particles active at the same time.
  18648. * @returns The max number of active particles.
  18649. */
  18650. getCapacity(): number;
  18651. /**
  18652. * Gets if the system has been started. (Note: this will still be true after stop is called)
  18653. * @returns True if it has been started, otherwise false.
  18654. */
  18655. isStarted(): boolean;
  18656. /**
  18657. * Animates the particle system for this frame.
  18658. */
  18659. animate(): void;
  18660. /**
  18661. * Renders the particle system in its current state.
  18662. * @returns the current number of particles
  18663. */
  18664. render(): number;
  18665. /**
  18666. * Dispose the particle system and frees its associated resources.
  18667. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  18668. */
  18669. dispose(disposeTexture?: boolean): void;
  18670. /**
  18671. * Clones the particle system.
  18672. * @param name The name of the cloned object
  18673. * @param newEmitter The new emitter to use
  18674. * @returns the cloned particle system
  18675. */
  18676. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  18677. /**
  18678. * Serializes the particle system to a JSON object.
  18679. * @returns the JSON object
  18680. */
  18681. serialize(): any;
  18682. /**
  18683. * Rebuild the particle system
  18684. */
  18685. rebuild(): void;
  18686. /**
  18687. * Starts the particle system and begins to emit
  18688. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  18689. */
  18690. start(delay?: number): void;
  18691. /**
  18692. * Stops the particle system.
  18693. */
  18694. stop(): void;
  18695. /**
  18696. * Remove all active particles
  18697. */
  18698. reset(): void;
  18699. /**
  18700. * Is this system ready to be used/rendered
  18701. * @return true if the system is ready
  18702. */
  18703. isReady(): boolean;
  18704. /**
  18705. * Adds a new color gradient
  18706. * @param gradient defines the gradient to use (between 0 and 1)
  18707. * @param color1 defines the color to affect to the specified gradient
  18708. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  18709. * @returns the current particle system
  18710. */
  18711. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  18712. /**
  18713. * Remove a specific color gradient
  18714. * @param gradient defines the gradient to remove
  18715. * @returns the current particle system
  18716. */
  18717. removeColorGradient(gradient: number): IParticleSystem;
  18718. /**
  18719. * Adds a new size gradient
  18720. * @param gradient defines the gradient to use (between 0 and 1)
  18721. * @param factor defines the size factor to affect to the specified gradient
  18722. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18723. * @returns the current particle system
  18724. */
  18725. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18726. /**
  18727. * Remove a specific size gradient
  18728. * @param gradient defines the gradient to remove
  18729. * @returns the current particle system
  18730. */
  18731. removeSizeGradient(gradient: number): IParticleSystem;
  18732. /**
  18733. * Gets the current list of color gradients.
  18734. * You must use addColorGradient and removeColorGradient to udpate this list
  18735. * @returns the list of color gradients
  18736. */
  18737. getColorGradients(): Nullable<Array<ColorGradient>>;
  18738. /**
  18739. * Gets the current list of size gradients.
  18740. * You must use addSizeGradient and removeSizeGradient to udpate this list
  18741. * @returns the list of size gradients
  18742. */
  18743. getSizeGradients(): Nullable<Array<FactorGradient>>;
  18744. /**
  18745. * Gets the current list of angular speed gradients.
  18746. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  18747. * @returns the list of angular speed gradients
  18748. */
  18749. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  18750. /**
  18751. * Adds a new angular speed gradient
  18752. * @param gradient defines the gradient to use (between 0 and 1)
  18753. * @param factor defines the angular speed to affect to the specified gradient
  18754. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18755. * @returns the current particle system
  18756. */
  18757. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18758. /**
  18759. * Remove a specific angular speed gradient
  18760. * @param gradient defines the gradient to remove
  18761. * @returns the current particle system
  18762. */
  18763. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  18764. /**
  18765. * Gets the current list of velocity gradients.
  18766. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  18767. * @returns the list of velocity gradients
  18768. */
  18769. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  18770. /**
  18771. * Adds a new velocity gradient
  18772. * @param gradient defines the gradient to use (between 0 and 1)
  18773. * @param factor defines the velocity to affect to the specified gradient
  18774. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18775. * @returns the current particle system
  18776. */
  18777. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18778. /**
  18779. * Remove a specific velocity gradient
  18780. * @param gradient defines the gradient to remove
  18781. * @returns the current particle system
  18782. */
  18783. removeVelocityGradient(gradient: number): IParticleSystem;
  18784. /**
  18785. * Gets the current list of limit velocity gradients.
  18786. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  18787. * @returns the list of limit velocity gradients
  18788. */
  18789. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  18790. /**
  18791. * Adds a new limit velocity gradient
  18792. * @param gradient defines the gradient to use (between 0 and 1)
  18793. * @param factor defines the limit velocity to affect to the specified gradient
  18794. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18795. * @returns the current particle system
  18796. */
  18797. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18798. /**
  18799. * Remove a specific limit velocity gradient
  18800. * @param gradient defines the gradient to remove
  18801. * @returns the current particle system
  18802. */
  18803. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  18804. /**
  18805. * Adds a new drag gradient
  18806. * @param gradient defines the gradient to use (between 0 and 1)
  18807. * @param factor defines the drag to affect to the specified gradient
  18808. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18809. * @returns the current particle system
  18810. */
  18811. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18812. /**
  18813. * Remove a specific drag gradient
  18814. * @param gradient defines the gradient to remove
  18815. * @returns the current particle system
  18816. */
  18817. removeDragGradient(gradient: number): IParticleSystem;
  18818. /**
  18819. * Gets the current list of drag gradients.
  18820. * You must use addDragGradient and removeDragGradient to udpate this list
  18821. * @returns the list of drag gradients
  18822. */
  18823. getDragGradients(): Nullable<Array<FactorGradient>>;
  18824. /**
  18825. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  18826. * @param gradient defines the gradient to use (between 0 and 1)
  18827. * @param factor defines the emit rate to affect to the specified gradient
  18828. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18829. * @returns the current particle system
  18830. */
  18831. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18832. /**
  18833. * Remove a specific emit rate gradient
  18834. * @param gradient defines the gradient to remove
  18835. * @returns the current particle system
  18836. */
  18837. removeEmitRateGradient(gradient: number): IParticleSystem;
  18838. /**
  18839. * Gets the current list of emit rate gradients.
  18840. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  18841. * @returns the list of emit rate gradients
  18842. */
  18843. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  18844. /**
  18845. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  18846. * @param gradient defines the gradient to use (between 0 and 1)
  18847. * @param factor defines the start size to affect to the specified gradient
  18848. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18849. * @returns the current particle system
  18850. */
  18851. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18852. /**
  18853. * Remove a specific start size gradient
  18854. * @param gradient defines the gradient to remove
  18855. * @returns the current particle system
  18856. */
  18857. removeStartSizeGradient(gradient: number): IParticleSystem;
  18858. /**
  18859. * Gets the current list of start size gradients.
  18860. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  18861. * @returns the list of start size gradients
  18862. */
  18863. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  18864. /**
  18865. * Adds a new life time gradient
  18866. * @param gradient defines the gradient to use (between 0 and 1)
  18867. * @param factor defines the life time factor to affect to the specified gradient
  18868. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  18869. * @returns the current particle system
  18870. */
  18871. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  18872. /**
  18873. * Remove a specific life time gradient
  18874. * @param gradient defines the gradient to remove
  18875. * @returns the current particle system
  18876. */
  18877. removeLifeTimeGradient(gradient: number): IParticleSystem;
  18878. /**
  18879. * Gets the current list of life time gradients.
  18880. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  18881. * @returns the list of life time gradients
  18882. */
  18883. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  18884. /**
  18885. * Gets the current list of color gradients.
  18886. * You must use addColorGradient and removeColorGradient to udpate this list
  18887. * @returns the list of color gradients
  18888. */
  18889. getColorGradients(): Nullable<Array<ColorGradient>>;
  18890. /**
  18891. * Adds a new ramp gradient used to remap particle colors
  18892. * @param gradient defines the gradient to use (between 0 and 1)
  18893. * @param color defines the color to affect to the specified gradient
  18894. * @returns the current particle system
  18895. */
  18896. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  18897. /**
  18898. * Gets the current list of ramp gradients.
  18899. * You must use addRampGradient and removeRampGradient to udpate this list
  18900. * @returns the list of ramp gradients
  18901. */
  18902. getRampGradients(): Nullable<Array<Color3Gradient>>;
  18903. /** Gets or sets a boolean indicating that ramp gradients must be used
  18904. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  18905. */
  18906. useRampGradients: boolean;
  18907. /**
  18908. * Adds a new color remap gradient
  18909. * @param gradient defines the gradient to use (between 0 and 1)
  18910. * @param min defines the color remap minimal range
  18911. * @param max defines the color remap maximal range
  18912. * @returns the current particle system
  18913. */
  18914. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  18915. /**
  18916. * Gets the current list of color remap gradients.
  18917. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  18918. * @returns the list of color remap gradients
  18919. */
  18920. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  18921. /**
  18922. * Adds a new alpha remap gradient
  18923. * @param gradient defines the gradient to use (between 0 and 1)
  18924. * @param min defines the alpha remap minimal range
  18925. * @param max defines the alpha remap maximal range
  18926. * @returns the current particle system
  18927. */
  18928. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  18929. /**
  18930. * Gets the current list of alpha remap gradients.
  18931. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  18932. * @returns the list of alpha remap gradients
  18933. */
  18934. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  18935. /**
  18936. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  18937. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  18938. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  18939. * @returns the emitter
  18940. */
  18941. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  18942. /**
  18943. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  18944. * @param radius The radius of the hemisphere to emit from
  18945. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  18946. * @returns the emitter
  18947. */
  18948. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  18949. /**
  18950. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  18951. * @param radius The radius of the sphere to emit from
  18952. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  18953. * @returns the emitter
  18954. */
  18955. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  18956. /**
  18957. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  18958. * @param radius The radius of the sphere to emit from
  18959. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  18960. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  18961. * @returns the emitter
  18962. */
  18963. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  18964. /**
  18965. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  18966. * @param radius The radius of the emission cylinder
  18967. * @param height The height of the emission cylinder
  18968. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  18969. * @param directionRandomizer How much to randomize the particle direction [0-1]
  18970. * @returns the emitter
  18971. */
  18972. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  18973. /**
  18974. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  18975. * @param radius The radius of the cylinder to emit from
  18976. * @param height The height of the emission cylinder
  18977. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18978. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  18979. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  18980. * @returns the emitter
  18981. */
  18982. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  18983. /**
  18984. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  18985. * @param radius The radius of the cone to emit from
  18986. * @param angle The base angle of the cone
  18987. * @returns the emitter
  18988. */
  18989. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  18990. /**
  18991. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  18992. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  18993. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  18994. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  18995. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  18996. * @returns the emitter
  18997. */
  18998. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  18999. /**
  19000. * Get hosting scene
  19001. * @returns the scene
  19002. */
  19003. getScene(): Scene;
  19004. }
  19005. }
  19006. declare module "babylonjs/Meshes/instancedMesh" {
  19007. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19008. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19009. import { Camera } from "babylonjs/Cameras/camera";
  19010. import { Node } from "babylonjs/node";
  19011. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19012. import { Mesh } from "babylonjs/Meshes/mesh";
  19013. import { Material } from "babylonjs/Materials/material";
  19014. import { Skeleton } from "babylonjs/Bones/skeleton";
  19015. import { Light } from "babylonjs/Lights/light";
  19016. /**
  19017. * Creates an instance based on a source mesh.
  19018. */
  19019. export class InstancedMesh extends AbstractMesh {
  19020. private _sourceMesh;
  19021. private _currentLOD;
  19022. /** @hidden */
  19023. _indexInSourceMeshInstanceArray: number;
  19024. constructor(name: string, source: Mesh);
  19025. /**
  19026. * Returns the string "InstancedMesh".
  19027. */
  19028. getClassName(): string;
  19029. /** Gets the list of lights affecting that mesh */
  19030. readonly lightSources: Light[];
  19031. _resyncLightSources(): void;
  19032. _resyncLighSource(light: Light): void;
  19033. _removeLightSource(light: Light): void;
  19034. /**
  19035. * If the source mesh receives shadows
  19036. */
  19037. readonly receiveShadows: boolean;
  19038. /**
  19039. * The material of the source mesh
  19040. */
  19041. readonly material: Nullable<Material>;
  19042. /**
  19043. * Visibility of the source mesh
  19044. */
  19045. readonly visibility: number;
  19046. /**
  19047. * Skeleton of the source mesh
  19048. */
  19049. readonly skeleton: Nullable<Skeleton>;
  19050. /**
  19051. * Rendering ground id of the source mesh
  19052. */
  19053. renderingGroupId: number;
  19054. /**
  19055. * Returns the total number of vertices (integer).
  19056. */
  19057. getTotalVertices(): number;
  19058. /**
  19059. * Returns a positive integer : the total number of indices in this mesh geometry.
  19060. * @returns the numner of indices or zero if the mesh has no geometry.
  19061. */
  19062. getTotalIndices(): number;
  19063. /**
  19064. * The source mesh of the instance
  19065. */
  19066. readonly sourceMesh: Mesh;
  19067. /**
  19068. * Is this node ready to be used/rendered
  19069. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19070. * @return {boolean} is it ready
  19071. */
  19072. isReady(completeCheck?: boolean): boolean;
  19073. /**
  19074. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19075. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19076. * @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.
  19077. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19078. */
  19079. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19080. /**
  19081. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19082. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19083. * The `data` are either a numeric array either a Float32Array.
  19084. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19085. * 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).
  19086. * Note that a new underlying VertexBuffer object is created each call.
  19087. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19088. *
  19089. * Possible `kind` values :
  19090. * - VertexBuffer.PositionKind
  19091. * - VertexBuffer.UVKind
  19092. * - VertexBuffer.UV2Kind
  19093. * - VertexBuffer.UV3Kind
  19094. * - VertexBuffer.UV4Kind
  19095. * - VertexBuffer.UV5Kind
  19096. * - VertexBuffer.UV6Kind
  19097. * - VertexBuffer.ColorKind
  19098. * - VertexBuffer.MatricesIndicesKind
  19099. * - VertexBuffer.MatricesIndicesExtraKind
  19100. * - VertexBuffer.MatricesWeightsKind
  19101. * - VertexBuffer.MatricesWeightsExtraKind
  19102. *
  19103. * Returns the Mesh.
  19104. */
  19105. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): Mesh;
  19106. /**
  19107. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19108. * If the mesh has no geometry, it is simply returned as it is.
  19109. * The `data` are either a numeric array either a Float32Array.
  19110. * No new underlying VertexBuffer object is created.
  19111. * 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.
  19112. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19113. *
  19114. * Possible `kind` values :
  19115. * - VertexBuffer.PositionKind
  19116. * - VertexBuffer.UVKind
  19117. * - VertexBuffer.UV2Kind
  19118. * - VertexBuffer.UV3Kind
  19119. * - VertexBuffer.UV4Kind
  19120. * - VertexBuffer.UV5Kind
  19121. * - VertexBuffer.UV6Kind
  19122. * - VertexBuffer.ColorKind
  19123. * - VertexBuffer.MatricesIndicesKind
  19124. * - VertexBuffer.MatricesIndicesExtraKind
  19125. * - VertexBuffer.MatricesWeightsKind
  19126. * - VertexBuffer.MatricesWeightsExtraKind
  19127. *
  19128. * Returns the Mesh.
  19129. */
  19130. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19131. /**
  19132. * Sets the mesh indices.
  19133. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19134. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19135. * This method creates a new index buffer each call.
  19136. * Returns the Mesh.
  19137. */
  19138. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19139. /**
  19140. * Boolean : True if the mesh owns the requested kind of data.
  19141. */
  19142. isVerticesDataPresent(kind: string): boolean;
  19143. /**
  19144. * Returns an array of indices (IndicesArray).
  19145. */
  19146. getIndices(): Nullable<IndicesArray>;
  19147. readonly _positions: Nullable<Vector3[]>;
  19148. /**
  19149. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19150. * This means the mesh underlying bounding box and sphere are recomputed.
  19151. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19152. * @returns the current mesh
  19153. */
  19154. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19155. /** @hidden */
  19156. _preActivate(): InstancedMesh;
  19157. /** @hidden */
  19158. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19159. /** @hidden */
  19160. _postActivate(): void;
  19161. getWorldMatrix(): Matrix;
  19162. readonly isAnInstance: boolean;
  19163. /**
  19164. * Returns the current associated LOD AbstractMesh.
  19165. */
  19166. getLOD(camera: Camera): AbstractMesh;
  19167. /** @hidden */
  19168. _syncSubMeshes(): InstancedMesh;
  19169. /** @hidden */
  19170. _generatePointsArray(): boolean;
  19171. /**
  19172. * Creates a new InstancedMesh from the current mesh.
  19173. * - name (string) : the cloned mesh name
  19174. * - newParent (optional Node) : the optional Node to parent the clone to.
  19175. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19176. *
  19177. * Returns the clone.
  19178. */
  19179. clone(name: string, newParent?: Node, doNotCloneChildren?: boolean): InstancedMesh;
  19180. /**
  19181. * Disposes the InstancedMesh.
  19182. * Returns nothing.
  19183. */
  19184. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19185. }
  19186. }
  19187. declare module "babylonjs/Materials/shaderMaterial" {
  19188. import { Scene } from "babylonjs/scene";
  19189. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19190. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19191. import { Mesh } from "babylonjs/Meshes/mesh";
  19192. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19193. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19194. import { Texture } from "babylonjs/Materials/Textures/texture";
  19195. import { Material } from "babylonjs/Materials/material";
  19196. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19197. /**
  19198. * Defines the options associated with the creation of a shader material.
  19199. */
  19200. export interface IShaderMaterialOptions {
  19201. /**
  19202. * Does the material work in alpha blend mode
  19203. */
  19204. needAlphaBlending: boolean;
  19205. /**
  19206. * Does the material work in alpha test mode
  19207. */
  19208. needAlphaTesting: boolean;
  19209. /**
  19210. * The list of attribute names used in the shader
  19211. */
  19212. attributes: string[];
  19213. /**
  19214. * The list of unifrom names used in the shader
  19215. */
  19216. uniforms: string[];
  19217. /**
  19218. * The list of UBO names used in the shader
  19219. */
  19220. uniformBuffers: string[];
  19221. /**
  19222. * The list of sampler names used in the shader
  19223. */
  19224. samplers: string[];
  19225. /**
  19226. * The list of defines used in the shader
  19227. */
  19228. defines: string[];
  19229. }
  19230. /**
  19231. * 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.
  19232. *
  19233. * This returned material effects how the mesh will look based on the code in the shaders.
  19234. *
  19235. * @see http://doc.babylonjs.com/how_to/shader_material
  19236. */
  19237. export class ShaderMaterial extends Material {
  19238. private _shaderPath;
  19239. private _options;
  19240. private _textures;
  19241. private _textureArrays;
  19242. private _floats;
  19243. private _ints;
  19244. private _floatsArrays;
  19245. private _colors3;
  19246. private _colors3Arrays;
  19247. private _colors4;
  19248. private _colors4Arrays;
  19249. private _vectors2;
  19250. private _vectors3;
  19251. private _vectors4;
  19252. private _matrices;
  19253. private _matrices3x3;
  19254. private _matrices2x2;
  19255. private _vectors2Arrays;
  19256. private _vectors3Arrays;
  19257. private _vectors4Arrays;
  19258. private _cachedWorldViewMatrix;
  19259. private _cachedWorldViewProjectionMatrix;
  19260. private _renderId;
  19261. /**
  19262. * Instantiate a new shader material.
  19263. * 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.
  19264. * This returned material effects how the mesh will look based on the code in the shaders.
  19265. * @see http://doc.babylonjs.com/how_to/shader_material
  19266. * @param name Define the name of the material in the scene
  19267. * @param scene Define the scene the material belongs to
  19268. * @param shaderPath Defines the route to the shader code in one of three ways:
  19269. * - object - { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19270. * - object - { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in <script> tags
  19271. * - string - "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19272. * @param options Define the options used to create the shader
  19273. */
  19274. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19275. /**
  19276. * Gets the options used to compile the shader.
  19277. * They can be modified to trigger a new compilation
  19278. */
  19279. readonly options: IShaderMaterialOptions;
  19280. /**
  19281. * Gets the current class name of the material e.g. "ShaderMaterial"
  19282. * Mainly use in serialization.
  19283. * @returns the class name
  19284. */
  19285. getClassName(): string;
  19286. /**
  19287. * Specifies if the material will require alpha blending
  19288. * @returns a boolean specifying if alpha blending is needed
  19289. */
  19290. needAlphaBlending(): boolean;
  19291. /**
  19292. * Specifies if this material should be rendered in alpha test mode
  19293. * @returns a boolean specifying if an alpha test is needed.
  19294. */
  19295. needAlphaTesting(): boolean;
  19296. private _checkUniform;
  19297. /**
  19298. * Set a texture in the shader.
  19299. * @param name Define the name of the uniform samplers as defined in the shader
  19300. * @param texture Define the texture to bind to this sampler
  19301. * @return the material itself allowing "fluent" like uniform updates
  19302. */
  19303. setTexture(name: string, texture: Texture): ShaderMaterial;
  19304. /**
  19305. * Set a texture array in the shader.
  19306. * @param name Define the name of the uniform sampler array as defined in the shader
  19307. * @param textures Define the list of textures to bind to this sampler
  19308. * @return the material itself allowing "fluent" like uniform updates
  19309. */
  19310. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19311. /**
  19312. * Set a float in the shader.
  19313. * @param name Define the name of the uniform as defined in the shader
  19314. * @param value Define the value to give to the uniform
  19315. * @return the material itself allowing "fluent" like uniform updates
  19316. */
  19317. setFloat(name: string, value: number): ShaderMaterial;
  19318. /**
  19319. * Set a int in the shader.
  19320. * @param name Define the name of the uniform as defined in the shader
  19321. * @param value Define the value to give to the uniform
  19322. * @return the material itself allowing "fluent" like uniform updates
  19323. */
  19324. setInt(name: string, value: number): ShaderMaterial;
  19325. /**
  19326. * Set an array of floats in the shader.
  19327. * @param name Define the name of the uniform as defined in the shader
  19328. * @param value Define the value to give to the uniform
  19329. * @return the material itself allowing "fluent" like uniform updates
  19330. */
  19331. setFloats(name: string, value: number[]): ShaderMaterial;
  19332. /**
  19333. * Set a vec3 in the shader from a Color3.
  19334. * @param name Define the name of the uniform as defined in the shader
  19335. * @param value Define the value to give to the uniform
  19336. * @return the material itself allowing "fluent" like uniform updates
  19337. */
  19338. setColor3(name: string, value: Color3): ShaderMaterial;
  19339. /**
  19340. * Set a vec3 array in the shader from a Color3 array.
  19341. * @param name Define the name of the uniform as defined in the shader
  19342. * @param value Define the value to give to the uniform
  19343. * @return the material itself allowing "fluent" like uniform updates
  19344. */
  19345. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19346. /**
  19347. * Set a vec4 in the shader from a Color4.
  19348. * @param name Define the name of the uniform as defined in the shader
  19349. * @param value Define the value to give to the uniform
  19350. * @return the material itself allowing "fluent" like uniform updates
  19351. */
  19352. setColor4(name: string, value: Color4): ShaderMaterial;
  19353. /**
  19354. * Set a vec4 array in the shader from a Color4 array.
  19355. * @param name Define the name of the uniform as defined in the shader
  19356. * @param value Define the value to give to the uniform
  19357. * @return the material itself allowing "fluent" like uniform updates
  19358. */
  19359. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19360. /**
  19361. * Set a vec2 in the shader from a Vector2.
  19362. * @param name Define the name of the uniform as defined in the shader
  19363. * @param value Define the value to give to the uniform
  19364. * @return the material itself allowing "fluent" like uniform updates
  19365. */
  19366. setVector2(name: string, value: Vector2): ShaderMaterial;
  19367. /**
  19368. * Set a vec3 in the shader from a Vector3.
  19369. * @param name Define the name of the uniform as defined in the shader
  19370. * @param value Define the value to give to the uniform
  19371. * @return the material itself allowing "fluent" like uniform updates
  19372. */
  19373. setVector3(name: string, value: Vector3): ShaderMaterial;
  19374. /**
  19375. * Set a vec4 in the shader from a Vector4.
  19376. * @param name Define the name of the uniform as defined in the shader
  19377. * @param value Define the value to give to the uniform
  19378. * @return the material itself allowing "fluent" like uniform updates
  19379. */
  19380. setVector4(name: string, value: Vector4): ShaderMaterial;
  19381. /**
  19382. * Set a mat4 in the shader from a Matrix.
  19383. * @param name Define the name of the uniform as defined in the shader
  19384. * @param value Define the value to give to the uniform
  19385. * @return the material itself allowing "fluent" like uniform updates
  19386. */
  19387. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19388. /**
  19389. * Set a mat3 in the shader from a Float32Array.
  19390. * @param name Define the name of the uniform as defined in the shader
  19391. * @param value Define the value to give to the uniform
  19392. * @return the material itself allowing "fluent" like uniform updates
  19393. */
  19394. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19395. /**
  19396. * Set a mat2 in the shader from a Float32Array.
  19397. * @param name Define the name of the uniform as defined in the shader
  19398. * @param value Define the value to give to the uniform
  19399. * @return the material itself allowing "fluent" like uniform updates
  19400. */
  19401. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19402. /**
  19403. * Set a vec2 array in the shader from a number array.
  19404. * @param name Define the name of the uniform as defined in the shader
  19405. * @param value Define the value to give to the uniform
  19406. * @return the material itself allowing "fluent" like uniform updates
  19407. */
  19408. setArray2(name: string, value: number[]): ShaderMaterial;
  19409. /**
  19410. * Set a vec3 array in the shader from a number array.
  19411. * @param name Define the name of the uniform as defined in the shader
  19412. * @param value Define the value to give to the uniform
  19413. * @return the material itself allowing "fluent" like uniform updates
  19414. */
  19415. setArray3(name: string, value: number[]): ShaderMaterial;
  19416. /**
  19417. * Set a vec4 array in the shader from a number array.
  19418. * @param name Define the name of the uniform as defined in the shader
  19419. * @param value Define the value to give to the uniform
  19420. * @return the material itself allowing "fluent" like uniform updates
  19421. */
  19422. setArray4(name: string, value: number[]): ShaderMaterial;
  19423. private _checkCache;
  19424. /**
  19425. * Specifies that the submesh is ready to be used
  19426. * @param mesh defines the mesh to check
  19427. * @param subMesh defines which submesh to check
  19428. * @param useInstances specifies that instances should be used
  19429. * @returns a boolean indicating that the submesh is ready or not
  19430. */
  19431. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19432. /**
  19433. * Checks if the material is ready to render the requested mesh
  19434. * @param mesh Define the mesh to render
  19435. * @param useInstances Define whether or not the material is used with instances
  19436. * @returns true if ready, otherwise false
  19437. */
  19438. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19439. /**
  19440. * Binds the world matrix to the material
  19441. * @param world defines the world transformation matrix
  19442. */
  19443. bindOnlyWorldMatrix(world: Matrix): void;
  19444. /**
  19445. * Binds the material to the mesh
  19446. * @param world defines the world transformation matrix
  19447. * @param mesh defines the mesh to bind the material to
  19448. */
  19449. bind(world: Matrix, mesh?: Mesh): void;
  19450. /**
  19451. * Gets the active textures from the material
  19452. * @returns an array of textures
  19453. */
  19454. getActiveTextures(): BaseTexture[];
  19455. /**
  19456. * Specifies if the material uses a texture
  19457. * @param texture defines the texture to check against the material
  19458. * @returns a boolean specifying if the material uses the texture
  19459. */
  19460. hasTexture(texture: BaseTexture): boolean;
  19461. /**
  19462. * Makes a duplicate of the material, and gives it a new name
  19463. * @param name defines the new name for the duplicated material
  19464. * @returns the cloned material
  19465. */
  19466. clone(name: string): ShaderMaterial;
  19467. /**
  19468. * Disposes the material
  19469. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  19470. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  19471. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  19472. */
  19473. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  19474. /**
  19475. * Serializes this material in a JSON representation
  19476. * @returns the serialized material object
  19477. */
  19478. serialize(): any;
  19479. /**
  19480. * Creates a shader material from parsed shader material data
  19481. * @param source defines the JSON represnetation of the material
  19482. * @param scene defines the hosting scene
  19483. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  19484. * @returns a new material
  19485. */
  19486. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  19487. }
  19488. }
  19489. declare module "babylonjs/Shaders/color.fragment" {
  19490. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  19491. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  19492. /** @hidden */
  19493. export var colorPixelShader: {
  19494. name: string;
  19495. shader: string;
  19496. };
  19497. }
  19498. declare module "babylonjs/Shaders/color.vertex" {
  19499. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  19500. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  19501. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  19502. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  19503. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  19504. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  19505. /** @hidden */
  19506. export var colorVertexShader: {
  19507. name: string;
  19508. shader: string;
  19509. };
  19510. }
  19511. declare module "babylonjs/Meshes/linesMesh" {
  19512. import { Nullable } from "babylonjs/types";
  19513. import { Scene } from "babylonjs/scene";
  19514. import { Color3 } from "babylonjs/Maths/math.color";
  19515. import { Node } from "babylonjs/node";
  19516. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19517. import { Mesh } from "babylonjs/Meshes/mesh";
  19518. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  19519. import { Effect } from "babylonjs/Materials/effect";
  19520. import { Material } from "babylonjs/Materials/material";
  19521. import "babylonjs/Shaders/color.fragment";
  19522. import "babylonjs/Shaders/color.vertex";
  19523. /**
  19524. * Line mesh
  19525. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  19526. */
  19527. export class LinesMesh extends Mesh {
  19528. /**
  19529. * If vertex color should be applied to the mesh
  19530. */
  19531. readonly useVertexColor?: boolean | undefined;
  19532. /**
  19533. * If vertex alpha should be applied to the mesh
  19534. */
  19535. readonly useVertexAlpha?: boolean | undefined;
  19536. /**
  19537. * Color of the line (Default: White)
  19538. */
  19539. color: Color3;
  19540. /**
  19541. * Alpha of the line (Default: 1)
  19542. */
  19543. alpha: number;
  19544. /**
  19545. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19546. * This margin is expressed in world space coordinates, so its value may vary.
  19547. * Default value is 0.1
  19548. */
  19549. intersectionThreshold: number;
  19550. private _colorShader;
  19551. private color4;
  19552. /**
  19553. * Creates a new LinesMesh
  19554. * @param name defines the name
  19555. * @param scene defines the hosting scene
  19556. * @param parent defines the parent mesh if any
  19557. * @param source defines the optional source LinesMesh used to clone data from
  19558. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  19559. * When false, achieved by calling a clone(), also passing False.
  19560. * This will make creation of children, recursive.
  19561. * @param useVertexColor defines if this LinesMesh supports vertex color
  19562. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  19563. */
  19564. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: LinesMesh, doNotCloneChildren?: boolean,
  19565. /**
  19566. * If vertex color should be applied to the mesh
  19567. */
  19568. useVertexColor?: boolean | undefined,
  19569. /**
  19570. * If vertex alpha should be applied to the mesh
  19571. */
  19572. useVertexAlpha?: boolean | undefined);
  19573. private _addClipPlaneDefine;
  19574. private _removeClipPlaneDefine;
  19575. isReady(): boolean;
  19576. /**
  19577. * Returns the string "LineMesh"
  19578. */
  19579. getClassName(): string;
  19580. /**
  19581. * @hidden
  19582. */
  19583. /**
  19584. * @hidden
  19585. */
  19586. material: Material;
  19587. /**
  19588. * @hidden
  19589. */
  19590. readonly checkCollisions: boolean;
  19591. /** @hidden */
  19592. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): LinesMesh;
  19593. /** @hidden */
  19594. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): LinesMesh;
  19595. /**
  19596. * Disposes of the line mesh
  19597. * @param doNotRecurse If children should be disposed
  19598. */
  19599. dispose(doNotRecurse?: boolean): void;
  19600. /**
  19601. * Returns a new LineMesh object cloned from the current one.
  19602. */
  19603. clone(name: string, newParent?: Node, doNotCloneChildren?: boolean): LinesMesh;
  19604. /**
  19605. * Creates a new InstancedLinesMesh object from the mesh model.
  19606. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  19607. * @param name defines the name of the new instance
  19608. * @returns a new InstancedLinesMesh
  19609. */
  19610. createInstance(name: string): InstancedLinesMesh;
  19611. }
  19612. /**
  19613. * Creates an instance based on a source LinesMesh
  19614. */
  19615. export class InstancedLinesMesh extends InstancedMesh {
  19616. /**
  19617. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19618. * This margin is expressed in world space coordinates, so its value may vary.
  19619. * Initilized with the intersectionThreshold value of the source LinesMesh
  19620. */
  19621. intersectionThreshold: number;
  19622. constructor(name: string, source: LinesMesh);
  19623. /**
  19624. * Returns the string "InstancedLinesMesh".
  19625. */
  19626. getClassName(): string;
  19627. }
  19628. }
  19629. declare module "babylonjs/Shaders/line.fragment" {
  19630. /** @hidden */
  19631. export var linePixelShader: {
  19632. name: string;
  19633. shader: string;
  19634. };
  19635. }
  19636. declare module "babylonjs/Shaders/line.vertex" {
  19637. /** @hidden */
  19638. export var lineVertexShader: {
  19639. name: string;
  19640. shader: string;
  19641. };
  19642. }
  19643. declare module "babylonjs/Rendering/edgesRenderer" {
  19644. import { Nullable } from "babylonjs/types";
  19645. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19646. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19647. import { Vector3 } from "babylonjs/Maths/math.vector";
  19648. import { IDisposable } from "babylonjs/scene";
  19649. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  19650. import "babylonjs/Shaders/line.fragment";
  19651. import "babylonjs/Shaders/line.vertex";
  19652. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  19653. module "babylonjs/Meshes/abstractMesh" {
  19654. interface AbstractMesh {
  19655. /**
  19656. * Gets the edgesRenderer associated with the mesh
  19657. */
  19658. edgesRenderer: Nullable<EdgesRenderer>;
  19659. }
  19660. }
  19661. module "babylonjs/Meshes/linesMesh" {
  19662. interface LinesMesh {
  19663. /**
  19664. * Enables the edge rendering mode on the mesh.
  19665. * This mode makes the mesh edges visible
  19666. * @param epsilon defines the maximal distance between two angles to detect a face
  19667. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  19668. * @returns the currentAbstractMesh
  19669. * @see https://www.babylonjs-playground.com/#19O9TU#0
  19670. */
  19671. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  19672. }
  19673. }
  19674. module "babylonjs/Meshes/linesMesh" {
  19675. interface InstancedLinesMesh {
  19676. /**
  19677. * Enables the edge rendering mode on the mesh.
  19678. * This mode makes the mesh edges visible
  19679. * @param epsilon defines the maximal distance between two angles to detect a face
  19680. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  19681. * @returns the current InstancedLinesMesh
  19682. * @see https://www.babylonjs-playground.com/#19O9TU#0
  19683. */
  19684. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  19685. }
  19686. }
  19687. /**
  19688. * Defines the minimum contract an Edges renderer should follow.
  19689. */
  19690. export interface IEdgesRenderer extends IDisposable {
  19691. /**
  19692. * Gets or sets a boolean indicating if the edgesRenderer is active
  19693. */
  19694. isEnabled: boolean;
  19695. /**
  19696. * Renders the edges of the attached mesh,
  19697. */
  19698. render(): void;
  19699. /**
  19700. * Checks wether or not the edges renderer is ready to render.
  19701. * @return true if ready, otherwise false.
  19702. */
  19703. isReady(): boolean;
  19704. }
  19705. /**
  19706. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  19707. */
  19708. export class EdgesRenderer implements IEdgesRenderer {
  19709. /**
  19710. * Define the size of the edges with an orthographic camera
  19711. */
  19712. edgesWidthScalerForOrthographic: number;
  19713. /**
  19714. * Define the size of the edges with a perspective camera
  19715. */
  19716. edgesWidthScalerForPerspective: number;
  19717. protected _source: AbstractMesh;
  19718. protected _linesPositions: number[];
  19719. protected _linesNormals: number[];
  19720. protected _linesIndices: number[];
  19721. protected _epsilon: number;
  19722. protected _indicesCount: number;
  19723. protected _lineShader: ShaderMaterial;
  19724. protected _ib: DataBuffer;
  19725. protected _buffers: {
  19726. [key: string]: Nullable<VertexBuffer>;
  19727. };
  19728. protected _checkVerticesInsteadOfIndices: boolean;
  19729. private _meshRebuildObserver;
  19730. private _meshDisposeObserver;
  19731. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  19732. isEnabled: boolean;
  19733. /**
  19734. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  19735. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  19736. * @param source Mesh used to create edges
  19737. * @param epsilon sum of angles in adjacency to check for edge
  19738. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  19739. * @param generateEdgesLines - should generate Lines or only prepare resources.
  19740. */
  19741. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  19742. protected _prepareRessources(): void;
  19743. /** @hidden */
  19744. _rebuild(): void;
  19745. /**
  19746. * Releases the required resources for the edges renderer
  19747. */
  19748. dispose(): void;
  19749. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  19750. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  19751. /**
  19752. * Checks if the pair of p0 and p1 is en edge
  19753. * @param faceIndex
  19754. * @param edge
  19755. * @param faceNormals
  19756. * @param p0
  19757. * @param p1
  19758. * @private
  19759. */
  19760. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  19761. /**
  19762. * push line into the position, normal and index buffer
  19763. * @protected
  19764. */
  19765. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  19766. /**
  19767. * Generates lines edges from adjacencjes
  19768. * @private
  19769. */
  19770. _generateEdgesLines(): void;
  19771. /**
  19772. * Checks wether or not the edges renderer is ready to render.
  19773. * @return true if ready, otherwise false.
  19774. */
  19775. isReady(): boolean;
  19776. /**
  19777. * Renders the edges of the attached mesh,
  19778. */
  19779. render(): void;
  19780. }
  19781. /**
  19782. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  19783. */
  19784. export class LineEdgesRenderer extends EdgesRenderer {
  19785. /**
  19786. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  19787. * @param source LineMesh used to generate edges
  19788. * @param epsilon not important (specified angle for edge detection)
  19789. * @param checkVerticesInsteadOfIndices not important for LineMesh
  19790. */
  19791. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  19792. /**
  19793. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  19794. */
  19795. _generateEdgesLines(): void;
  19796. }
  19797. }
  19798. declare module "babylonjs/Rendering/renderingGroup" {
  19799. import { SmartArray } from "babylonjs/Misc/smartArray";
  19800. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19801. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19802. import { Nullable } from "babylonjs/types";
  19803. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  19804. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  19805. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  19806. import { Material } from "babylonjs/Materials/material";
  19807. import { Scene } from "babylonjs/scene";
  19808. /**
  19809. * This represents the object necessary to create a rendering group.
  19810. * This is exclusively used and created by the rendering manager.
  19811. * To modify the behavior, you use the available helpers in your scene or meshes.
  19812. * @hidden
  19813. */
  19814. export class RenderingGroup {
  19815. index: number;
  19816. private static _zeroVector;
  19817. private _scene;
  19818. private _opaqueSubMeshes;
  19819. private _transparentSubMeshes;
  19820. private _alphaTestSubMeshes;
  19821. private _depthOnlySubMeshes;
  19822. private _particleSystems;
  19823. private _spriteManagers;
  19824. private _opaqueSortCompareFn;
  19825. private _alphaTestSortCompareFn;
  19826. private _transparentSortCompareFn;
  19827. private _renderOpaque;
  19828. private _renderAlphaTest;
  19829. private _renderTransparent;
  19830. /** @hidden */
  19831. _edgesRenderers: SmartArray<IEdgesRenderer>;
  19832. onBeforeTransparentRendering: () => void;
  19833. /**
  19834. * Set the opaque sort comparison function.
  19835. * If null the sub meshes will be render in the order they were created
  19836. */
  19837. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  19838. /**
  19839. * Set the alpha test sort comparison function.
  19840. * If null the sub meshes will be render in the order they were created
  19841. */
  19842. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  19843. /**
  19844. * Set the transparent sort comparison function.
  19845. * If null the sub meshes will be render in the order they were created
  19846. */
  19847. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  19848. /**
  19849. * Creates a new rendering group.
  19850. * @param index The rendering group index
  19851. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  19852. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  19853. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  19854. */
  19855. 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>);
  19856. /**
  19857. * Render all the sub meshes contained in the group.
  19858. * @param customRenderFunction Used to override the default render behaviour of the group.
  19859. * @returns true if rendered some submeshes.
  19860. */
  19861. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  19862. /**
  19863. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  19864. * @param subMeshes The submeshes to render
  19865. */
  19866. private renderOpaqueSorted;
  19867. /**
  19868. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  19869. * @param subMeshes The submeshes to render
  19870. */
  19871. private renderAlphaTestSorted;
  19872. /**
  19873. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  19874. * @param subMeshes The submeshes to render
  19875. */
  19876. private renderTransparentSorted;
  19877. /**
  19878. * Renders the submeshes in a specified order.
  19879. * @param subMeshes The submeshes to sort before render
  19880. * @param sortCompareFn The comparison function use to sort
  19881. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  19882. * @param transparent Specifies to activate blending if true
  19883. */
  19884. private static renderSorted;
  19885. /**
  19886. * Renders the submeshes in the order they were dispatched (no sort applied).
  19887. * @param subMeshes The submeshes to render
  19888. */
  19889. private static renderUnsorted;
  19890. /**
  19891. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  19892. * are rendered back to front if in the same alpha index.
  19893. *
  19894. * @param a The first submesh
  19895. * @param b The second submesh
  19896. * @returns The result of the comparison
  19897. */
  19898. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  19899. /**
  19900. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  19901. * are rendered back to front.
  19902. *
  19903. * @param a The first submesh
  19904. * @param b The second submesh
  19905. * @returns The result of the comparison
  19906. */
  19907. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  19908. /**
  19909. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  19910. * are rendered front to back (prevent overdraw).
  19911. *
  19912. * @param a The first submesh
  19913. * @param b The second submesh
  19914. * @returns The result of the comparison
  19915. */
  19916. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  19917. /**
  19918. * Resets the different lists of submeshes to prepare a new frame.
  19919. */
  19920. prepare(): void;
  19921. dispose(): void;
  19922. /**
  19923. * Inserts the submesh in its correct queue depending on its material.
  19924. * @param subMesh The submesh to dispatch
  19925. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  19926. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  19927. */
  19928. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  19929. dispatchSprites(spriteManager: ISpriteManager): void;
  19930. dispatchParticles(particleSystem: IParticleSystem): void;
  19931. private _renderParticles;
  19932. private _renderSprites;
  19933. }
  19934. }
  19935. declare module "babylonjs/Rendering/renderingManager" {
  19936. import { Nullable } from "babylonjs/types";
  19937. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19938. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19939. import { SmartArray } from "babylonjs/Misc/smartArray";
  19940. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  19941. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  19942. import { Material } from "babylonjs/Materials/material";
  19943. import { Scene } from "babylonjs/scene";
  19944. import { Camera } from "babylonjs/Cameras/camera";
  19945. /**
  19946. * Interface describing the different options available in the rendering manager
  19947. * regarding Auto Clear between groups.
  19948. */
  19949. export interface IRenderingManagerAutoClearSetup {
  19950. /**
  19951. * Defines whether or not autoclear is enable.
  19952. */
  19953. autoClear: boolean;
  19954. /**
  19955. * Defines whether or not to autoclear the depth buffer.
  19956. */
  19957. depth: boolean;
  19958. /**
  19959. * Defines whether or not to autoclear the stencil buffer.
  19960. */
  19961. stencil: boolean;
  19962. }
  19963. /**
  19964. * This class is used by the onRenderingGroupObservable
  19965. */
  19966. export class RenderingGroupInfo {
  19967. /**
  19968. * The Scene that being rendered
  19969. */
  19970. scene: Scene;
  19971. /**
  19972. * The camera currently used for the rendering pass
  19973. */
  19974. camera: Nullable<Camera>;
  19975. /**
  19976. * The ID of the renderingGroup being processed
  19977. */
  19978. renderingGroupId: number;
  19979. }
  19980. /**
  19981. * This is the manager responsible of all the rendering for meshes sprites and particles.
  19982. * It is enable to manage the different groups as well as the different necessary sort functions.
  19983. * This should not be used directly aside of the few static configurations
  19984. */
  19985. export class RenderingManager {
  19986. /**
  19987. * The max id used for rendering groups (not included)
  19988. */
  19989. static MAX_RENDERINGGROUPS: number;
  19990. /**
  19991. * The min id used for rendering groups (included)
  19992. */
  19993. static MIN_RENDERINGGROUPS: number;
  19994. /**
  19995. * Used to globally prevent autoclearing scenes.
  19996. */
  19997. static AUTOCLEAR: boolean;
  19998. /**
  19999. * @hidden
  20000. */
  20001. _useSceneAutoClearSetup: boolean;
  20002. private _scene;
  20003. private _renderingGroups;
  20004. private _depthStencilBufferAlreadyCleaned;
  20005. private _autoClearDepthStencil;
  20006. private _customOpaqueSortCompareFn;
  20007. private _customAlphaTestSortCompareFn;
  20008. private _customTransparentSortCompareFn;
  20009. private _renderingGroupInfo;
  20010. /**
  20011. * Instantiates a new rendering group for a particular scene
  20012. * @param scene Defines the scene the groups belongs to
  20013. */
  20014. constructor(scene: Scene);
  20015. private _clearDepthStencilBuffer;
  20016. /**
  20017. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20018. * @hidden
  20019. */
  20020. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20021. /**
  20022. * Resets the different information of the group to prepare a new frame
  20023. * @hidden
  20024. */
  20025. reset(): void;
  20026. /**
  20027. * Dispose and release the group and its associated resources.
  20028. * @hidden
  20029. */
  20030. dispose(): void;
  20031. /**
  20032. * Clear the info related to rendering groups preventing retention points during dispose.
  20033. */
  20034. freeRenderingGroups(): void;
  20035. private _prepareRenderingGroup;
  20036. /**
  20037. * Add a sprite manager to the rendering manager in order to render it this frame.
  20038. * @param spriteManager Define the sprite manager to render
  20039. */
  20040. dispatchSprites(spriteManager: ISpriteManager): void;
  20041. /**
  20042. * Add a particle system to the rendering manager in order to render it this frame.
  20043. * @param particleSystem Define the particle system to render
  20044. */
  20045. dispatchParticles(particleSystem: IParticleSystem): void;
  20046. /**
  20047. * Add a submesh to the manager in order to render it this frame
  20048. * @param subMesh The submesh to dispatch
  20049. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20050. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20051. */
  20052. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20053. /**
  20054. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20055. * This allowed control for front to back rendering or reversly depending of the special needs.
  20056. *
  20057. * @param renderingGroupId The rendering group id corresponding to its index
  20058. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20059. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20060. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20061. */
  20062. 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;
  20063. /**
  20064. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20065. *
  20066. * @param renderingGroupId The rendering group id corresponding to its index
  20067. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20068. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20069. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20070. */
  20071. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20072. /**
  20073. * Gets the current auto clear configuration for one rendering group of the rendering
  20074. * manager.
  20075. * @param index the rendering group index to get the information for
  20076. * @returns The auto clear setup for the requested rendering group
  20077. */
  20078. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20079. }
  20080. }
  20081. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20082. import { Observable } from "babylonjs/Misc/observable";
  20083. import { SmartArray } from "babylonjs/Misc/smartArray";
  20084. import { Nullable } from "babylonjs/types";
  20085. import { Camera } from "babylonjs/Cameras/camera";
  20086. import { Scene } from "babylonjs/scene";
  20087. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20088. import { Color4 } from "babylonjs/Maths/math.color";
  20089. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20090. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20091. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20092. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20093. import { Texture } from "babylonjs/Materials/Textures/texture";
  20094. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20095. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20096. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20097. import { Engine } from "babylonjs/Engines/engine";
  20098. /**
  20099. * This Helps creating a texture that will be created from a camera in your scene.
  20100. * It is basically a dynamic texture that could be used to create special effects for instance.
  20101. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20102. */
  20103. export class RenderTargetTexture extends Texture {
  20104. isCube: boolean;
  20105. /**
  20106. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20107. */
  20108. static readonly REFRESHRATE_RENDER_ONCE: number;
  20109. /**
  20110. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20111. */
  20112. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20113. /**
  20114. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20115. * the central point of your effect and can save a lot of performances.
  20116. */
  20117. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20118. /**
  20119. * Use this predicate to dynamically define the list of mesh you want to render.
  20120. * If set, the renderList property will be overwritten.
  20121. */
  20122. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20123. private _renderList;
  20124. /**
  20125. * Use this list to define the list of mesh you want to render.
  20126. */
  20127. renderList: Nullable<Array<AbstractMesh>>;
  20128. private _hookArray;
  20129. /**
  20130. * Define if particles should be rendered in your texture.
  20131. */
  20132. renderParticles: boolean;
  20133. /**
  20134. * Define if sprites should be rendered in your texture.
  20135. */
  20136. renderSprites: boolean;
  20137. /**
  20138. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20139. */
  20140. coordinatesMode: number;
  20141. /**
  20142. * Define the camera used to render the texture.
  20143. */
  20144. activeCamera: Nullable<Camera>;
  20145. /**
  20146. * Override the render function of the texture with your own one.
  20147. */
  20148. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20149. /**
  20150. * Define if camera post processes should be use while rendering the texture.
  20151. */
  20152. useCameraPostProcesses: boolean;
  20153. /**
  20154. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20155. */
  20156. ignoreCameraViewport: boolean;
  20157. private _postProcessManager;
  20158. private _postProcesses;
  20159. private _resizeObserver;
  20160. /**
  20161. * An event triggered when the texture is unbind.
  20162. */
  20163. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20164. /**
  20165. * An event triggered when the texture is unbind.
  20166. */
  20167. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20168. private _onAfterUnbindObserver;
  20169. /**
  20170. * Set a after unbind callback in the texture.
  20171. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20172. */
  20173. onAfterUnbind: () => void;
  20174. /**
  20175. * An event triggered before rendering the texture
  20176. */
  20177. onBeforeRenderObservable: Observable<number>;
  20178. private _onBeforeRenderObserver;
  20179. /**
  20180. * Set a before render callback in the texture.
  20181. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20182. */
  20183. onBeforeRender: (faceIndex: number) => void;
  20184. /**
  20185. * An event triggered after rendering the texture
  20186. */
  20187. onAfterRenderObservable: Observable<number>;
  20188. private _onAfterRenderObserver;
  20189. /**
  20190. * Set a after render callback in the texture.
  20191. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20192. */
  20193. onAfterRender: (faceIndex: number) => void;
  20194. /**
  20195. * An event triggered after the texture clear
  20196. */
  20197. onClearObservable: Observable<Engine>;
  20198. private _onClearObserver;
  20199. /**
  20200. * Set a clear callback in the texture.
  20201. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20202. */
  20203. onClear: (Engine: Engine) => void;
  20204. /**
  20205. * An event triggered when the texture is resized.
  20206. */
  20207. onResizeObservable: Observable<RenderTargetTexture>;
  20208. /**
  20209. * Define the clear color of the Render Target if it should be different from the scene.
  20210. */
  20211. clearColor: Color4;
  20212. protected _size: number | {
  20213. width: number;
  20214. height: number;
  20215. };
  20216. protected _initialSizeParameter: number | {
  20217. width: number;
  20218. height: number;
  20219. } | {
  20220. ratio: number;
  20221. };
  20222. protected _sizeRatio: Nullable<number>;
  20223. /** @hidden */
  20224. _generateMipMaps: boolean;
  20225. protected _renderingManager: RenderingManager;
  20226. /** @hidden */
  20227. _waitingRenderList: string[];
  20228. protected _doNotChangeAspectRatio: boolean;
  20229. protected _currentRefreshId: number;
  20230. protected _refreshRate: number;
  20231. protected _textureMatrix: Matrix;
  20232. protected _samples: number;
  20233. protected _renderTargetOptions: RenderTargetCreationOptions;
  20234. /**
  20235. * Gets render target creation options that were used.
  20236. */
  20237. readonly renderTargetOptions: RenderTargetCreationOptions;
  20238. protected _engine: Engine;
  20239. protected _onRatioRescale(): void;
  20240. /**
  20241. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20242. * It must define where the camera used to render the texture is set
  20243. */
  20244. boundingBoxPosition: Vector3;
  20245. private _boundingBoxSize;
  20246. /**
  20247. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20248. * When defined, the cubemap will switch to local mode
  20249. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20250. * @example https://www.babylonjs-playground.com/#RNASML
  20251. */
  20252. boundingBoxSize: Vector3;
  20253. /**
  20254. * In case the RTT has been created with a depth texture, get the associated
  20255. * depth texture.
  20256. * Otherwise, return null.
  20257. */
  20258. depthStencilTexture: Nullable<InternalTexture>;
  20259. /**
  20260. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20261. * or used a shadow, depth texture...
  20262. * @param name The friendly name of the texture
  20263. * @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)
  20264. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20265. * @param generateMipMaps True if mip maps need to be generated after render.
  20266. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20267. * @param type The type of the buffer in the RTT (int, half float, float...)
  20268. * @param isCube True if a cube texture needs to be created
  20269. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20270. * @param generateDepthBuffer True to generate a depth buffer
  20271. * @param generateStencilBuffer True to generate a stencil buffer
  20272. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20273. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20274. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20275. */
  20276. constructor(name: string, size: number | {
  20277. width: number;
  20278. height: number;
  20279. } | {
  20280. ratio: number;
  20281. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20282. /**
  20283. * Creates a depth stencil texture.
  20284. * This is only available in WebGL 2 or with the depth texture extension available.
  20285. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20286. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20287. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20288. */
  20289. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20290. private _processSizeParameter;
  20291. /**
  20292. * Define the number of samples to use in case of MSAA.
  20293. * It defaults to one meaning no MSAA has been enabled.
  20294. */
  20295. samples: number;
  20296. /**
  20297. * Resets the refresh counter of the texture and start bak from scratch.
  20298. * Could be useful to regenerate the texture if it is setup to render only once.
  20299. */
  20300. resetRefreshCounter(): void;
  20301. /**
  20302. * Define the refresh rate of the texture or the rendering frequency.
  20303. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20304. */
  20305. refreshRate: number;
  20306. /**
  20307. * Adds a post process to the render target rendering passes.
  20308. * @param postProcess define the post process to add
  20309. */
  20310. addPostProcess(postProcess: PostProcess): void;
  20311. /**
  20312. * Clear all the post processes attached to the render target
  20313. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20314. */
  20315. clearPostProcesses(dispose?: boolean): void;
  20316. /**
  20317. * Remove one of the post process from the list of attached post processes to the texture
  20318. * @param postProcess define the post process to remove from the list
  20319. */
  20320. removePostProcess(postProcess: PostProcess): void;
  20321. /** @hidden */
  20322. _shouldRender(): boolean;
  20323. /**
  20324. * Gets the actual render size of the texture.
  20325. * @returns the width of the render size
  20326. */
  20327. getRenderSize(): number;
  20328. /**
  20329. * Gets the actual render width of the texture.
  20330. * @returns the width of the render size
  20331. */
  20332. getRenderWidth(): number;
  20333. /**
  20334. * Gets the actual render height of the texture.
  20335. * @returns the height of the render size
  20336. */
  20337. getRenderHeight(): number;
  20338. /**
  20339. * Get if the texture can be rescaled or not.
  20340. */
  20341. readonly canRescale: boolean;
  20342. /**
  20343. * Resize the texture using a ratio.
  20344. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20345. */
  20346. scale(ratio: number): void;
  20347. /**
  20348. * Get the texture reflection matrix used to rotate/transform the reflection.
  20349. * @returns the reflection matrix
  20350. */
  20351. getReflectionTextureMatrix(): Matrix;
  20352. /**
  20353. * Resize the texture to a new desired size.
  20354. * Be carrefull as it will recreate all the data in the new texture.
  20355. * @param size Define the new size. It can be:
  20356. * - a number for squared texture,
  20357. * - an object containing { width: number, height: number }
  20358. * - or an object containing a ratio { ratio: number }
  20359. */
  20360. resize(size: number | {
  20361. width: number;
  20362. height: number;
  20363. } | {
  20364. ratio: number;
  20365. }): void;
  20366. /**
  20367. * Renders all the objects from the render list into the texture.
  20368. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20369. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20370. */
  20371. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20372. private _bestReflectionRenderTargetDimension;
  20373. /**
  20374. * @hidden
  20375. * @param faceIndex face index to bind to if this is a cubetexture
  20376. */
  20377. _bindFrameBuffer(faceIndex?: number): void;
  20378. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20379. private renderToTarget;
  20380. /**
  20381. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20382. * This allowed control for front to back rendering or reversly depending of the special needs.
  20383. *
  20384. * @param renderingGroupId The rendering group id corresponding to its index
  20385. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20386. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20387. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20388. */
  20389. 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;
  20390. /**
  20391. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20392. *
  20393. * @param renderingGroupId The rendering group id corresponding to its index
  20394. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20395. */
  20396. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20397. /**
  20398. * Clones the texture.
  20399. * @returns the cloned texture
  20400. */
  20401. clone(): RenderTargetTexture;
  20402. /**
  20403. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20404. * @returns The JSON representation of the texture
  20405. */
  20406. serialize(): any;
  20407. /**
  20408. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20409. */
  20410. disposeFramebufferObjects(): void;
  20411. /**
  20412. * Dispose the texture and release its associated resources.
  20413. */
  20414. dispose(): void;
  20415. /** @hidden */
  20416. _rebuild(): void;
  20417. /**
  20418. * Clear the info related to rendering groups preventing retention point in material dispose.
  20419. */
  20420. freeRenderingGroups(): void;
  20421. /**
  20422. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20423. * @returns the view count
  20424. */
  20425. getViewCount(): number;
  20426. }
  20427. }
  20428. declare module "babylonjs/Materials/material" {
  20429. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20430. import { SmartArray } from "babylonjs/Misc/smartArray";
  20431. import { Observable } from "babylonjs/Misc/observable";
  20432. import { Nullable } from "babylonjs/types";
  20433. import { Scene } from "babylonjs/scene";
  20434. import { Matrix } from "babylonjs/Maths/math.vector";
  20435. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20436. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20437. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20438. import { Effect } from "babylonjs/Materials/effect";
  20439. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20440. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20441. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20442. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20443. import { Mesh } from "babylonjs/Meshes/mesh";
  20444. import { Animation } from "babylonjs/Animations/animation";
  20445. /**
  20446. * Base class for the main features of a material in Babylon.js
  20447. */
  20448. export class Material implements IAnimatable {
  20449. /**
  20450. * Returns the triangle fill mode
  20451. */
  20452. static readonly TriangleFillMode: number;
  20453. /**
  20454. * Returns the wireframe mode
  20455. */
  20456. static readonly WireFrameFillMode: number;
  20457. /**
  20458. * Returns the point fill mode
  20459. */
  20460. static readonly PointFillMode: number;
  20461. /**
  20462. * Returns the point list draw mode
  20463. */
  20464. static readonly PointListDrawMode: number;
  20465. /**
  20466. * Returns the line list draw mode
  20467. */
  20468. static readonly LineListDrawMode: number;
  20469. /**
  20470. * Returns the line loop draw mode
  20471. */
  20472. static readonly LineLoopDrawMode: number;
  20473. /**
  20474. * Returns the line strip draw mode
  20475. */
  20476. static readonly LineStripDrawMode: number;
  20477. /**
  20478. * Returns the triangle strip draw mode
  20479. */
  20480. static readonly TriangleStripDrawMode: number;
  20481. /**
  20482. * Returns the triangle fan draw mode
  20483. */
  20484. static readonly TriangleFanDrawMode: number;
  20485. /**
  20486. * Stores the clock-wise side orientation
  20487. */
  20488. static readonly ClockWiseSideOrientation: number;
  20489. /**
  20490. * Stores the counter clock-wise side orientation
  20491. */
  20492. static readonly CounterClockWiseSideOrientation: number;
  20493. /**
  20494. * The dirty texture flag value
  20495. */
  20496. static readonly TextureDirtyFlag: number;
  20497. /**
  20498. * The dirty light flag value
  20499. */
  20500. static readonly LightDirtyFlag: number;
  20501. /**
  20502. * The dirty fresnel flag value
  20503. */
  20504. static readonly FresnelDirtyFlag: number;
  20505. /**
  20506. * The dirty attribute flag value
  20507. */
  20508. static readonly AttributesDirtyFlag: number;
  20509. /**
  20510. * The dirty misc flag value
  20511. */
  20512. static readonly MiscDirtyFlag: number;
  20513. /**
  20514. * The all dirty flag value
  20515. */
  20516. static readonly AllDirtyFlag: number;
  20517. /**
  20518. * The ID of the material
  20519. */
  20520. id: string;
  20521. /**
  20522. * Gets or sets the unique id of the material
  20523. */
  20524. uniqueId: number;
  20525. /**
  20526. * The name of the material
  20527. */
  20528. name: string;
  20529. /**
  20530. * Gets or sets user defined metadata
  20531. */
  20532. metadata: any;
  20533. /**
  20534. * For internal use only. Please do not use.
  20535. */
  20536. reservedDataStore: any;
  20537. /**
  20538. * Specifies if the ready state should be checked on each call
  20539. */
  20540. checkReadyOnEveryCall: boolean;
  20541. /**
  20542. * Specifies if the ready state should be checked once
  20543. */
  20544. checkReadyOnlyOnce: boolean;
  20545. /**
  20546. * The state of the material
  20547. */
  20548. state: string;
  20549. /**
  20550. * The alpha value of the material
  20551. */
  20552. protected _alpha: number;
  20553. /**
  20554. * List of inspectable custom properties (used by the Inspector)
  20555. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  20556. */
  20557. inspectableCustomProperties: IInspectable[];
  20558. /**
  20559. * Sets the alpha value of the material
  20560. */
  20561. /**
  20562. * Gets the alpha value of the material
  20563. */
  20564. alpha: number;
  20565. /**
  20566. * Specifies if back face culling is enabled
  20567. */
  20568. protected _backFaceCulling: boolean;
  20569. /**
  20570. * Sets the back-face culling state
  20571. */
  20572. /**
  20573. * Gets the back-face culling state
  20574. */
  20575. backFaceCulling: boolean;
  20576. /**
  20577. * Stores the value for side orientation
  20578. */
  20579. sideOrientation: number;
  20580. /**
  20581. * Callback triggered when the material is compiled
  20582. */
  20583. onCompiled: Nullable<(effect: Effect) => void>;
  20584. /**
  20585. * Callback triggered when an error occurs
  20586. */
  20587. onError: Nullable<(effect: Effect, errors: string) => void>;
  20588. /**
  20589. * Callback triggered to get the render target textures
  20590. */
  20591. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  20592. /**
  20593. * Gets a boolean indicating that current material needs to register RTT
  20594. */
  20595. readonly hasRenderTargetTextures: boolean;
  20596. /**
  20597. * Specifies if the material should be serialized
  20598. */
  20599. doNotSerialize: boolean;
  20600. /**
  20601. * @hidden
  20602. */
  20603. _storeEffectOnSubMeshes: boolean;
  20604. /**
  20605. * Stores the animations for the material
  20606. */
  20607. animations: Nullable<Array<Animation>>;
  20608. /**
  20609. * An event triggered when the material is disposed
  20610. */
  20611. onDisposeObservable: Observable<Material>;
  20612. /**
  20613. * An observer which watches for dispose events
  20614. */
  20615. private _onDisposeObserver;
  20616. private _onUnBindObservable;
  20617. /**
  20618. * Called during a dispose event
  20619. */
  20620. onDispose: () => void;
  20621. private _onBindObservable;
  20622. /**
  20623. * An event triggered when the material is bound
  20624. */
  20625. readonly onBindObservable: Observable<AbstractMesh>;
  20626. /**
  20627. * An observer which watches for bind events
  20628. */
  20629. private _onBindObserver;
  20630. /**
  20631. * Called during a bind event
  20632. */
  20633. onBind: (Mesh: AbstractMesh) => void;
  20634. /**
  20635. * An event triggered when the material is unbound
  20636. */
  20637. readonly onUnBindObservable: Observable<Material>;
  20638. /**
  20639. * Stores the value of the alpha mode
  20640. */
  20641. private _alphaMode;
  20642. /**
  20643. * Sets the value of the alpha mode.
  20644. *
  20645. * | Value | Type | Description |
  20646. * | --- | --- | --- |
  20647. * | 0 | ALPHA_DISABLE | |
  20648. * | 1 | ALPHA_ADD | |
  20649. * | 2 | ALPHA_COMBINE | |
  20650. * | 3 | ALPHA_SUBTRACT | |
  20651. * | 4 | ALPHA_MULTIPLY | |
  20652. * | 5 | ALPHA_MAXIMIZED | |
  20653. * | 6 | ALPHA_ONEONE | |
  20654. * | 7 | ALPHA_PREMULTIPLIED | |
  20655. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  20656. * | 9 | ALPHA_INTERPOLATE | |
  20657. * | 10 | ALPHA_SCREENMODE | |
  20658. *
  20659. */
  20660. /**
  20661. * Gets the value of the alpha mode
  20662. */
  20663. alphaMode: number;
  20664. /**
  20665. * Stores the state of the need depth pre-pass value
  20666. */
  20667. private _needDepthPrePass;
  20668. /**
  20669. * Sets the need depth pre-pass value
  20670. */
  20671. /**
  20672. * Gets the depth pre-pass value
  20673. */
  20674. needDepthPrePass: boolean;
  20675. /**
  20676. * Specifies if depth writing should be disabled
  20677. */
  20678. disableDepthWrite: boolean;
  20679. /**
  20680. * Specifies if depth writing should be forced
  20681. */
  20682. forceDepthWrite: boolean;
  20683. /**
  20684. * Specifies if there should be a separate pass for culling
  20685. */
  20686. separateCullingPass: boolean;
  20687. /**
  20688. * Stores the state specifing if fog should be enabled
  20689. */
  20690. private _fogEnabled;
  20691. /**
  20692. * Sets the state for enabling fog
  20693. */
  20694. /**
  20695. * Gets the value of the fog enabled state
  20696. */
  20697. fogEnabled: boolean;
  20698. /**
  20699. * Stores the size of points
  20700. */
  20701. pointSize: number;
  20702. /**
  20703. * Stores the z offset value
  20704. */
  20705. zOffset: number;
  20706. /**
  20707. * Gets a value specifying if wireframe mode is enabled
  20708. */
  20709. /**
  20710. * Sets the state of wireframe mode
  20711. */
  20712. wireframe: boolean;
  20713. /**
  20714. * Gets the value specifying if point clouds are enabled
  20715. */
  20716. /**
  20717. * Sets the state of point cloud mode
  20718. */
  20719. pointsCloud: boolean;
  20720. /**
  20721. * Gets the material fill mode
  20722. */
  20723. /**
  20724. * Sets the material fill mode
  20725. */
  20726. fillMode: number;
  20727. /**
  20728. * @hidden
  20729. * Stores the effects for the material
  20730. */
  20731. _effect: Nullable<Effect>;
  20732. /**
  20733. * @hidden
  20734. * Specifies if the material was previously ready
  20735. */
  20736. _wasPreviouslyReady: boolean;
  20737. /**
  20738. * Specifies if uniform buffers should be used
  20739. */
  20740. private _useUBO;
  20741. /**
  20742. * Stores a reference to the scene
  20743. */
  20744. private _scene;
  20745. /**
  20746. * Stores the fill mode state
  20747. */
  20748. private _fillMode;
  20749. /**
  20750. * Specifies if the depth write state should be cached
  20751. */
  20752. private _cachedDepthWriteState;
  20753. /**
  20754. * Stores the uniform buffer
  20755. */
  20756. protected _uniformBuffer: UniformBuffer;
  20757. /** @hidden */
  20758. _indexInSceneMaterialArray: number;
  20759. /** @hidden */
  20760. meshMap: Nullable<{
  20761. [id: string]: AbstractMesh | undefined;
  20762. }>;
  20763. /**
  20764. * Creates a material instance
  20765. * @param name defines the name of the material
  20766. * @param scene defines the scene to reference
  20767. * @param doNotAdd specifies if the material should be added to the scene
  20768. */
  20769. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  20770. /**
  20771. * Returns a string representation of the current material
  20772. * @param fullDetails defines a boolean indicating which levels of logging is desired
  20773. * @returns a string with material information
  20774. */
  20775. toString(fullDetails?: boolean): string;
  20776. /**
  20777. * Gets the class name of the material
  20778. * @returns a string with the class name of the material
  20779. */
  20780. getClassName(): string;
  20781. /**
  20782. * Specifies if updates for the material been locked
  20783. */
  20784. readonly isFrozen: boolean;
  20785. /**
  20786. * Locks updates for the material
  20787. */
  20788. freeze(): void;
  20789. /**
  20790. * Unlocks updates for the material
  20791. */
  20792. unfreeze(): void;
  20793. /**
  20794. * Specifies if the material is ready to be used
  20795. * @param mesh defines the mesh to check
  20796. * @param useInstances specifies if instances should be used
  20797. * @returns a boolean indicating if the material is ready to be used
  20798. */
  20799. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  20800. /**
  20801. * Specifies that the submesh is ready to be used
  20802. * @param mesh defines the mesh to check
  20803. * @param subMesh defines which submesh to check
  20804. * @param useInstances specifies that instances should be used
  20805. * @returns a boolean indicating that the submesh is ready or not
  20806. */
  20807. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  20808. /**
  20809. * Returns the material effect
  20810. * @returns the effect associated with the material
  20811. */
  20812. getEffect(): Nullable<Effect>;
  20813. /**
  20814. * Returns the current scene
  20815. * @returns a Scene
  20816. */
  20817. getScene(): Scene;
  20818. /**
  20819. * Specifies if the material will require alpha blending
  20820. * @returns a boolean specifying if alpha blending is needed
  20821. */
  20822. needAlphaBlending(): boolean;
  20823. /**
  20824. * Specifies if the mesh will require alpha blending
  20825. * @param mesh defines the mesh to check
  20826. * @returns a boolean specifying if alpha blending is needed for the mesh
  20827. */
  20828. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  20829. /**
  20830. * Specifies if this material should be rendered in alpha test mode
  20831. * @returns a boolean specifying if an alpha test is needed.
  20832. */
  20833. needAlphaTesting(): boolean;
  20834. /**
  20835. * Gets the texture used for the alpha test
  20836. * @returns the texture to use for alpha testing
  20837. */
  20838. getAlphaTestTexture(): Nullable<BaseTexture>;
  20839. /**
  20840. * Marks the material to indicate that it needs to be re-calculated
  20841. */
  20842. markDirty(): void;
  20843. /** @hidden */
  20844. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  20845. /**
  20846. * Binds the material to the mesh
  20847. * @param world defines the world transformation matrix
  20848. * @param mesh defines the mesh to bind the material to
  20849. */
  20850. bind(world: Matrix, mesh?: Mesh): void;
  20851. /**
  20852. * Binds the submesh to the material
  20853. * @param world defines the world transformation matrix
  20854. * @param mesh defines the mesh containing the submesh
  20855. * @param subMesh defines the submesh to bind the material to
  20856. */
  20857. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  20858. /**
  20859. * Binds the world matrix to the material
  20860. * @param world defines the world transformation matrix
  20861. */
  20862. bindOnlyWorldMatrix(world: Matrix): void;
  20863. /**
  20864. * Binds the scene's uniform buffer to the effect.
  20865. * @param effect defines the effect to bind to the scene uniform buffer
  20866. * @param sceneUbo defines the uniform buffer storing scene data
  20867. */
  20868. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  20869. /**
  20870. * Binds the view matrix to the effect
  20871. * @param effect defines the effect to bind the view matrix to
  20872. */
  20873. bindView(effect: Effect): void;
  20874. /**
  20875. * Binds the view projection matrix to the effect
  20876. * @param effect defines the effect to bind the view projection matrix to
  20877. */
  20878. bindViewProjection(effect: Effect): void;
  20879. /**
  20880. * Specifies if material alpha testing should be turned on for the mesh
  20881. * @param mesh defines the mesh to check
  20882. */
  20883. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  20884. /**
  20885. * Processes to execute after binding the material to a mesh
  20886. * @param mesh defines the rendered mesh
  20887. */
  20888. protected _afterBind(mesh?: Mesh): void;
  20889. /**
  20890. * Unbinds the material from the mesh
  20891. */
  20892. unbind(): void;
  20893. /**
  20894. * Gets the active textures from the material
  20895. * @returns an array of textures
  20896. */
  20897. getActiveTextures(): BaseTexture[];
  20898. /**
  20899. * Specifies if the material uses a texture
  20900. * @param texture defines the texture to check against the material
  20901. * @returns a boolean specifying if the material uses the texture
  20902. */
  20903. hasTexture(texture: BaseTexture): boolean;
  20904. /**
  20905. * Makes a duplicate of the material, and gives it a new name
  20906. * @param name defines the new name for the duplicated material
  20907. * @returns the cloned material
  20908. */
  20909. clone(name: string): Nullable<Material>;
  20910. /**
  20911. * Gets the meshes bound to the material
  20912. * @returns an array of meshes bound to the material
  20913. */
  20914. getBindedMeshes(): AbstractMesh[];
  20915. /**
  20916. * Force shader compilation
  20917. * @param mesh defines the mesh associated with this material
  20918. * @param onCompiled defines a function to execute once the material is compiled
  20919. * @param options defines the options to configure the compilation
  20920. */
  20921. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  20922. clipPlane: boolean;
  20923. }>): void;
  20924. /**
  20925. * Force shader compilation
  20926. * @param mesh defines the mesh that will use this material
  20927. * @param options defines additional options for compiling the shaders
  20928. * @returns a promise that resolves when the compilation completes
  20929. */
  20930. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<{
  20931. clipPlane: boolean;
  20932. }>): Promise<void>;
  20933. private static readonly _AllDirtyCallBack;
  20934. private static readonly _ImageProcessingDirtyCallBack;
  20935. private static readonly _TextureDirtyCallBack;
  20936. private static readonly _FresnelDirtyCallBack;
  20937. private static readonly _MiscDirtyCallBack;
  20938. private static readonly _LightsDirtyCallBack;
  20939. private static readonly _AttributeDirtyCallBack;
  20940. private static _FresnelAndMiscDirtyCallBack;
  20941. private static _TextureAndMiscDirtyCallBack;
  20942. private static readonly _DirtyCallbackArray;
  20943. private static readonly _RunDirtyCallBacks;
  20944. /**
  20945. * Marks a define in the material to indicate that it needs to be re-computed
  20946. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  20947. */
  20948. markAsDirty(flag: number): void;
  20949. /**
  20950. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  20951. * @param func defines a function which checks material defines against the submeshes
  20952. */
  20953. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  20954. /**
  20955. * Indicates that we need to re-calculated for all submeshes
  20956. */
  20957. protected _markAllSubMeshesAsAllDirty(): void;
  20958. /**
  20959. * Indicates that image processing needs to be re-calculated for all submeshes
  20960. */
  20961. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  20962. /**
  20963. * Indicates that textures need to be re-calculated for all submeshes
  20964. */
  20965. protected _markAllSubMeshesAsTexturesDirty(): void;
  20966. /**
  20967. * Indicates that fresnel needs to be re-calculated for all submeshes
  20968. */
  20969. protected _markAllSubMeshesAsFresnelDirty(): void;
  20970. /**
  20971. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  20972. */
  20973. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  20974. /**
  20975. * Indicates that lights need to be re-calculated for all submeshes
  20976. */
  20977. protected _markAllSubMeshesAsLightsDirty(): void;
  20978. /**
  20979. * Indicates that attributes need to be re-calculated for all submeshes
  20980. */
  20981. protected _markAllSubMeshesAsAttributesDirty(): void;
  20982. /**
  20983. * Indicates that misc needs to be re-calculated for all submeshes
  20984. */
  20985. protected _markAllSubMeshesAsMiscDirty(): void;
  20986. /**
  20987. * Indicates that textures and misc need to be re-calculated for all submeshes
  20988. */
  20989. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  20990. /**
  20991. * Disposes the material
  20992. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  20993. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  20994. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  20995. */
  20996. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  20997. /** @hidden */
  20998. private releaseVertexArrayObject;
  20999. /**
  21000. * Serializes this material
  21001. * @returns the serialized material object
  21002. */
  21003. serialize(): any;
  21004. /**
  21005. * Creates a material from parsed material data
  21006. * @param parsedMaterial defines parsed material data
  21007. * @param scene defines the hosting scene
  21008. * @param rootUrl defines the root URL to use to load textures
  21009. * @returns a new material
  21010. */
  21011. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21012. }
  21013. }
  21014. declare module "babylonjs/Materials/multiMaterial" {
  21015. import { Nullable } from "babylonjs/types";
  21016. import { Scene } from "babylonjs/scene";
  21017. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21018. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21019. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21020. import { Material } from "babylonjs/Materials/material";
  21021. /**
  21022. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21023. * separate meshes. This can be use to improve performances.
  21024. * @see http://doc.babylonjs.com/how_to/multi_materials
  21025. */
  21026. export class MultiMaterial extends Material {
  21027. private _subMaterials;
  21028. /**
  21029. * Gets or Sets the list of Materials used within the multi material.
  21030. * They need to be ordered according to the submeshes order in the associated mesh
  21031. */
  21032. subMaterials: Nullable<Material>[];
  21033. /**
  21034. * Function used to align with Node.getChildren()
  21035. * @returns the list of Materials used within the multi material
  21036. */
  21037. getChildren(): Nullable<Material>[];
  21038. /**
  21039. * Instantiates a new Multi Material
  21040. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21041. * separate meshes. This can be use to improve performances.
  21042. * @see http://doc.babylonjs.com/how_to/multi_materials
  21043. * @param name Define the name in the scene
  21044. * @param scene Define the scene the material belongs to
  21045. */
  21046. constructor(name: string, scene: Scene);
  21047. private _hookArray;
  21048. /**
  21049. * Get one of the submaterial by its index in the submaterials array
  21050. * @param index The index to look the sub material at
  21051. * @returns The Material if the index has been defined
  21052. */
  21053. getSubMaterial(index: number): Nullable<Material>;
  21054. /**
  21055. * Get the list of active textures for the whole sub materials list.
  21056. * @returns All the textures that will be used during the rendering
  21057. */
  21058. getActiveTextures(): BaseTexture[];
  21059. /**
  21060. * Gets the current class name of the material e.g. "MultiMaterial"
  21061. * Mainly use in serialization.
  21062. * @returns the class name
  21063. */
  21064. getClassName(): string;
  21065. /**
  21066. * Checks if the material is ready to render the requested sub mesh
  21067. * @param mesh Define the mesh the submesh belongs to
  21068. * @param subMesh Define the sub mesh to look readyness for
  21069. * @param useInstances Define whether or not the material is used with instances
  21070. * @returns true if ready, otherwise false
  21071. */
  21072. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21073. /**
  21074. * Clones the current material and its related sub materials
  21075. * @param name Define the name of the newly cloned material
  21076. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21077. * @returns the cloned material
  21078. */
  21079. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21080. /**
  21081. * Serializes the materials into a JSON representation.
  21082. * @returns the JSON representation
  21083. */
  21084. serialize(): any;
  21085. /**
  21086. * Dispose the material and release its associated resources
  21087. * @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)
  21088. * @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)
  21089. * @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)
  21090. */
  21091. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21092. /**
  21093. * Creates a MultiMaterial from parsed MultiMaterial data.
  21094. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21095. * @param scene defines the hosting scene
  21096. * @returns a new MultiMaterial
  21097. */
  21098. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21099. }
  21100. }
  21101. declare module "babylonjs/Meshes/subMesh" {
  21102. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21103. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21104. import { Engine } from "babylonjs/Engines/engine";
  21105. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21106. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21107. import { Effect } from "babylonjs/Materials/effect";
  21108. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21109. import { Plane } from "babylonjs/Maths/math.plane";
  21110. import { Collider } from "babylonjs/Collisions/collider";
  21111. import { Material } from "babylonjs/Materials/material";
  21112. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21113. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21114. import { Mesh } from "babylonjs/Meshes/mesh";
  21115. import { Ray } from "babylonjs/Culling/ray";
  21116. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21117. /**
  21118. * Base class for submeshes
  21119. */
  21120. export class BaseSubMesh {
  21121. /** @hidden */
  21122. _materialDefines: Nullable<MaterialDefines>;
  21123. /** @hidden */
  21124. _materialEffect: Nullable<Effect>;
  21125. /**
  21126. * Gets associated effect
  21127. */
  21128. readonly effect: Nullable<Effect>;
  21129. /**
  21130. * Sets associated effect (effect used to render this submesh)
  21131. * @param effect defines the effect to associate with
  21132. * @param defines defines the set of defines used to compile this effect
  21133. */
  21134. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21135. }
  21136. /**
  21137. * Defines a subdivision inside a mesh
  21138. */
  21139. export class SubMesh extends BaseSubMesh implements ICullable {
  21140. /** the material index to use */
  21141. materialIndex: number;
  21142. /** vertex index start */
  21143. verticesStart: number;
  21144. /** vertices count */
  21145. verticesCount: number;
  21146. /** index start */
  21147. indexStart: number;
  21148. /** indices count */
  21149. indexCount: number;
  21150. /** @hidden */
  21151. _linesIndexCount: number;
  21152. private _mesh;
  21153. private _renderingMesh;
  21154. private _boundingInfo;
  21155. private _linesIndexBuffer;
  21156. /** @hidden */
  21157. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21158. /** @hidden */
  21159. _trianglePlanes: Plane[];
  21160. /** @hidden */
  21161. _lastColliderTransformMatrix: Nullable<Matrix>;
  21162. /** @hidden */
  21163. _renderId: number;
  21164. /** @hidden */
  21165. _alphaIndex: number;
  21166. /** @hidden */
  21167. _distanceToCamera: number;
  21168. /** @hidden */
  21169. _id: number;
  21170. private _currentMaterial;
  21171. /**
  21172. * Add a new submesh to a mesh
  21173. * @param materialIndex defines the material index to use
  21174. * @param verticesStart defines vertex index start
  21175. * @param verticesCount defines vertices count
  21176. * @param indexStart defines index start
  21177. * @param indexCount defines indices count
  21178. * @param mesh defines the parent mesh
  21179. * @param renderingMesh defines an optional rendering mesh
  21180. * @param createBoundingBox defines if bounding box should be created for this submesh
  21181. * @returns the new submesh
  21182. */
  21183. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21184. /**
  21185. * Creates a new submesh
  21186. * @param materialIndex defines the material index to use
  21187. * @param verticesStart defines vertex index start
  21188. * @param verticesCount defines vertices count
  21189. * @param indexStart defines index start
  21190. * @param indexCount defines indices count
  21191. * @param mesh defines the parent mesh
  21192. * @param renderingMesh defines an optional rendering mesh
  21193. * @param createBoundingBox defines if bounding box should be created for this submesh
  21194. */
  21195. constructor(
  21196. /** the material index to use */
  21197. materialIndex: number,
  21198. /** vertex index start */
  21199. verticesStart: number,
  21200. /** vertices count */
  21201. verticesCount: number,
  21202. /** index start */
  21203. indexStart: number,
  21204. /** indices count */
  21205. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21206. /**
  21207. * Returns true if this submesh covers the entire parent mesh
  21208. * @ignorenaming
  21209. */
  21210. readonly IsGlobal: boolean;
  21211. /**
  21212. * Returns the submesh BoudingInfo object
  21213. * @returns current bounding info (or mesh's one if the submesh is global)
  21214. */
  21215. getBoundingInfo(): BoundingInfo;
  21216. /**
  21217. * Sets the submesh BoundingInfo
  21218. * @param boundingInfo defines the new bounding info to use
  21219. * @returns the SubMesh
  21220. */
  21221. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21222. /**
  21223. * Returns the mesh of the current submesh
  21224. * @return the parent mesh
  21225. */
  21226. getMesh(): AbstractMesh;
  21227. /**
  21228. * Returns the rendering mesh of the submesh
  21229. * @returns the rendering mesh (could be different from parent mesh)
  21230. */
  21231. getRenderingMesh(): Mesh;
  21232. /**
  21233. * Returns the submesh material
  21234. * @returns null or the current material
  21235. */
  21236. getMaterial(): Nullable<Material>;
  21237. /**
  21238. * Sets a new updated BoundingInfo object to the submesh
  21239. * @param data defines an optional position array to use to determine the bounding info
  21240. * @returns the SubMesh
  21241. */
  21242. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21243. /** @hidden */
  21244. _checkCollision(collider: Collider): boolean;
  21245. /**
  21246. * Updates the submesh BoundingInfo
  21247. * @param world defines the world matrix to use to update the bounding info
  21248. * @returns the submesh
  21249. */
  21250. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21251. /**
  21252. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21253. * @param frustumPlanes defines the frustum planes
  21254. * @returns true if the submesh is intersecting with the frustum
  21255. */
  21256. isInFrustum(frustumPlanes: Plane[]): boolean;
  21257. /**
  21258. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21259. * @param frustumPlanes defines the frustum planes
  21260. * @returns true if the submesh is inside the frustum
  21261. */
  21262. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21263. /**
  21264. * Renders the submesh
  21265. * @param enableAlphaMode defines if alpha needs to be used
  21266. * @returns the submesh
  21267. */
  21268. render(enableAlphaMode: boolean): SubMesh;
  21269. /**
  21270. * @hidden
  21271. */
  21272. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21273. /**
  21274. * Checks if the submesh intersects with a ray
  21275. * @param ray defines the ray to test
  21276. * @returns true is the passed ray intersects the submesh bounding box
  21277. */
  21278. canIntersects(ray: Ray): boolean;
  21279. /**
  21280. * Intersects current submesh with a ray
  21281. * @param ray defines the ray to test
  21282. * @param positions defines mesh's positions array
  21283. * @param indices defines mesh's indices array
  21284. * @param fastCheck defines if only bounding info should be used
  21285. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21286. * @returns intersection info or null if no intersection
  21287. */
  21288. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21289. /** @hidden */
  21290. private _intersectLines;
  21291. /** @hidden */
  21292. private _intersectUnIndexedLines;
  21293. /** @hidden */
  21294. private _intersectTriangles;
  21295. /** @hidden */
  21296. private _intersectUnIndexedTriangles;
  21297. /** @hidden */
  21298. _rebuild(): void;
  21299. /**
  21300. * Creates a new submesh from the passed mesh
  21301. * @param newMesh defines the new hosting mesh
  21302. * @param newRenderingMesh defines an optional rendering mesh
  21303. * @returns the new submesh
  21304. */
  21305. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21306. /**
  21307. * Release associated resources
  21308. */
  21309. dispose(): void;
  21310. /**
  21311. * Gets the class name
  21312. * @returns the string "SubMesh".
  21313. */
  21314. getClassName(): string;
  21315. /**
  21316. * Creates a new submesh from indices data
  21317. * @param materialIndex the index of the main mesh material
  21318. * @param startIndex the index where to start the copy in the mesh indices array
  21319. * @param indexCount the number of indices to copy then from the startIndex
  21320. * @param mesh the main mesh to create the submesh from
  21321. * @param renderingMesh the optional rendering mesh
  21322. * @returns a new submesh
  21323. */
  21324. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21325. }
  21326. }
  21327. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21328. /**
  21329. * Class used to represent data loading progression
  21330. */
  21331. export class SceneLoaderFlags {
  21332. private static _ForceFullSceneLoadingForIncremental;
  21333. private static _ShowLoadingScreen;
  21334. private static _CleanBoneMatrixWeights;
  21335. private static _loggingLevel;
  21336. /**
  21337. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21338. */
  21339. static ForceFullSceneLoadingForIncremental: boolean;
  21340. /**
  21341. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21342. */
  21343. static ShowLoadingScreen: boolean;
  21344. /**
  21345. * Defines the current logging level (while loading the scene)
  21346. * @ignorenaming
  21347. */
  21348. static loggingLevel: number;
  21349. /**
  21350. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21351. */
  21352. static CleanBoneMatrixWeights: boolean;
  21353. }
  21354. }
  21355. declare module "babylonjs/Meshes/geometry" {
  21356. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21357. import { Scene } from "babylonjs/scene";
  21358. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21359. import { Engine } from "babylonjs/Engines/engine";
  21360. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21361. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21362. import { Effect } from "babylonjs/Materials/effect";
  21363. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21364. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21365. import { Mesh } from "babylonjs/Meshes/mesh";
  21366. /**
  21367. * Class used to store geometry data (vertex buffers + index buffer)
  21368. */
  21369. export class Geometry implements IGetSetVerticesData {
  21370. /**
  21371. * Gets or sets the ID of the geometry
  21372. */
  21373. id: string;
  21374. /**
  21375. * Gets or sets the unique ID of the geometry
  21376. */
  21377. uniqueId: number;
  21378. /**
  21379. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21380. */
  21381. delayLoadState: number;
  21382. /**
  21383. * Gets the file containing the data to load when running in delay load state
  21384. */
  21385. delayLoadingFile: Nullable<string>;
  21386. /**
  21387. * Callback called when the geometry is updated
  21388. */
  21389. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21390. private _scene;
  21391. private _engine;
  21392. private _meshes;
  21393. private _totalVertices;
  21394. /** @hidden */
  21395. _indices: IndicesArray;
  21396. /** @hidden */
  21397. _vertexBuffers: {
  21398. [key: string]: VertexBuffer;
  21399. };
  21400. private _isDisposed;
  21401. private _extend;
  21402. private _boundingBias;
  21403. /** @hidden */
  21404. _delayInfo: Array<string>;
  21405. private _indexBuffer;
  21406. private _indexBufferIsUpdatable;
  21407. /** @hidden */
  21408. _boundingInfo: Nullable<BoundingInfo>;
  21409. /** @hidden */
  21410. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21411. /** @hidden */
  21412. _softwareSkinningFrameId: number;
  21413. private _vertexArrayObjects;
  21414. private _updatable;
  21415. /** @hidden */
  21416. _positions: Nullable<Vector3[]>;
  21417. /**
  21418. * 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
  21419. */
  21420. /**
  21421. * 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
  21422. */
  21423. boundingBias: Vector2;
  21424. /**
  21425. * Static function used to attach a new empty geometry to a mesh
  21426. * @param mesh defines the mesh to attach the geometry to
  21427. * @returns the new Geometry
  21428. */
  21429. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  21430. /**
  21431. * Creates a new geometry
  21432. * @param id defines the unique ID
  21433. * @param scene defines the hosting scene
  21434. * @param vertexData defines the VertexData used to get geometry data
  21435. * @param updatable defines if geometry must be updatable (false by default)
  21436. * @param mesh defines the mesh that will be associated with the geometry
  21437. */
  21438. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  21439. /**
  21440. * Gets the current extend of the geometry
  21441. */
  21442. readonly extend: {
  21443. minimum: Vector3;
  21444. maximum: Vector3;
  21445. };
  21446. /**
  21447. * Gets the hosting scene
  21448. * @returns the hosting Scene
  21449. */
  21450. getScene(): Scene;
  21451. /**
  21452. * Gets the hosting engine
  21453. * @returns the hosting Engine
  21454. */
  21455. getEngine(): Engine;
  21456. /**
  21457. * Defines if the geometry is ready to use
  21458. * @returns true if the geometry is ready to be used
  21459. */
  21460. isReady(): boolean;
  21461. /**
  21462. * Gets a value indicating that the geometry should not be serialized
  21463. */
  21464. readonly doNotSerialize: boolean;
  21465. /** @hidden */
  21466. _rebuild(): void;
  21467. /**
  21468. * Affects all geometry data in one call
  21469. * @param vertexData defines the geometry data
  21470. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  21471. */
  21472. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  21473. /**
  21474. * Set specific vertex data
  21475. * @param kind defines the data kind (Position, normal, etc...)
  21476. * @param data defines the vertex data to use
  21477. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21478. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21479. */
  21480. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  21481. /**
  21482. * Removes a specific vertex data
  21483. * @param kind defines the data kind (Position, normal, etc...)
  21484. */
  21485. removeVerticesData(kind: string): void;
  21486. /**
  21487. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  21488. * @param buffer defines the vertex buffer to use
  21489. * @param totalVertices defines the total number of vertices for position kind (could be null)
  21490. */
  21491. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  21492. /**
  21493. * Update a specific vertex buffer
  21494. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  21495. * It will do nothing if the buffer is not updatable
  21496. * @param kind defines the data kind (Position, normal, etc...)
  21497. * @param data defines the data to use
  21498. * @param offset defines the offset in the target buffer where to store the data
  21499. * @param useBytes set to true if the offset is in bytes
  21500. */
  21501. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  21502. /**
  21503. * Update a specific vertex buffer
  21504. * This function will create a new buffer if the current one is not updatable
  21505. * @param kind defines the data kind (Position, normal, etc...)
  21506. * @param data defines the data to use
  21507. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  21508. */
  21509. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  21510. private _updateBoundingInfo;
  21511. /** @hidden */
  21512. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  21513. /**
  21514. * Gets total number of vertices
  21515. * @returns the total number of vertices
  21516. */
  21517. getTotalVertices(): number;
  21518. /**
  21519. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21520. * @param kind defines the data kind (Position, normal, etc...)
  21521. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21522. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21523. * @returns a float array containing vertex data
  21524. */
  21525. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21526. /**
  21527. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  21528. * @param kind defines the data kind (Position, normal, etc...)
  21529. * @returns true if the vertex buffer with the specified kind is updatable
  21530. */
  21531. isVertexBufferUpdatable(kind: string): boolean;
  21532. /**
  21533. * Gets a specific vertex buffer
  21534. * @param kind defines the data kind (Position, normal, etc...)
  21535. * @returns a VertexBuffer
  21536. */
  21537. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  21538. /**
  21539. * Returns all vertex buffers
  21540. * @return an object holding all vertex buffers indexed by kind
  21541. */
  21542. getVertexBuffers(): Nullable<{
  21543. [key: string]: VertexBuffer;
  21544. }>;
  21545. /**
  21546. * Gets a boolean indicating if specific vertex buffer is present
  21547. * @param kind defines the data kind (Position, normal, etc...)
  21548. * @returns true if data is present
  21549. */
  21550. isVerticesDataPresent(kind: string): boolean;
  21551. /**
  21552. * Gets a list of all attached data kinds (Position, normal, etc...)
  21553. * @returns a list of string containing all kinds
  21554. */
  21555. getVerticesDataKinds(): string[];
  21556. /**
  21557. * Update index buffer
  21558. * @param indices defines the indices to store in the index buffer
  21559. * @param offset defines the offset in the target buffer where to store the data
  21560. * @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)
  21561. */
  21562. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  21563. /**
  21564. * Creates a new index buffer
  21565. * @param indices defines the indices to store in the index buffer
  21566. * @param totalVertices defines the total number of vertices (could be null)
  21567. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  21568. */
  21569. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  21570. /**
  21571. * Return the total number of indices
  21572. * @returns the total number of indices
  21573. */
  21574. getTotalIndices(): number;
  21575. /**
  21576. * Gets the index buffer array
  21577. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21578. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21579. * @returns the index buffer array
  21580. */
  21581. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  21582. /**
  21583. * Gets the index buffer
  21584. * @return the index buffer
  21585. */
  21586. getIndexBuffer(): Nullable<DataBuffer>;
  21587. /** @hidden */
  21588. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  21589. /**
  21590. * Release the associated resources for a specific mesh
  21591. * @param mesh defines the source mesh
  21592. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  21593. */
  21594. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  21595. /**
  21596. * Apply current geometry to a given mesh
  21597. * @param mesh defines the mesh to apply geometry to
  21598. */
  21599. applyToMesh(mesh: Mesh): void;
  21600. private _updateExtend;
  21601. private _applyToMesh;
  21602. private notifyUpdate;
  21603. /**
  21604. * Load the geometry if it was flagged as delay loaded
  21605. * @param scene defines the hosting scene
  21606. * @param onLoaded defines a callback called when the geometry is loaded
  21607. */
  21608. load(scene: Scene, onLoaded?: () => void): void;
  21609. private _queueLoad;
  21610. /**
  21611. * Invert the geometry to move from a right handed system to a left handed one.
  21612. */
  21613. toLeftHanded(): void;
  21614. /** @hidden */
  21615. _resetPointsArrayCache(): void;
  21616. /** @hidden */
  21617. _generatePointsArray(): boolean;
  21618. /**
  21619. * Gets a value indicating if the geometry is disposed
  21620. * @returns true if the geometry was disposed
  21621. */
  21622. isDisposed(): boolean;
  21623. private _disposeVertexArrayObjects;
  21624. /**
  21625. * Free all associated resources
  21626. */
  21627. dispose(): void;
  21628. /**
  21629. * Clone the current geometry into a new geometry
  21630. * @param id defines the unique ID of the new geometry
  21631. * @returns a new geometry object
  21632. */
  21633. copy(id: string): Geometry;
  21634. /**
  21635. * Serialize the current geometry info (and not the vertices data) into a JSON object
  21636. * @return a JSON representation of the current geometry data (without the vertices data)
  21637. */
  21638. serialize(): any;
  21639. private toNumberArray;
  21640. /**
  21641. * Serialize all vertices data into a JSON oject
  21642. * @returns a JSON representation of the current geometry data
  21643. */
  21644. serializeVerticeData(): any;
  21645. /**
  21646. * Extracts a clone of a mesh geometry
  21647. * @param mesh defines the source mesh
  21648. * @param id defines the unique ID of the new geometry object
  21649. * @returns the new geometry object
  21650. */
  21651. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  21652. /**
  21653. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  21654. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  21655. * Be aware Math.random() could cause collisions, but:
  21656. * "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"
  21657. * @returns a string containing a new GUID
  21658. */
  21659. static RandomId(): string;
  21660. /** @hidden */
  21661. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  21662. private static _CleanMatricesWeights;
  21663. /**
  21664. * Create a new geometry from persisted data (Using .babylon file format)
  21665. * @param parsedVertexData defines the persisted data
  21666. * @param scene defines the hosting scene
  21667. * @param rootUrl defines the root url to use to load assets (like delayed data)
  21668. * @returns the new geometry object
  21669. */
  21670. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  21671. }
  21672. }
  21673. declare module "babylonjs/Meshes/mesh.vertexData" {
  21674. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  21675. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  21676. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  21677. import { Geometry } from "babylonjs/Meshes/geometry";
  21678. import { Mesh } from "babylonjs/Meshes/mesh";
  21679. /**
  21680. * Define an interface for all classes that will get and set the data on vertices
  21681. */
  21682. export interface IGetSetVerticesData {
  21683. /**
  21684. * Gets a boolean indicating if specific vertex data is present
  21685. * @param kind defines the vertex data kind to use
  21686. * @returns true is data kind is present
  21687. */
  21688. isVerticesDataPresent(kind: string): boolean;
  21689. /**
  21690. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21691. * @param kind defines the data kind (Position, normal, etc...)
  21692. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21693. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21694. * @returns a float array containing vertex data
  21695. */
  21696. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21697. /**
  21698. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  21699. * @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.
  21700. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21701. * @returns the indices array or an empty array if the mesh has no geometry
  21702. */
  21703. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  21704. /**
  21705. * Set specific vertex data
  21706. * @param kind defines the data kind (Position, normal, etc...)
  21707. * @param data defines the vertex data to use
  21708. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21709. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21710. */
  21711. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  21712. /**
  21713. * Update a specific associated vertex buffer
  21714. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  21715. * - VertexBuffer.PositionKind
  21716. * - VertexBuffer.UVKind
  21717. * - VertexBuffer.UV2Kind
  21718. * - VertexBuffer.UV3Kind
  21719. * - VertexBuffer.UV4Kind
  21720. * - VertexBuffer.UV5Kind
  21721. * - VertexBuffer.UV6Kind
  21722. * - VertexBuffer.ColorKind
  21723. * - VertexBuffer.MatricesIndicesKind
  21724. * - VertexBuffer.MatricesIndicesExtraKind
  21725. * - VertexBuffer.MatricesWeightsKind
  21726. * - VertexBuffer.MatricesWeightsExtraKind
  21727. * @param data defines the data source
  21728. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  21729. * @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)
  21730. */
  21731. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  21732. /**
  21733. * Creates a new index buffer
  21734. * @param indices defines the indices to store in the index buffer
  21735. * @param totalVertices defines the total number of vertices (could be null)
  21736. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  21737. */
  21738. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  21739. }
  21740. /**
  21741. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  21742. */
  21743. export class VertexData {
  21744. /**
  21745. * Mesh side orientation : usually the external or front surface
  21746. */
  21747. static readonly FRONTSIDE: number;
  21748. /**
  21749. * Mesh side orientation : usually the internal or back surface
  21750. */
  21751. static readonly BACKSIDE: number;
  21752. /**
  21753. * Mesh side orientation : both internal and external or front and back surfaces
  21754. */
  21755. static readonly DOUBLESIDE: number;
  21756. /**
  21757. * Mesh side orientation : by default, `FRONTSIDE`
  21758. */
  21759. static readonly DEFAULTSIDE: number;
  21760. /**
  21761. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  21762. */
  21763. positions: Nullable<FloatArray>;
  21764. /**
  21765. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  21766. */
  21767. normals: Nullable<FloatArray>;
  21768. /**
  21769. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  21770. */
  21771. tangents: Nullable<FloatArray>;
  21772. /**
  21773. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21774. */
  21775. uvs: Nullable<FloatArray>;
  21776. /**
  21777. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21778. */
  21779. uvs2: Nullable<FloatArray>;
  21780. /**
  21781. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21782. */
  21783. uvs3: Nullable<FloatArray>;
  21784. /**
  21785. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21786. */
  21787. uvs4: Nullable<FloatArray>;
  21788. /**
  21789. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21790. */
  21791. uvs5: Nullable<FloatArray>;
  21792. /**
  21793. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  21794. */
  21795. uvs6: Nullable<FloatArray>;
  21796. /**
  21797. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  21798. */
  21799. colors: Nullable<FloatArray>;
  21800. /**
  21801. * 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).
  21802. */
  21803. matricesIndices: Nullable<FloatArray>;
  21804. /**
  21805. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  21806. */
  21807. matricesWeights: Nullable<FloatArray>;
  21808. /**
  21809. * An array extending the number of possible indices
  21810. */
  21811. matricesIndicesExtra: Nullable<FloatArray>;
  21812. /**
  21813. * An array extending the number of possible weights when the number of indices is extended
  21814. */
  21815. matricesWeightsExtra: Nullable<FloatArray>;
  21816. /**
  21817. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  21818. */
  21819. indices: Nullable<IndicesArray>;
  21820. /**
  21821. * Uses the passed data array to set the set the values for the specified kind of data
  21822. * @param data a linear array of floating numbers
  21823. * @param kind the type of data that is being set, eg positions, colors etc
  21824. */
  21825. set(data: FloatArray, kind: string): void;
  21826. /**
  21827. * Associates the vertexData to the passed Mesh.
  21828. * Sets it as updatable or not (default `false`)
  21829. * @param mesh the mesh the vertexData is applied to
  21830. * @param updatable when used and having the value true allows new data to update the vertexData
  21831. * @returns the VertexData
  21832. */
  21833. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  21834. /**
  21835. * Associates the vertexData to the passed Geometry.
  21836. * Sets it as updatable or not (default `false`)
  21837. * @param geometry the geometry the vertexData is applied to
  21838. * @param updatable when used and having the value true allows new data to update the vertexData
  21839. * @returns VertexData
  21840. */
  21841. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  21842. /**
  21843. * Updates the associated mesh
  21844. * @param mesh the mesh to be updated
  21845. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  21846. * @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
  21847. * @returns VertexData
  21848. */
  21849. updateMesh(mesh: Mesh): VertexData;
  21850. /**
  21851. * Updates the associated geometry
  21852. * @param geometry the geometry to be updated
  21853. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  21854. * @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
  21855. * @returns VertexData.
  21856. */
  21857. updateGeometry(geometry: Geometry): VertexData;
  21858. private _applyTo;
  21859. private _update;
  21860. /**
  21861. * Transforms each position and each normal of the vertexData according to the passed Matrix
  21862. * @param matrix the transforming matrix
  21863. * @returns the VertexData
  21864. */
  21865. transform(matrix: Matrix): VertexData;
  21866. /**
  21867. * Merges the passed VertexData into the current one
  21868. * @param other the VertexData to be merged into the current one
  21869. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  21870. * @returns the modified VertexData
  21871. */
  21872. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  21873. private _mergeElement;
  21874. private _validate;
  21875. /**
  21876. * Serializes the VertexData
  21877. * @returns a serialized object
  21878. */
  21879. serialize(): any;
  21880. /**
  21881. * Extracts the vertexData from a mesh
  21882. * @param mesh the mesh from which to extract the VertexData
  21883. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  21884. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  21885. * @returns the object VertexData associated to the passed mesh
  21886. */
  21887. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  21888. /**
  21889. * Extracts the vertexData from the geometry
  21890. * @param geometry the geometry from which to extract the VertexData
  21891. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  21892. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  21893. * @returns the object VertexData associated to the passed mesh
  21894. */
  21895. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  21896. private static _ExtractFrom;
  21897. /**
  21898. * Creates the VertexData for a Ribbon
  21899. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  21900. * * pathArray array of paths, each of which an array of successive Vector3
  21901. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  21902. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  21903. * * 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
  21904. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  21905. * * 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)
  21906. * * 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)
  21907. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  21908. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  21909. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  21910. * @returns the VertexData of the ribbon
  21911. */
  21912. static CreateRibbon(options: {
  21913. pathArray: Vector3[][];
  21914. closeArray?: boolean;
  21915. closePath?: boolean;
  21916. offset?: number;
  21917. sideOrientation?: number;
  21918. frontUVs?: Vector4;
  21919. backUVs?: Vector4;
  21920. invertUV?: boolean;
  21921. uvs?: Vector2[];
  21922. colors?: Color4[];
  21923. }): VertexData;
  21924. /**
  21925. * Creates the VertexData for a box
  21926. * @param options an object used to set the following optional parameters for the box, required but can be empty
  21927. * * size sets the width, height and depth of the box to the value of size, optional default 1
  21928. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  21929. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  21930. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  21931. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  21932. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  21933. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  21934. * * 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)
  21935. * * 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)
  21936. * @returns the VertexData of the box
  21937. */
  21938. static CreateBox(options: {
  21939. size?: number;
  21940. width?: number;
  21941. height?: number;
  21942. depth?: number;
  21943. faceUV?: Vector4[];
  21944. faceColors?: Color4[];
  21945. sideOrientation?: number;
  21946. frontUVs?: Vector4;
  21947. backUVs?: Vector4;
  21948. }): VertexData;
  21949. /**
  21950. * Creates the VertexData for a tiled box
  21951. * @param options an object used to set the following optional parameters for the box, required but can be empty
  21952. * * faceTiles sets the pattern, tile size and number of tiles for a face
  21953. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  21954. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  21955. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  21956. * @returns the VertexData of the box
  21957. */
  21958. static CreateTiledBox(options: {
  21959. pattern?: number;
  21960. width?: number;
  21961. height?: number;
  21962. depth?: number;
  21963. tileSize?: number;
  21964. tileWidth?: number;
  21965. tileHeight?: number;
  21966. alignHorizontal?: number;
  21967. alignVertical?: number;
  21968. faceUV?: Vector4[];
  21969. faceColors?: Color4[];
  21970. sideOrientation?: number;
  21971. }): VertexData;
  21972. /**
  21973. * Creates the VertexData for a tiled plane
  21974. * @param options an object used to set the following optional parameters for the box, required but can be empty
  21975. * * pattern a limited pattern arrangement depending on the number
  21976. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  21977. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  21978. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  21979. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  21980. * * 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)
  21981. * * 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)
  21982. * @returns the VertexData of the tiled plane
  21983. */
  21984. static CreateTiledPlane(options: {
  21985. pattern?: number;
  21986. tileSize?: number;
  21987. tileWidth?: number;
  21988. tileHeight?: number;
  21989. size?: number;
  21990. width?: number;
  21991. height?: number;
  21992. alignHorizontal?: number;
  21993. alignVertical?: number;
  21994. sideOrientation?: number;
  21995. frontUVs?: Vector4;
  21996. backUVs?: Vector4;
  21997. }): VertexData;
  21998. /**
  21999. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22000. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22001. * * segments sets the number of horizontal strips optional, default 32
  22002. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22003. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22004. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22005. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22006. * * 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
  22007. * * 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
  22008. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22009. * * 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)
  22010. * * 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)
  22011. * @returns the VertexData of the ellipsoid
  22012. */
  22013. static CreateSphere(options: {
  22014. segments?: number;
  22015. diameter?: number;
  22016. diameterX?: number;
  22017. diameterY?: number;
  22018. diameterZ?: number;
  22019. arc?: number;
  22020. slice?: number;
  22021. sideOrientation?: number;
  22022. frontUVs?: Vector4;
  22023. backUVs?: Vector4;
  22024. }): VertexData;
  22025. /**
  22026. * Creates the VertexData for a cylinder, cone or prism
  22027. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22028. * * height sets the height (y direction) of the cylinder, optional, default 2
  22029. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22030. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22031. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22032. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22033. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22034. * * 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
  22035. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22036. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22037. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22038. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22039. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22040. * * 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)
  22041. * * 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)
  22042. * @returns the VertexData of the cylinder, cone or prism
  22043. */
  22044. static CreateCylinder(options: {
  22045. height?: number;
  22046. diameterTop?: number;
  22047. diameterBottom?: number;
  22048. diameter?: number;
  22049. tessellation?: number;
  22050. subdivisions?: number;
  22051. arc?: number;
  22052. faceColors?: Color4[];
  22053. faceUV?: Vector4[];
  22054. hasRings?: boolean;
  22055. enclose?: boolean;
  22056. sideOrientation?: number;
  22057. frontUVs?: Vector4;
  22058. backUVs?: Vector4;
  22059. }): VertexData;
  22060. /**
  22061. * Creates the VertexData for a torus
  22062. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22063. * * diameter the diameter of the torus, optional default 1
  22064. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22065. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22066. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22067. * * 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)
  22068. * * 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)
  22069. * @returns the VertexData of the torus
  22070. */
  22071. static CreateTorus(options: {
  22072. diameter?: number;
  22073. thickness?: number;
  22074. tessellation?: number;
  22075. sideOrientation?: number;
  22076. frontUVs?: Vector4;
  22077. backUVs?: Vector4;
  22078. }): VertexData;
  22079. /**
  22080. * Creates the VertexData of the LineSystem
  22081. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22082. * - lines an array of lines, each line being an array of successive Vector3
  22083. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22084. * @returns the VertexData of the LineSystem
  22085. */
  22086. static CreateLineSystem(options: {
  22087. lines: Vector3[][];
  22088. colors?: Nullable<Color4[][]>;
  22089. }): VertexData;
  22090. /**
  22091. * Create the VertexData for a DashedLines
  22092. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22093. * - points an array successive Vector3
  22094. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22095. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22096. * - dashNb the intended total number of dashes, optional, default 200
  22097. * @returns the VertexData for the DashedLines
  22098. */
  22099. static CreateDashedLines(options: {
  22100. points: Vector3[];
  22101. dashSize?: number;
  22102. gapSize?: number;
  22103. dashNb?: number;
  22104. }): VertexData;
  22105. /**
  22106. * Creates the VertexData for a Ground
  22107. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22108. * - width the width (x direction) of the ground, optional, default 1
  22109. * - height the height (z direction) of the ground, optional, default 1
  22110. * - subdivisions the number of subdivisions per side, optional, default 1
  22111. * @returns the VertexData of the Ground
  22112. */
  22113. static CreateGround(options: {
  22114. width?: number;
  22115. height?: number;
  22116. subdivisions?: number;
  22117. subdivisionsX?: number;
  22118. subdivisionsY?: number;
  22119. }): VertexData;
  22120. /**
  22121. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22122. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22123. * * xmin the ground minimum X coordinate, optional, default -1
  22124. * * zmin the ground minimum Z coordinate, optional, default -1
  22125. * * xmax the ground maximum X coordinate, optional, default 1
  22126. * * zmax the ground maximum Z coordinate, optional, default 1
  22127. * * 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}
  22128. * * 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}
  22129. * @returns the VertexData of the TiledGround
  22130. */
  22131. static CreateTiledGround(options: {
  22132. xmin: number;
  22133. zmin: number;
  22134. xmax: number;
  22135. zmax: number;
  22136. subdivisions?: {
  22137. w: number;
  22138. h: number;
  22139. };
  22140. precision?: {
  22141. w: number;
  22142. h: number;
  22143. };
  22144. }): VertexData;
  22145. /**
  22146. * Creates the VertexData of the Ground designed from a heightmap
  22147. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22148. * * width the width (x direction) of the ground
  22149. * * height the height (z direction) of the ground
  22150. * * subdivisions the number of subdivisions per side
  22151. * * minHeight the minimum altitude on the ground, optional, default 0
  22152. * * maxHeight the maximum altitude on the ground, optional default 1
  22153. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22154. * * buffer the array holding the image color data
  22155. * * bufferWidth the width of image
  22156. * * bufferHeight the height of image
  22157. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22158. * @returns the VertexData of the Ground designed from a heightmap
  22159. */
  22160. static CreateGroundFromHeightMap(options: {
  22161. width: number;
  22162. height: number;
  22163. subdivisions: number;
  22164. minHeight: number;
  22165. maxHeight: number;
  22166. colorFilter: Color3;
  22167. buffer: Uint8Array;
  22168. bufferWidth: number;
  22169. bufferHeight: number;
  22170. alphaFilter: number;
  22171. }): VertexData;
  22172. /**
  22173. * Creates the VertexData for a Plane
  22174. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22175. * * size sets the width and height of the plane to the value of size, optional default 1
  22176. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22177. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22178. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22179. * * 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)
  22180. * * 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)
  22181. * @returns the VertexData of the box
  22182. */
  22183. static CreatePlane(options: {
  22184. size?: number;
  22185. width?: number;
  22186. height?: number;
  22187. sideOrientation?: number;
  22188. frontUVs?: Vector4;
  22189. backUVs?: Vector4;
  22190. }): VertexData;
  22191. /**
  22192. * Creates the VertexData of the Disc or regular Polygon
  22193. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22194. * * radius the radius of the disc, optional default 0.5
  22195. * * tessellation the number of polygon sides, optional, default 64
  22196. * * 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
  22197. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22198. * * 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)
  22199. * * 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)
  22200. * @returns the VertexData of the box
  22201. */
  22202. static CreateDisc(options: {
  22203. radius?: number;
  22204. tessellation?: number;
  22205. arc?: number;
  22206. sideOrientation?: number;
  22207. frontUVs?: Vector4;
  22208. backUVs?: Vector4;
  22209. }): VertexData;
  22210. /**
  22211. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22212. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22213. * @param polygon a mesh built from polygonTriangulation.build()
  22214. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22215. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22216. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22217. * @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)
  22218. * @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)
  22219. * @returns the VertexData of the Polygon
  22220. */
  22221. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22222. /**
  22223. * Creates the VertexData of the IcoSphere
  22224. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22225. * * radius the radius of the IcoSphere, optional default 1
  22226. * * radiusX allows stretching in the x direction, optional, default radius
  22227. * * radiusY allows stretching in the y direction, optional, default radius
  22228. * * radiusZ allows stretching in the z direction, optional, default radius
  22229. * * flat when true creates a flat shaded mesh, optional, default true
  22230. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22231. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22232. * * 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)
  22233. * * 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)
  22234. * @returns the VertexData of the IcoSphere
  22235. */
  22236. static CreateIcoSphere(options: {
  22237. radius?: number;
  22238. radiusX?: number;
  22239. radiusY?: number;
  22240. radiusZ?: number;
  22241. flat?: boolean;
  22242. subdivisions?: number;
  22243. sideOrientation?: number;
  22244. frontUVs?: Vector4;
  22245. backUVs?: Vector4;
  22246. }): VertexData;
  22247. /**
  22248. * Creates the VertexData for a Polyhedron
  22249. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22250. * * type provided types are:
  22251. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22252. * * 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)
  22253. * * size the size of the IcoSphere, optional default 1
  22254. * * sizeX allows stretching in the x direction, optional, default size
  22255. * * sizeY allows stretching in the y direction, optional, default size
  22256. * * sizeZ allows stretching in the z direction, optional, default size
  22257. * * 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
  22258. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22259. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22260. * * flat when true creates a flat shaded mesh, optional, default true
  22261. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22262. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22263. * * 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)
  22264. * * 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)
  22265. * @returns the VertexData of the Polyhedron
  22266. */
  22267. static CreatePolyhedron(options: {
  22268. type?: number;
  22269. size?: number;
  22270. sizeX?: number;
  22271. sizeY?: number;
  22272. sizeZ?: number;
  22273. custom?: any;
  22274. faceUV?: Vector4[];
  22275. faceColors?: Color4[];
  22276. flat?: boolean;
  22277. sideOrientation?: number;
  22278. frontUVs?: Vector4;
  22279. backUVs?: Vector4;
  22280. }): VertexData;
  22281. /**
  22282. * Creates the VertexData for a TorusKnot
  22283. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22284. * * radius the radius of the torus knot, optional, default 2
  22285. * * tube the thickness of the tube, optional, default 0.5
  22286. * * radialSegments the number of sides on each tube segments, optional, default 32
  22287. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22288. * * p the number of windings around the z axis, optional, default 2
  22289. * * q the number of windings around the x axis, optional, default 3
  22290. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22291. * * 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)
  22292. * * 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)
  22293. * @returns the VertexData of the Torus Knot
  22294. */
  22295. static CreateTorusKnot(options: {
  22296. radius?: number;
  22297. tube?: number;
  22298. radialSegments?: number;
  22299. tubularSegments?: number;
  22300. p?: number;
  22301. q?: number;
  22302. sideOrientation?: number;
  22303. frontUVs?: Vector4;
  22304. backUVs?: Vector4;
  22305. }): VertexData;
  22306. /**
  22307. * Compute normals for given positions and indices
  22308. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22309. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22310. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22311. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22312. * * facetNormals : optional array of facet normals (vector3)
  22313. * * facetPositions : optional array of facet positions (vector3)
  22314. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22315. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22316. * * bInfo : optional bounding info, required for facetPartitioning computation
  22317. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22318. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22319. * * useRightHandedSystem: optional boolean to for right handed system computation
  22320. * * depthSort : optional boolean to enable the facet depth sort computation
  22321. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22322. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22323. */
  22324. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22325. facetNormals?: any;
  22326. facetPositions?: any;
  22327. facetPartitioning?: any;
  22328. ratio?: number;
  22329. bInfo?: any;
  22330. bbSize?: Vector3;
  22331. subDiv?: any;
  22332. useRightHandedSystem?: boolean;
  22333. depthSort?: boolean;
  22334. distanceTo?: Vector3;
  22335. depthSortedFacets?: any;
  22336. }): void;
  22337. /** @hidden */
  22338. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22339. /**
  22340. * Applies VertexData created from the imported parameters to the geometry
  22341. * @param parsedVertexData the parsed data from an imported file
  22342. * @param geometry the geometry to apply the VertexData to
  22343. */
  22344. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22345. }
  22346. }
  22347. declare module "babylonjs/Morph/morphTarget" {
  22348. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22349. import { Observable } from "babylonjs/Misc/observable";
  22350. import { Nullable, FloatArray } from "babylonjs/types";
  22351. import { Scene } from "babylonjs/scene";
  22352. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22353. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22354. /**
  22355. * Defines a target to use with MorphTargetManager
  22356. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22357. */
  22358. export class MorphTarget implements IAnimatable {
  22359. /** defines the name of the target */
  22360. name: string;
  22361. /**
  22362. * Gets or sets the list of animations
  22363. */
  22364. animations: import("babylonjs/Animations/animation").Animation[];
  22365. private _scene;
  22366. private _positions;
  22367. private _normals;
  22368. private _tangents;
  22369. private _uvs;
  22370. private _influence;
  22371. /**
  22372. * Observable raised when the influence changes
  22373. */
  22374. onInfluenceChanged: Observable<boolean>;
  22375. /** @hidden */
  22376. _onDataLayoutChanged: Observable<void>;
  22377. /**
  22378. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22379. */
  22380. influence: number;
  22381. /**
  22382. * Gets or sets the id of the morph Target
  22383. */
  22384. id: string;
  22385. private _animationPropertiesOverride;
  22386. /**
  22387. * Gets or sets the animation properties override
  22388. */
  22389. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22390. /**
  22391. * Creates a new MorphTarget
  22392. * @param name defines the name of the target
  22393. * @param influence defines the influence to use
  22394. * @param scene defines the scene the morphtarget belongs to
  22395. */
  22396. constructor(
  22397. /** defines the name of the target */
  22398. name: string, influence?: number, scene?: Nullable<Scene>);
  22399. /**
  22400. * Gets a boolean defining if the target contains position data
  22401. */
  22402. readonly hasPositions: boolean;
  22403. /**
  22404. * Gets a boolean defining if the target contains normal data
  22405. */
  22406. readonly hasNormals: boolean;
  22407. /**
  22408. * Gets a boolean defining if the target contains tangent data
  22409. */
  22410. readonly hasTangents: boolean;
  22411. /**
  22412. * Gets a boolean defining if the target contains texture coordinates data
  22413. */
  22414. readonly hasUVs: boolean;
  22415. /**
  22416. * Affects position data to this target
  22417. * @param data defines the position data to use
  22418. */
  22419. setPositions(data: Nullable<FloatArray>): void;
  22420. /**
  22421. * Gets the position data stored in this target
  22422. * @returns a FloatArray containing the position data (or null if not present)
  22423. */
  22424. getPositions(): Nullable<FloatArray>;
  22425. /**
  22426. * Affects normal data to this target
  22427. * @param data defines the normal data to use
  22428. */
  22429. setNormals(data: Nullable<FloatArray>): void;
  22430. /**
  22431. * Gets the normal data stored in this target
  22432. * @returns a FloatArray containing the normal data (or null if not present)
  22433. */
  22434. getNormals(): Nullable<FloatArray>;
  22435. /**
  22436. * Affects tangent data to this target
  22437. * @param data defines the tangent data to use
  22438. */
  22439. setTangents(data: Nullable<FloatArray>): void;
  22440. /**
  22441. * Gets the tangent data stored in this target
  22442. * @returns a FloatArray containing the tangent data (or null if not present)
  22443. */
  22444. getTangents(): Nullable<FloatArray>;
  22445. /**
  22446. * Affects texture coordinates data to this target
  22447. * @param data defines the texture coordinates data to use
  22448. */
  22449. setUVs(data: Nullable<FloatArray>): void;
  22450. /**
  22451. * Gets the texture coordinates data stored in this target
  22452. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  22453. */
  22454. getUVs(): Nullable<FloatArray>;
  22455. /**
  22456. * Serializes the current target into a Serialization object
  22457. * @returns the serialized object
  22458. */
  22459. serialize(): any;
  22460. /**
  22461. * Returns the string "MorphTarget"
  22462. * @returns "MorphTarget"
  22463. */
  22464. getClassName(): string;
  22465. /**
  22466. * Creates a new target from serialized data
  22467. * @param serializationObject defines the serialized data to use
  22468. * @returns a new MorphTarget
  22469. */
  22470. static Parse(serializationObject: any): MorphTarget;
  22471. /**
  22472. * Creates a MorphTarget from mesh data
  22473. * @param mesh defines the source mesh
  22474. * @param name defines the name to use for the new target
  22475. * @param influence defines the influence to attach to the target
  22476. * @returns a new MorphTarget
  22477. */
  22478. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  22479. }
  22480. }
  22481. declare module "babylonjs/Morph/morphTargetManager" {
  22482. import { Nullable } from "babylonjs/types";
  22483. import { Scene } from "babylonjs/scene";
  22484. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  22485. /**
  22486. * This class is used to deform meshes using morphing between different targets
  22487. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22488. */
  22489. export class MorphTargetManager {
  22490. private _targets;
  22491. private _targetInfluenceChangedObservers;
  22492. private _targetDataLayoutChangedObservers;
  22493. private _activeTargets;
  22494. private _scene;
  22495. private _influences;
  22496. private _supportsNormals;
  22497. private _supportsTangents;
  22498. private _supportsUVs;
  22499. private _vertexCount;
  22500. private _uniqueId;
  22501. private _tempInfluences;
  22502. /**
  22503. * Gets or sets a boolean indicating if normals must be morphed
  22504. */
  22505. enableNormalMorphing: boolean;
  22506. /**
  22507. * Gets or sets a boolean indicating if tangents must be morphed
  22508. */
  22509. enableTangentMorphing: boolean;
  22510. /**
  22511. * Gets or sets a boolean indicating if UV must be morphed
  22512. */
  22513. enableUVMorphing: boolean;
  22514. /**
  22515. * Creates a new MorphTargetManager
  22516. * @param scene defines the current scene
  22517. */
  22518. constructor(scene?: Nullable<Scene>);
  22519. /**
  22520. * Gets the unique ID of this manager
  22521. */
  22522. readonly uniqueId: number;
  22523. /**
  22524. * Gets the number of vertices handled by this manager
  22525. */
  22526. readonly vertexCount: number;
  22527. /**
  22528. * Gets a boolean indicating if this manager supports morphing of normals
  22529. */
  22530. readonly supportsNormals: boolean;
  22531. /**
  22532. * Gets a boolean indicating if this manager supports morphing of tangents
  22533. */
  22534. readonly supportsTangents: boolean;
  22535. /**
  22536. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  22537. */
  22538. readonly supportsUVs: boolean;
  22539. /**
  22540. * Gets the number of targets stored in this manager
  22541. */
  22542. readonly numTargets: number;
  22543. /**
  22544. * Gets the number of influencers (ie. the number of targets with influences > 0)
  22545. */
  22546. readonly numInfluencers: number;
  22547. /**
  22548. * Gets the list of influences (one per target)
  22549. */
  22550. readonly influences: Float32Array;
  22551. /**
  22552. * Gets the active target at specified index. An active target is a target with an influence > 0
  22553. * @param index defines the index to check
  22554. * @returns the requested target
  22555. */
  22556. getActiveTarget(index: number): MorphTarget;
  22557. /**
  22558. * Gets the target at specified index
  22559. * @param index defines the index to check
  22560. * @returns the requested target
  22561. */
  22562. getTarget(index: number): MorphTarget;
  22563. /**
  22564. * Add a new target to this manager
  22565. * @param target defines the target to add
  22566. */
  22567. addTarget(target: MorphTarget): void;
  22568. /**
  22569. * Removes a target from the manager
  22570. * @param target defines the target to remove
  22571. */
  22572. removeTarget(target: MorphTarget): void;
  22573. /**
  22574. * Serializes the current manager into a Serialization object
  22575. * @returns the serialized object
  22576. */
  22577. serialize(): any;
  22578. private _syncActiveTargets;
  22579. /**
  22580. * Syncrhonize the targets with all the meshes using this morph target manager
  22581. */
  22582. synchronize(): void;
  22583. /**
  22584. * Creates a new MorphTargetManager from serialized data
  22585. * @param serializationObject defines the serialized data
  22586. * @param scene defines the hosting scene
  22587. * @returns the new MorphTargetManager
  22588. */
  22589. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  22590. }
  22591. }
  22592. declare module "babylonjs/Meshes/meshLODLevel" {
  22593. import { Mesh } from "babylonjs/Meshes/mesh";
  22594. import { Nullable } from "babylonjs/types";
  22595. /**
  22596. * Class used to represent a specific level of detail of a mesh
  22597. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  22598. */
  22599. export class MeshLODLevel {
  22600. /** Defines the distance where this level should star being displayed */
  22601. distance: number;
  22602. /** Defines the mesh to use to render this level */
  22603. mesh: Nullable<Mesh>;
  22604. /**
  22605. * Creates a new LOD level
  22606. * @param distance defines the distance where this level should star being displayed
  22607. * @param mesh defines the mesh to use to render this level
  22608. */
  22609. constructor(
  22610. /** Defines the distance where this level should star being displayed */
  22611. distance: number,
  22612. /** Defines the mesh to use to render this level */
  22613. mesh: Nullable<Mesh>);
  22614. }
  22615. }
  22616. declare module "babylonjs/Meshes/groundMesh" {
  22617. import { Scene } from "babylonjs/scene";
  22618. import { Vector3 } from "babylonjs/Maths/math.vector";
  22619. import { Mesh } from "babylonjs/Meshes/mesh";
  22620. /**
  22621. * Mesh representing the gorund
  22622. */
  22623. export class GroundMesh extends Mesh {
  22624. /** If octree should be generated */
  22625. generateOctree: boolean;
  22626. private _heightQuads;
  22627. /** @hidden */
  22628. _subdivisionsX: number;
  22629. /** @hidden */
  22630. _subdivisionsY: number;
  22631. /** @hidden */
  22632. _width: number;
  22633. /** @hidden */
  22634. _height: number;
  22635. /** @hidden */
  22636. _minX: number;
  22637. /** @hidden */
  22638. _maxX: number;
  22639. /** @hidden */
  22640. _minZ: number;
  22641. /** @hidden */
  22642. _maxZ: number;
  22643. constructor(name: string, scene: Scene);
  22644. /**
  22645. * "GroundMesh"
  22646. * @returns "GroundMesh"
  22647. */
  22648. getClassName(): string;
  22649. /**
  22650. * The minimum of x and y subdivisions
  22651. */
  22652. readonly subdivisions: number;
  22653. /**
  22654. * X subdivisions
  22655. */
  22656. readonly subdivisionsX: number;
  22657. /**
  22658. * Y subdivisions
  22659. */
  22660. readonly subdivisionsY: number;
  22661. /**
  22662. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  22663. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  22664. * @param chunksCount the number of subdivisions for x and y
  22665. * @param octreeBlocksSize (Default: 32)
  22666. */
  22667. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  22668. /**
  22669. * Returns a height (y) value in the Worl system :
  22670. * the ground altitude at the coordinates (x, z) expressed in the World system.
  22671. * @param x x coordinate
  22672. * @param z z coordinate
  22673. * @returns the ground y position if (x, z) are outside the ground surface.
  22674. */
  22675. getHeightAtCoordinates(x: number, z: number): number;
  22676. /**
  22677. * Returns a normalized vector (Vector3) orthogonal to the ground
  22678. * at the ground coordinates (x, z) expressed in the World system.
  22679. * @param x x coordinate
  22680. * @param z z coordinate
  22681. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  22682. */
  22683. getNormalAtCoordinates(x: number, z: number): Vector3;
  22684. /**
  22685. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  22686. * at the ground coordinates (x, z) expressed in the World system.
  22687. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  22688. * @param x x coordinate
  22689. * @param z z coordinate
  22690. * @param ref vector to store the result
  22691. * @returns the GroundMesh.
  22692. */
  22693. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  22694. /**
  22695. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  22696. * if the ground has been updated.
  22697. * This can be used in the render loop.
  22698. * @returns the GroundMesh.
  22699. */
  22700. updateCoordinateHeights(): GroundMesh;
  22701. private _getFacetAt;
  22702. private _initHeightQuads;
  22703. private _computeHeightQuads;
  22704. /**
  22705. * Serializes this ground mesh
  22706. * @param serializationObject object to write serialization to
  22707. */
  22708. serialize(serializationObject: any): void;
  22709. /**
  22710. * Parses a serialized ground mesh
  22711. * @param parsedMesh the serialized mesh
  22712. * @param scene the scene to create the ground mesh in
  22713. * @returns the created ground mesh
  22714. */
  22715. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  22716. }
  22717. }
  22718. declare module "babylonjs/Physics/physicsJoint" {
  22719. import { Vector3 } from "babylonjs/Maths/math.vector";
  22720. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  22721. /**
  22722. * Interface for Physics-Joint data
  22723. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22724. */
  22725. export interface PhysicsJointData {
  22726. /**
  22727. * The main pivot of the joint
  22728. */
  22729. mainPivot?: Vector3;
  22730. /**
  22731. * The connected pivot of the joint
  22732. */
  22733. connectedPivot?: Vector3;
  22734. /**
  22735. * The main axis of the joint
  22736. */
  22737. mainAxis?: Vector3;
  22738. /**
  22739. * The connected axis of the joint
  22740. */
  22741. connectedAxis?: Vector3;
  22742. /**
  22743. * The collision of the joint
  22744. */
  22745. collision?: boolean;
  22746. /**
  22747. * Native Oimo/Cannon/Energy data
  22748. */
  22749. nativeParams?: any;
  22750. }
  22751. /**
  22752. * This is a holder class for the physics joint created by the physics plugin
  22753. * It holds a set of functions to control the underlying joint
  22754. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22755. */
  22756. export class PhysicsJoint {
  22757. /**
  22758. * The type of the physics joint
  22759. */
  22760. type: number;
  22761. /**
  22762. * The data for the physics joint
  22763. */
  22764. jointData: PhysicsJointData;
  22765. private _physicsJoint;
  22766. protected _physicsPlugin: IPhysicsEnginePlugin;
  22767. /**
  22768. * Initializes the physics joint
  22769. * @param type The type of the physics joint
  22770. * @param jointData The data for the physics joint
  22771. */
  22772. constructor(
  22773. /**
  22774. * The type of the physics joint
  22775. */
  22776. type: number,
  22777. /**
  22778. * The data for the physics joint
  22779. */
  22780. jointData: PhysicsJointData);
  22781. /**
  22782. * Gets the physics joint
  22783. */
  22784. /**
  22785. * Sets the physics joint
  22786. */
  22787. physicsJoint: any;
  22788. /**
  22789. * Sets the physics plugin
  22790. */
  22791. physicsPlugin: IPhysicsEnginePlugin;
  22792. /**
  22793. * Execute a function that is physics-plugin specific.
  22794. * @param {Function} func the function that will be executed.
  22795. * It accepts two parameters: the physics world and the physics joint
  22796. */
  22797. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  22798. /**
  22799. * Distance-Joint type
  22800. */
  22801. static DistanceJoint: number;
  22802. /**
  22803. * Hinge-Joint type
  22804. */
  22805. static HingeJoint: number;
  22806. /**
  22807. * Ball-and-Socket joint type
  22808. */
  22809. static BallAndSocketJoint: number;
  22810. /**
  22811. * Wheel-Joint type
  22812. */
  22813. static WheelJoint: number;
  22814. /**
  22815. * Slider-Joint type
  22816. */
  22817. static SliderJoint: number;
  22818. /**
  22819. * Prismatic-Joint type
  22820. */
  22821. static PrismaticJoint: number;
  22822. /**
  22823. * Universal-Joint type
  22824. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  22825. */
  22826. static UniversalJoint: number;
  22827. /**
  22828. * Hinge-Joint 2 type
  22829. */
  22830. static Hinge2Joint: number;
  22831. /**
  22832. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  22833. */
  22834. static PointToPointJoint: number;
  22835. /**
  22836. * Spring-Joint type
  22837. */
  22838. static SpringJoint: number;
  22839. /**
  22840. * Lock-Joint type
  22841. */
  22842. static LockJoint: number;
  22843. }
  22844. /**
  22845. * A class representing a physics distance joint
  22846. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22847. */
  22848. export class DistanceJoint extends PhysicsJoint {
  22849. /**
  22850. *
  22851. * @param jointData The data for the Distance-Joint
  22852. */
  22853. constructor(jointData: DistanceJointData);
  22854. /**
  22855. * Update the predefined distance.
  22856. * @param maxDistance The maximum preferred distance
  22857. * @param minDistance The minimum preferred distance
  22858. */
  22859. updateDistance(maxDistance: number, minDistance?: number): void;
  22860. }
  22861. /**
  22862. * Represents a Motor-Enabled Joint
  22863. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22864. */
  22865. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  22866. /**
  22867. * Initializes the Motor-Enabled Joint
  22868. * @param type The type of the joint
  22869. * @param jointData The physica joint data for the joint
  22870. */
  22871. constructor(type: number, jointData: PhysicsJointData);
  22872. /**
  22873. * Set the motor values.
  22874. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22875. * @param force the force to apply
  22876. * @param maxForce max force for this motor.
  22877. */
  22878. setMotor(force?: number, maxForce?: number): void;
  22879. /**
  22880. * Set the motor's limits.
  22881. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22882. * @param upperLimit The upper limit of the motor
  22883. * @param lowerLimit The lower limit of the motor
  22884. */
  22885. setLimit(upperLimit: number, lowerLimit?: number): void;
  22886. }
  22887. /**
  22888. * This class represents a single physics Hinge-Joint
  22889. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22890. */
  22891. export class HingeJoint extends MotorEnabledJoint {
  22892. /**
  22893. * Initializes the Hinge-Joint
  22894. * @param jointData The joint data for the Hinge-Joint
  22895. */
  22896. constructor(jointData: PhysicsJointData);
  22897. /**
  22898. * Set the motor values.
  22899. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22900. * @param {number} force the force to apply
  22901. * @param {number} maxForce max force for this motor.
  22902. */
  22903. setMotor(force?: number, maxForce?: number): void;
  22904. /**
  22905. * Set the motor's limits.
  22906. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22907. * @param upperLimit The upper limit of the motor
  22908. * @param lowerLimit The lower limit of the motor
  22909. */
  22910. setLimit(upperLimit: number, lowerLimit?: number): void;
  22911. }
  22912. /**
  22913. * This class represents a dual hinge physics joint (same as wheel joint)
  22914. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22915. */
  22916. export class Hinge2Joint extends MotorEnabledJoint {
  22917. /**
  22918. * Initializes the Hinge2-Joint
  22919. * @param jointData The joint data for the Hinge2-Joint
  22920. */
  22921. constructor(jointData: PhysicsJointData);
  22922. /**
  22923. * Set the motor values.
  22924. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22925. * @param {number} targetSpeed the speed the motor is to reach
  22926. * @param {number} maxForce max force for this motor.
  22927. * @param {motorIndex} the motor's index, 0 or 1.
  22928. */
  22929. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  22930. /**
  22931. * Set the motor limits.
  22932. * Attention, this function is plugin specific. Engines won't react 100% the same.
  22933. * @param {number} upperLimit the upper limit
  22934. * @param {number} lowerLimit lower limit
  22935. * @param {motorIndex} the motor's index, 0 or 1.
  22936. */
  22937. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  22938. }
  22939. /**
  22940. * Interface for a motor enabled joint
  22941. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22942. */
  22943. export interface IMotorEnabledJoint {
  22944. /**
  22945. * Physics joint
  22946. */
  22947. physicsJoint: any;
  22948. /**
  22949. * Sets the motor of the motor-enabled joint
  22950. * @param force The force of the motor
  22951. * @param maxForce The maximum force of the motor
  22952. * @param motorIndex The index of the motor
  22953. */
  22954. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  22955. /**
  22956. * Sets the limit of the motor
  22957. * @param upperLimit The upper limit of the motor
  22958. * @param lowerLimit The lower limit of the motor
  22959. * @param motorIndex The index of the motor
  22960. */
  22961. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  22962. }
  22963. /**
  22964. * Joint data for a Distance-Joint
  22965. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22966. */
  22967. export interface DistanceJointData extends PhysicsJointData {
  22968. /**
  22969. * Max distance the 2 joint objects can be apart
  22970. */
  22971. maxDistance: number;
  22972. }
  22973. /**
  22974. * Joint data from a spring joint
  22975. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22976. */
  22977. export interface SpringJointData extends PhysicsJointData {
  22978. /**
  22979. * Length of the spring
  22980. */
  22981. length: number;
  22982. /**
  22983. * Stiffness of the spring
  22984. */
  22985. stiffness: number;
  22986. /**
  22987. * Damping of the spring
  22988. */
  22989. damping: number;
  22990. /** this callback will be called when applying the force to the impostors. */
  22991. forceApplicationCallback: () => void;
  22992. }
  22993. }
  22994. declare module "babylonjs/Physics/physicsRaycastResult" {
  22995. import { Vector3 } from "babylonjs/Maths/math.vector";
  22996. /**
  22997. * Holds the data for the raycast result
  22998. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  22999. */
  23000. export class PhysicsRaycastResult {
  23001. private _hasHit;
  23002. private _hitDistance;
  23003. private _hitNormalWorld;
  23004. private _hitPointWorld;
  23005. private _rayFromWorld;
  23006. private _rayToWorld;
  23007. /**
  23008. * Gets if there was a hit
  23009. */
  23010. readonly hasHit: boolean;
  23011. /**
  23012. * Gets the distance from the hit
  23013. */
  23014. readonly hitDistance: number;
  23015. /**
  23016. * Gets the hit normal/direction in the world
  23017. */
  23018. readonly hitNormalWorld: Vector3;
  23019. /**
  23020. * Gets the hit point in the world
  23021. */
  23022. readonly hitPointWorld: Vector3;
  23023. /**
  23024. * Gets the ray "start point" of the ray in the world
  23025. */
  23026. readonly rayFromWorld: Vector3;
  23027. /**
  23028. * Gets the ray "end point" of the ray in the world
  23029. */
  23030. readonly rayToWorld: Vector3;
  23031. /**
  23032. * Sets the hit data (normal & point in world space)
  23033. * @param hitNormalWorld defines the normal in world space
  23034. * @param hitPointWorld defines the point in world space
  23035. */
  23036. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23037. /**
  23038. * Sets the distance from the start point to the hit point
  23039. * @param distance
  23040. */
  23041. setHitDistance(distance: number): void;
  23042. /**
  23043. * Calculates the distance manually
  23044. */
  23045. calculateHitDistance(): void;
  23046. /**
  23047. * Resets all the values to default
  23048. * @param from The from point on world space
  23049. * @param to The to point on world space
  23050. */
  23051. reset(from?: Vector3, to?: Vector3): void;
  23052. }
  23053. /**
  23054. * Interface for the size containing width and height
  23055. */
  23056. interface IXYZ {
  23057. /**
  23058. * X
  23059. */
  23060. x: number;
  23061. /**
  23062. * Y
  23063. */
  23064. y: number;
  23065. /**
  23066. * Z
  23067. */
  23068. z: number;
  23069. }
  23070. }
  23071. declare module "babylonjs/Physics/IPhysicsEngine" {
  23072. import { Nullable } from "babylonjs/types";
  23073. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23074. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23075. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23076. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23077. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23078. /**
  23079. * Interface used to describe a physics joint
  23080. */
  23081. export interface PhysicsImpostorJoint {
  23082. /** Defines the main impostor to which the joint is linked */
  23083. mainImpostor: PhysicsImpostor;
  23084. /** Defines the impostor that is connected to the main impostor using this joint */
  23085. connectedImpostor: PhysicsImpostor;
  23086. /** Defines the joint itself */
  23087. joint: PhysicsJoint;
  23088. }
  23089. /** @hidden */
  23090. export interface IPhysicsEnginePlugin {
  23091. world: any;
  23092. name: string;
  23093. setGravity(gravity: Vector3): void;
  23094. setTimeStep(timeStep: number): void;
  23095. getTimeStep(): number;
  23096. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23097. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23098. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23099. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23100. removePhysicsBody(impostor: PhysicsImpostor): void;
  23101. generateJoint(joint: PhysicsImpostorJoint): void;
  23102. removeJoint(joint: PhysicsImpostorJoint): void;
  23103. isSupported(): boolean;
  23104. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23105. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23106. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23107. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23108. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23109. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23110. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23111. getBodyMass(impostor: PhysicsImpostor): number;
  23112. getBodyFriction(impostor: PhysicsImpostor): number;
  23113. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23114. getBodyRestitution(impostor: PhysicsImpostor): number;
  23115. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23116. getBodyPressure?(impostor: PhysicsImpostor): number;
  23117. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23118. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23119. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23120. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23121. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23122. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23123. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23124. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23125. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23126. sleepBody(impostor: PhysicsImpostor): void;
  23127. wakeUpBody(impostor: PhysicsImpostor): void;
  23128. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23129. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23130. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23131. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23132. getRadius(impostor: PhysicsImpostor): number;
  23133. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23134. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23135. dispose(): void;
  23136. }
  23137. /**
  23138. * Interface used to define a physics engine
  23139. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23140. */
  23141. export interface IPhysicsEngine {
  23142. /**
  23143. * Gets the gravity vector used by the simulation
  23144. */
  23145. gravity: Vector3;
  23146. /**
  23147. * Sets the gravity vector used by the simulation
  23148. * @param gravity defines the gravity vector to use
  23149. */
  23150. setGravity(gravity: Vector3): void;
  23151. /**
  23152. * Set the time step of the physics engine.
  23153. * Default is 1/60.
  23154. * To slow it down, enter 1/600 for example.
  23155. * To speed it up, 1/30
  23156. * @param newTimeStep the new timestep to apply to this world.
  23157. */
  23158. setTimeStep(newTimeStep: number): void;
  23159. /**
  23160. * Get the time step of the physics engine.
  23161. * @returns the current time step
  23162. */
  23163. getTimeStep(): number;
  23164. /**
  23165. * Release all resources
  23166. */
  23167. dispose(): void;
  23168. /**
  23169. * Gets the name of the current physics plugin
  23170. * @returns the name of the plugin
  23171. */
  23172. getPhysicsPluginName(): string;
  23173. /**
  23174. * Adding a new impostor for the impostor tracking.
  23175. * This will be done by the impostor itself.
  23176. * @param impostor the impostor to add
  23177. */
  23178. addImpostor(impostor: PhysicsImpostor): void;
  23179. /**
  23180. * Remove an impostor from the engine.
  23181. * This impostor and its mesh will not longer be updated by the physics engine.
  23182. * @param impostor the impostor to remove
  23183. */
  23184. removeImpostor(impostor: PhysicsImpostor): void;
  23185. /**
  23186. * Add a joint to the physics engine
  23187. * @param mainImpostor defines the main impostor to which the joint is added.
  23188. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23189. * @param joint defines the joint that will connect both impostors.
  23190. */
  23191. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23192. /**
  23193. * Removes a joint from the simulation
  23194. * @param mainImpostor defines the impostor used with the joint
  23195. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23196. * @param joint defines the joint to remove
  23197. */
  23198. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23199. /**
  23200. * Gets the current plugin used to run the simulation
  23201. * @returns current plugin
  23202. */
  23203. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23204. /**
  23205. * Gets the list of physic impostors
  23206. * @returns an array of PhysicsImpostor
  23207. */
  23208. getImpostors(): Array<PhysicsImpostor>;
  23209. /**
  23210. * Gets the impostor for a physics enabled object
  23211. * @param object defines the object impersonated by the impostor
  23212. * @returns the PhysicsImpostor or null if not found
  23213. */
  23214. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23215. /**
  23216. * Gets the impostor for a physics body object
  23217. * @param body defines physics body used by the impostor
  23218. * @returns the PhysicsImpostor or null if not found
  23219. */
  23220. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23221. /**
  23222. * Does a raycast in the physics world
  23223. * @param from when should the ray start?
  23224. * @param to when should the ray end?
  23225. * @returns PhysicsRaycastResult
  23226. */
  23227. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23228. /**
  23229. * Called by the scene. No need to call it.
  23230. * @param delta defines the timespam between frames
  23231. */
  23232. _step(delta: number): void;
  23233. }
  23234. }
  23235. declare module "babylonjs/Physics/physicsImpostor" {
  23236. import { Nullable, IndicesArray } from "babylonjs/types";
  23237. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23238. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23239. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23240. import { Scene } from "babylonjs/scene";
  23241. import { Bone } from "babylonjs/Bones/bone";
  23242. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23243. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23244. import { Space } from "babylonjs/Maths/math.axis";
  23245. /**
  23246. * The interface for the physics imposter parameters
  23247. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23248. */
  23249. export interface PhysicsImpostorParameters {
  23250. /**
  23251. * The mass of the physics imposter
  23252. */
  23253. mass: number;
  23254. /**
  23255. * The friction of the physics imposter
  23256. */
  23257. friction?: number;
  23258. /**
  23259. * The coefficient of restitution of the physics imposter
  23260. */
  23261. restitution?: number;
  23262. /**
  23263. * The native options of the physics imposter
  23264. */
  23265. nativeOptions?: any;
  23266. /**
  23267. * Specifies if the parent should be ignored
  23268. */
  23269. ignoreParent?: boolean;
  23270. /**
  23271. * Specifies if bi-directional transformations should be disabled
  23272. */
  23273. disableBidirectionalTransformation?: boolean;
  23274. /**
  23275. * The pressure inside the physics imposter, soft object only
  23276. */
  23277. pressure?: number;
  23278. /**
  23279. * The stiffness the physics imposter, soft object only
  23280. */
  23281. stiffness?: number;
  23282. /**
  23283. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23284. */
  23285. velocityIterations?: number;
  23286. /**
  23287. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23288. */
  23289. positionIterations?: number;
  23290. /**
  23291. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23292. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23293. * Add to fix multiple points
  23294. */
  23295. fixedPoints?: number;
  23296. /**
  23297. * The collision margin around a soft object
  23298. */
  23299. margin?: number;
  23300. /**
  23301. * The collision margin around a soft object
  23302. */
  23303. damping?: number;
  23304. /**
  23305. * The path for a rope based on an extrusion
  23306. */
  23307. path?: any;
  23308. /**
  23309. * The shape of an extrusion used for a rope based on an extrusion
  23310. */
  23311. shape?: any;
  23312. }
  23313. /**
  23314. * Interface for a physics-enabled object
  23315. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23316. */
  23317. export interface IPhysicsEnabledObject {
  23318. /**
  23319. * The position of the physics-enabled object
  23320. */
  23321. position: Vector3;
  23322. /**
  23323. * The rotation of the physics-enabled object
  23324. */
  23325. rotationQuaternion: Nullable<Quaternion>;
  23326. /**
  23327. * The scale of the physics-enabled object
  23328. */
  23329. scaling: Vector3;
  23330. /**
  23331. * The rotation of the physics-enabled object
  23332. */
  23333. rotation?: Vector3;
  23334. /**
  23335. * The parent of the physics-enabled object
  23336. */
  23337. parent?: any;
  23338. /**
  23339. * The bounding info of the physics-enabled object
  23340. * @returns The bounding info of the physics-enabled object
  23341. */
  23342. getBoundingInfo(): BoundingInfo;
  23343. /**
  23344. * Computes the world matrix
  23345. * @param force Specifies if the world matrix should be computed by force
  23346. * @returns A world matrix
  23347. */
  23348. computeWorldMatrix(force: boolean): Matrix;
  23349. /**
  23350. * Gets the world matrix
  23351. * @returns A world matrix
  23352. */
  23353. getWorldMatrix?(): Matrix;
  23354. /**
  23355. * Gets the child meshes
  23356. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23357. * @returns An array of abstract meshes
  23358. */
  23359. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23360. /**
  23361. * Gets the vertex data
  23362. * @param kind The type of vertex data
  23363. * @returns A nullable array of numbers, or a float32 array
  23364. */
  23365. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23366. /**
  23367. * Gets the indices from the mesh
  23368. * @returns A nullable array of index arrays
  23369. */
  23370. getIndices?(): Nullable<IndicesArray>;
  23371. /**
  23372. * Gets the scene from the mesh
  23373. * @returns the indices array or null
  23374. */
  23375. getScene?(): Scene;
  23376. /**
  23377. * Gets the absolute position from the mesh
  23378. * @returns the absolute position
  23379. */
  23380. getAbsolutePosition(): Vector3;
  23381. /**
  23382. * Gets the absolute pivot point from the mesh
  23383. * @returns the absolute pivot point
  23384. */
  23385. getAbsolutePivotPoint(): Vector3;
  23386. /**
  23387. * Rotates the mesh
  23388. * @param axis The axis of rotation
  23389. * @param amount The amount of rotation
  23390. * @param space The space of the rotation
  23391. * @returns The rotation transform node
  23392. */
  23393. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23394. /**
  23395. * Translates the mesh
  23396. * @param axis The axis of translation
  23397. * @param distance The distance of translation
  23398. * @param space The space of the translation
  23399. * @returns The transform node
  23400. */
  23401. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23402. /**
  23403. * Sets the absolute position of the mesh
  23404. * @param absolutePosition The absolute position of the mesh
  23405. * @returns The transform node
  23406. */
  23407. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23408. /**
  23409. * Gets the class name of the mesh
  23410. * @returns The class name
  23411. */
  23412. getClassName(): string;
  23413. }
  23414. /**
  23415. * Represents a physics imposter
  23416. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23417. */
  23418. export class PhysicsImpostor {
  23419. /**
  23420. * The physics-enabled object used as the physics imposter
  23421. */
  23422. object: IPhysicsEnabledObject;
  23423. /**
  23424. * The type of the physics imposter
  23425. */
  23426. type: number;
  23427. private _options;
  23428. private _scene?;
  23429. /**
  23430. * The default object size of the imposter
  23431. */
  23432. static DEFAULT_OBJECT_SIZE: Vector3;
  23433. /**
  23434. * The identity quaternion of the imposter
  23435. */
  23436. static IDENTITY_QUATERNION: Quaternion;
  23437. /** @hidden */
  23438. _pluginData: any;
  23439. private _physicsEngine;
  23440. private _physicsBody;
  23441. private _bodyUpdateRequired;
  23442. private _onBeforePhysicsStepCallbacks;
  23443. private _onAfterPhysicsStepCallbacks;
  23444. /** @hidden */
  23445. _onPhysicsCollideCallbacks: Array<{
  23446. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  23447. otherImpostors: Array<PhysicsImpostor>;
  23448. }>;
  23449. private _deltaPosition;
  23450. private _deltaRotation;
  23451. private _deltaRotationConjugated;
  23452. /** @hidden */
  23453. _isFromLine: boolean;
  23454. private _parent;
  23455. private _isDisposed;
  23456. private static _tmpVecs;
  23457. private static _tmpQuat;
  23458. /**
  23459. * Specifies if the physics imposter is disposed
  23460. */
  23461. readonly isDisposed: boolean;
  23462. /**
  23463. * Gets the mass of the physics imposter
  23464. */
  23465. mass: number;
  23466. /**
  23467. * Gets the coefficient of friction
  23468. */
  23469. /**
  23470. * Sets the coefficient of friction
  23471. */
  23472. friction: number;
  23473. /**
  23474. * Gets the coefficient of restitution
  23475. */
  23476. /**
  23477. * Sets the coefficient of restitution
  23478. */
  23479. restitution: number;
  23480. /**
  23481. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  23482. */
  23483. /**
  23484. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  23485. */
  23486. pressure: number;
  23487. /**
  23488. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23489. */
  23490. /**
  23491. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23492. */
  23493. stiffness: number;
  23494. /**
  23495. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23496. */
  23497. /**
  23498. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23499. */
  23500. velocityIterations: number;
  23501. /**
  23502. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23503. */
  23504. /**
  23505. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23506. */
  23507. positionIterations: number;
  23508. /**
  23509. * The unique id of the physics imposter
  23510. * set by the physics engine when adding this impostor to the array
  23511. */
  23512. uniqueId: number;
  23513. /**
  23514. * @hidden
  23515. */
  23516. soft: boolean;
  23517. /**
  23518. * @hidden
  23519. */
  23520. segments: number;
  23521. private _joints;
  23522. /**
  23523. * Initializes the physics imposter
  23524. * @param object The physics-enabled object used as the physics imposter
  23525. * @param type The type of the physics imposter
  23526. * @param _options The options for the physics imposter
  23527. * @param _scene The Babylon scene
  23528. */
  23529. constructor(
  23530. /**
  23531. * The physics-enabled object used as the physics imposter
  23532. */
  23533. object: IPhysicsEnabledObject,
  23534. /**
  23535. * The type of the physics imposter
  23536. */
  23537. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  23538. /**
  23539. * This function will completly initialize this impostor.
  23540. * It will create a new body - but only if this mesh has no parent.
  23541. * If it has, this impostor will not be used other than to define the impostor
  23542. * of the child mesh.
  23543. * @hidden
  23544. */
  23545. _init(): void;
  23546. private _getPhysicsParent;
  23547. /**
  23548. * Should a new body be generated.
  23549. * @returns boolean specifying if body initialization is required
  23550. */
  23551. isBodyInitRequired(): boolean;
  23552. /**
  23553. * Sets the updated scaling
  23554. * @param updated Specifies if the scaling is updated
  23555. */
  23556. setScalingUpdated(): void;
  23557. /**
  23558. * Force a regeneration of this or the parent's impostor's body.
  23559. * Use under cautious - This will remove all joints already implemented.
  23560. */
  23561. forceUpdate(): void;
  23562. /**
  23563. * Gets the body that holds this impostor. Either its own, or its parent.
  23564. */
  23565. /**
  23566. * Set the physics body. Used mainly by the physics engine/plugin
  23567. */
  23568. physicsBody: any;
  23569. /**
  23570. * Get the parent of the physics imposter
  23571. * @returns Physics imposter or null
  23572. */
  23573. /**
  23574. * Sets the parent of the physics imposter
  23575. */
  23576. parent: Nullable<PhysicsImpostor>;
  23577. /**
  23578. * Resets the update flags
  23579. */
  23580. resetUpdateFlags(): void;
  23581. /**
  23582. * Gets the object extend size
  23583. * @returns the object extend size
  23584. */
  23585. getObjectExtendSize(): Vector3;
  23586. /**
  23587. * Gets the object center
  23588. * @returns The object center
  23589. */
  23590. getObjectCenter(): Vector3;
  23591. /**
  23592. * Get a specific parametes from the options parameter
  23593. * @param paramName The object parameter name
  23594. * @returns The object parameter
  23595. */
  23596. getParam(paramName: string): any;
  23597. /**
  23598. * Sets a specific parameter in the options given to the physics plugin
  23599. * @param paramName The parameter name
  23600. * @param value The value of the parameter
  23601. */
  23602. setParam(paramName: string, value: number): void;
  23603. /**
  23604. * Specifically change the body's mass option. Won't recreate the physics body object
  23605. * @param mass The mass of the physics imposter
  23606. */
  23607. setMass(mass: number): void;
  23608. /**
  23609. * Gets the linear velocity
  23610. * @returns linear velocity or null
  23611. */
  23612. getLinearVelocity(): Nullable<Vector3>;
  23613. /**
  23614. * Sets the linear velocity
  23615. * @param velocity linear velocity or null
  23616. */
  23617. setLinearVelocity(velocity: Nullable<Vector3>): void;
  23618. /**
  23619. * Gets the angular velocity
  23620. * @returns angular velocity or null
  23621. */
  23622. getAngularVelocity(): Nullable<Vector3>;
  23623. /**
  23624. * Sets the angular velocity
  23625. * @param velocity The velocity or null
  23626. */
  23627. setAngularVelocity(velocity: Nullable<Vector3>): void;
  23628. /**
  23629. * Execute a function with the physics plugin native code
  23630. * Provide a function the will have two variables - the world object and the physics body object
  23631. * @param func The function to execute with the physics plugin native code
  23632. */
  23633. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  23634. /**
  23635. * Register a function that will be executed before the physics world is stepping forward
  23636. * @param func The function to execute before the physics world is stepped forward
  23637. */
  23638. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23639. /**
  23640. * Unregister a function that will be executed before the physics world is stepping forward
  23641. * @param func The function to execute before the physics world is stepped forward
  23642. */
  23643. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23644. /**
  23645. * Register a function that will be executed after the physics step
  23646. * @param func The function to execute after physics step
  23647. */
  23648. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23649. /**
  23650. * Unregisters a function that will be executed after the physics step
  23651. * @param func The function to execute after physics step
  23652. */
  23653. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  23654. /**
  23655. * register a function that will be executed when this impostor collides against a different body
  23656. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  23657. * @param func Callback that is executed on collision
  23658. */
  23659. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  23660. /**
  23661. * Unregisters the physics imposter on contact
  23662. * @param collideAgainst The physics object to collide against
  23663. * @param func Callback to execute on collision
  23664. */
  23665. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  23666. private _tmpQuat;
  23667. private _tmpQuat2;
  23668. /**
  23669. * Get the parent rotation
  23670. * @returns The parent rotation
  23671. */
  23672. getParentsRotation(): Quaternion;
  23673. /**
  23674. * this function is executed by the physics engine.
  23675. */
  23676. beforeStep: () => void;
  23677. /**
  23678. * this function is executed by the physics engine
  23679. */
  23680. afterStep: () => void;
  23681. /**
  23682. * Legacy collision detection event support
  23683. */
  23684. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  23685. /**
  23686. * event and body object due to cannon's event-based architecture.
  23687. */
  23688. onCollide: (e: {
  23689. body: any;
  23690. }) => void;
  23691. /**
  23692. * Apply a force
  23693. * @param force The force to apply
  23694. * @param contactPoint The contact point for the force
  23695. * @returns The physics imposter
  23696. */
  23697. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  23698. /**
  23699. * Apply an impulse
  23700. * @param force The impulse force
  23701. * @param contactPoint The contact point for the impulse force
  23702. * @returns The physics imposter
  23703. */
  23704. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  23705. /**
  23706. * A help function to create a joint
  23707. * @param otherImpostor A physics imposter used to create a joint
  23708. * @param jointType The type of joint
  23709. * @param jointData The data for the joint
  23710. * @returns The physics imposter
  23711. */
  23712. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  23713. /**
  23714. * Add a joint to this impostor with a different impostor
  23715. * @param otherImpostor A physics imposter used to add a joint
  23716. * @param joint The joint to add
  23717. * @returns The physics imposter
  23718. */
  23719. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  23720. /**
  23721. * Add an anchor to a cloth impostor
  23722. * @param otherImpostor rigid impostor to anchor to
  23723. * @param width ratio across width from 0 to 1
  23724. * @param height ratio up height from 0 to 1
  23725. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  23726. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  23727. * @returns impostor the soft imposter
  23728. */
  23729. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  23730. /**
  23731. * Add a hook to a rope impostor
  23732. * @param otherImpostor rigid impostor to anchor to
  23733. * @param length ratio across rope from 0 to 1
  23734. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  23735. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  23736. * @returns impostor the rope imposter
  23737. */
  23738. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  23739. /**
  23740. * Will keep this body still, in a sleep mode.
  23741. * @returns the physics imposter
  23742. */
  23743. sleep(): PhysicsImpostor;
  23744. /**
  23745. * Wake the body up.
  23746. * @returns The physics imposter
  23747. */
  23748. wakeUp(): PhysicsImpostor;
  23749. /**
  23750. * Clones the physics imposter
  23751. * @param newObject The physics imposter clones to this physics-enabled object
  23752. * @returns A nullable physics imposter
  23753. */
  23754. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23755. /**
  23756. * Disposes the physics imposter
  23757. */
  23758. dispose(): void;
  23759. /**
  23760. * Sets the delta position
  23761. * @param position The delta position amount
  23762. */
  23763. setDeltaPosition(position: Vector3): void;
  23764. /**
  23765. * Sets the delta rotation
  23766. * @param rotation The delta rotation amount
  23767. */
  23768. setDeltaRotation(rotation: Quaternion): void;
  23769. /**
  23770. * Gets the box size of the physics imposter and stores the result in the input parameter
  23771. * @param result Stores the box size
  23772. * @returns The physics imposter
  23773. */
  23774. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  23775. /**
  23776. * Gets the radius of the physics imposter
  23777. * @returns Radius of the physics imposter
  23778. */
  23779. getRadius(): number;
  23780. /**
  23781. * Sync a bone with this impostor
  23782. * @param bone The bone to sync to the impostor.
  23783. * @param boneMesh The mesh that the bone is influencing.
  23784. * @param jointPivot The pivot of the joint / bone in local space.
  23785. * @param distToJoint Optional distance from the impostor to the joint.
  23786. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  23787. */
  23788. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  23789. /**
  23790. * Sync impostor to a bone
  23791. * @param bone The bone that the impostor will be synced to.
  23792. * @param boneMesh The mesh that the bone is influencing.
  23793. * @param jointPivot The pivot of the joint / bone in local space.
  23794. * @param distToJoint Optional distance from the impostor to the joint.
  23795. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  23796. * @param boneAxis Optional vector3 axis the bone is aligned with
  23797. */
  23798. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  23799. /**
  23800. * No-Imposter type
  23801. */
  23802. static NoImpostor: number;
  23803. /**
  23804. * Sphere-Imposter type
  23805. */
  23806. static SphereImpostor: number;
  23807. /**
  23808. * Box-Imposter type
  23809. */
  23810. static BoxImpostor: number;
  23811. /**
  23812. * Plane-Imposter type
  23813. */
  23814. static PlaneImpostor: number;
  23815. /**
  23816. * Mesh-imposter type
  23817. */
  23818. static MeshImpostor: number;
  23819. /**
  23820. * Capsule-Impostor type (Ammo.js plugin only)
  23821. */
  23822. static CapsuleImpostor: number;
  23823. /**
  23824. * Cylinder-Imposter type
  23825. */
  23826. static CylinderImpostor: number;
  23827. /**
  23828. * Particle-Imposter type
  23829. */
  23830. static ParticleImpostor: number;
  23831. /**
  23832. * Heightmap-Imposter type
  23833. */
  23834. static HeightmapImpostor: number;
  23835. /**
  23836. * ConvexHull-Impostor type (Ammo.js plugin only)
  23837. */
  23838. static ConvexHullImpostor: number;
  23839. /**
  23840. * Rope-Imposter type
  23841. */
  23842. static RopeImpostor: number;
  23843. /**
  23844. * Cloth-Imposter type
  23845. */
  23846. static ClothImpostor: number;
  23847. /**
  23848. * Softbody-Imposter type
  23849. */
  23850. static SoftbodyImpostor: number;
  23851. }
  23852. }
  23853. declare module "babylonjs/Meshes/mesh" {
  23854. import { Observable } from "babylonjs/Misc/observable";
  23855. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  23856. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  23857. import { Camera } from "babylonjs/Cameras/camera";
  23858. import { Scene } from "babylonjs/scene";
  23859. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  23860. import { Color4 } from "babylonjs/Maths/math.color";
  23861. import { Engine } from "babylonjs/Engines/engine";
  23862. import { Node } from "babylonjs/node";
  23863. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  23864. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  23865. import { Buffer } from "babylonjs/Meshes/buffer";
  23866. import { Geometry } from "babylonjs/Meshes/geometry";
  23867. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23868. import { SubMesh } from "babylonjs/Meshes/subMesh";
  23869. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  23870. import { Effect } from "babylonjs/Materials/effect";
  23871. import { Material } from "babylonjs/Materials/material";
  23872. import { Skeleton } from "babylonjs/Bones/skeleton";
  23873. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  23874. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  23875. import { Path3D } from "babylonjs/Maths/math.path";
  23876. import { Plane } from "babylonjs/Maths/math.plane";
  23877. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  23878. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  23879. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  23880. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23881. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  23882. /**
  23883. * @hidden
  23884. **/
  23885. export class _CreationDataStorage {
  23886. closePath?: boolean;
  23887. closeArray?: boolean;
  23888. idx: number[];
  23889. dashSize: number;
  23890. gapSize: number;
  23891. path3D: Path3D;
  23892. pathArray: Vector3[][];
  23893. arc: number;
  23894. radius: number;
  23895. cap: number;
  23896. tessellation: number;
  23897. }
  23898. /**
  23899. * @hidden
  23900. **/
  23901. class _InstanceDataStorage {
  23902. visibleInstances: any;
  23903. batchCache: _InstancesBatch;
  23904. instancesBufferSize: number;
  23905. instancesBuffer: Nullable<Buffer>;
  23906. instancesData: Float32Array;
  23907. overridenInstanceCount: number;
  23908. isFrozen: boolean;
  23909. previousBatch: Nullable<_InstancesBatch>;
  23910. hardwareInstancedRendering: boolean;
  23911. sideOrientation: number;
  23912. }
  23913. /**
  23914. * @hidden
  23915. **/
  23916. export class _InstancesBatch {
  23917. mustReturn: boolean;
  23918. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  23919. renderSelf: boolean[];
  23920. hardwareInstancedRendering: boolean[];
  23921. }
  23922. /**
  23923. * Class used to represent renderable models
  23924. */
  23925. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  23926. /**
  23927. * Mesh side orientation : usually the external or front surface
  23928. */
  23929. static readonly FRONTSIDE: number;
  23930. /**
  23931. * Mesh side orientation : usually the internal or back surface
  23932. */
  23933. static readonly BACKSIDE: number;
  23934. /**
  23935. * Mesh side orientation : both internal and external or front and back surfaces
  23936. */
  23937. static readonly DOUBLESIDE: number;
  23938. /**
  23939. * Mesh side orientation : by default, `FRONTSIDE`
  23940. */
  23941. static readonly DEFAULTSIDE: number;
  23942. /**
  23943. * Mesh cap setting : no cap
  23944. */
  23945. static readonly NO_CAP: number;
  23946. /**
  23947. * Mesh cap setting : one cap at the beginning of the mesh
  23948. */
  23949. static readonly CAP_START: number;
  23950. /**
  23951. * Mesh cap setting : one cap at the end of the mesh
  23952. */
  23953. static readonly CAP_END: number;
  23954. /**
  23955. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  23956. */
  23957. static readonly CAP_ALL: number;
  23958. /**
  23959. * Mesh pattern setting : no flip or rotate
  23960. */
  23961. static readonly NO_FLIP: number;
  23962. /**
  23963. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  23964. */
  23965. static readonly FLIP_TILE: number;
  23966. /**
  23967. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  23968. */
  23969. static readonly ROTATE_TILE: number;
  23970. /**
  23971. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  23972. */
  23973. static readonly FLIP_ROW: number;
  23974. /**
  23975. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  23976. */
  23977. static readonly ROTATE_ROW: number;
  23978. /**
  23979. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  23980. */
  23981. static readonly FLIP_N_ROTATE_TILE: number;
  23982. /**
  23983. * Mesh pattern setting : rotate pattern and rotate
  23984. */
  23985. static readonly FLIP_N_ROTATE_ROW: number;
  23986. /**
  23987. * Mesh tile positioning : part tiles same on left/right or top/bottom
  23988. */
  23989. static readonly CENTER: number;
  23990. /**
  23991. * Mesh tile positioning : part tiles on left
  23992. */
  23993. static readonly LEFT: number;
  23994. /**
  23995. * Mesh tile positioning : part tiles on right
  23996. */
  23997. static readonly RIGHT: number;
  23998. /**
  23999. * Mesh tile positioning : part tiles on top
  24000. */
  24001. static readonly TOP: number;
  24002. /**
  24003. * Mesh tile positioning : part tiles on bottom
  24004. */
  24005. static readonly BOTTOM: number;
  24006. /**
  24007. * Gets the default side orientation.
  24008. * @param orientation the orientation to value to attempt to get
  24009. * @returns the default orientation
  24010. * @hidden
  24011. */
  24012. static _GetDefaultSideOrientation(orientation?: number): number;
  24013. private _internalMeshDataInfo;
  24014. /**
  24015. * An event triggered before rendering the mesh
  24016. */
  24017. readonly onBeforeRenderObservable: Observable<Mesh>;
  24018. /**
  24019. * An event triggered before binding the mesh
  24020. */
  24021. readonly onBeforeBindObservable: Observable<Mesh>;
  24022. /**
  24023. * An event triggered after rendering the mesh
  24024. */
  24025. readonly onAfterRenderObservable: Observable<Mesh>;
  24026. /**
  24027. * An event triggered before drawing the mesh
  24028. */
  24029. readonly onBeforeDrawObservable: Observable<Mesh>;
  24030. private _onBeforeDrawObserver;
  24031. /**
  24032. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24033. */
  24034. onBeforeDraw: () => void;
  24035. /**
  24036. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24037. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24038. */
  24039. delayLoadState: number;
  24040. /**
  24041. * Gets the list of instances created from this mesh
  24042. * it is not supposed to be modified manually.
  24043. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24044. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24045. */
  24046. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24047. /**
  24048. * Gets the file containing delay loading data for this mesh
  24049. */
  24050. delayLoadingFile: string;
  24051. /** @hidden */
  24052. _binaryInfo: any;
  24053. /**
  24054. * User defined function used to change how LOD level selection is done
  24055. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24056. */
  24057. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24058. /**
  24059. * Gets or sets the morph target manager
  24060. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24061. */
  24062. morphTargetManager: Nullable<MorphTargetManager>;
  24063. /** @hidden */
  24064. _creationDataStorage: Nullable<_CreationDataStorage>;
  24065. /** @hidden */
  24066. _geometry: Nullable<Geometry>;
  24067. /** @hidden */
  24068. _delayInfo: Array<string>;
  24069. /** @hidden */
  24070. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24071. /** @hidden */
  24072. _instanceDataStorage: _InstanceDataStorage;
  24073. private _effectiveMaterial;
  24074. /** @hidden */
  24075. _shouldGenerateFlatShading: boolean;
  24076. /** @hidden */
  24077. _originalBuilderSideOrientation: number;
  24078. /**
  24079. * Use this property to change the original side orientation defined at construction time
  24080. */
  24081. overrideMaterialSideOrientation: Nullable<number>;
  24082. /**
  24083. * Gets the source mesh (the one used to clone this one from)
  24084. */
  24085. readonly source: Nullable<Mesh>;
  24086. /**
  24087. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24088. */
  24089. isUnIndexed: boolean;
  24090. /**
  24091. * @constructor
  24092. * @param name The value used by scene.getMeshByName() to do a lookup.
  24093. * @param scene The scene to add this mesh to.
  24094. * @param parent The parent of this mesh, if it has one
  24095. * @param source An optional Mesh from which geometry is shared, cloned.
  24096. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24097. * When false, achieved by calling a clone(), also passing False.
  24098. * This will make creation of children, recursive.
  24099. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24100. */
  24101. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24102. /**
  24103. * Gets the class name
  24104. * @returns the string "Mesh".
  24105. */
  24106. getClassName(): string;
  24107. /** @hidden */
  24108. readonly _isMesh: boolean;
  24109. /**
  24110. * Returns a description of this mesh
  24111. * @param fullDetails define if full details about this mesh must be used
  24112. * @returns a descriptive string representing this mesh
  24113. */
  24114. toString(fullDetails?: boolean): string;
  24115. /** @hidden */
  24116. _unBindEffect(): void;
  24117. /**
  24118. * Gets a boolean indicating if this mesh has LOD
  24119. */
  24120. readonly hasLODLevels: boolean;
  24121. /**
  24122. * Gets the list of MeshLODLevel associated with the current mesh
  24123. * @returns an array of MeshLODLevel
  24124. */
  24125. getLODLevels(): MeshLODLevel[];
  24126. private _sortLODLevels;
  24127. /**
  24128. * Add a mesh as LOD level triggered at the given distance.
  24129. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24130. * @param distance The distance from the center of the object to show this level
  24131. * @param mesh The mesh to be added as LOD level (can be null)
  24132. * @return This mesh (for chaining)
  24133. */
  24134. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24135. /**
  24136. * Returns the LOD level mesh at the passed distance or null if not found.
  24137. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24138. * @param distance The distance from the center of the object to show this level
  24139. * @returns a Mesh or `null`
  24140. */
  24141. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24142. /**
  24143. * Remove a mesh from the LOD array
  24144. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24145. * @param mesh defines the mesh to be removed
  24146. * @return This mesh (for chaining)
  24147. */
  24148. removeLODLevel(mesh: Mesh): Mesh;
  24149. /**
  24150. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24151. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24152. * @param camera defines the camera to use to compute distance
  24153. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24154. * @return This mesh (for chaining)
  24155. */
  24156. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24157. /**
  24158. * Gets the mesh internal Geometry object
  24159. */
  24160. readonly geometry: Nullable<Geometry>;
  24161. /**
  24162. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24163. * @returns the total number of vertices
  24164. */
  24165. getTotalVertices(): number;
  24166. /**
  24167. * Returns the content of an associated vertex buffer
  24168. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24169. * - VertexBuffer.PositionKind
  24170. * - VertexBuffer.UVKind
  24171. * - VertexBuffer.UV2Kind
  24172. * - VertexBuffer.UV3Kind
  24173. * - VertexBuffer.UV4Kind
  24174. * - VertexBuffer.UV5Kind
  24175. * - VertexBuffer.UV6Kind
  24176. * - VertexBuffer.ColorKind
  24177. * - VertexBuffer.MatricesIndicesKind
  24178. * - VertexBuffer.MatricesIndicesExtraKind
  24179. * - VertexBuffer.MatricesWeightsKind
  24180. * - VertexBuffer.MatricesWeightsExtraKind
  24181. * @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
  24182. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24183. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24184. */
  24185. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24186. /**
  24187. * Returns the mesh VertexBuffer object from the requested `kind`
  24188. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24189. * - VertexBuffer.PositionKind
  24190. * - VertexBuffer.NormalKind
  24191. * - VertexBuffer.UVKind
  24192. * - VertexBuffer.UV2Kind
  24193. * - VertexBuffer.UV3Kind
  24194. * - VertexBuffer.UV4Kind
  24195. * - VertexBuffer.UV5Kind
  24196. * - VertexBuffer.UV6Kind
  24197. * - VertexBuffer.ColorKind
  24198. * - VertexBuffer.MatricesIndicesKind
  24199. * - VertexBuffer.MatricesIndicesExtraKind
  24200. * - VertexBuffer.MatricesWeightsKind
  24201. * - VertexBuffer.MatricesWeightsExtraKind
  24202. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24203. */
  24204. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24205. /**
  24206. * Tests if a specific vertex buffer is associated with this mesh
  24207. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24208. * - VertexBuffer.PositionKind
  24209. * - VertexBuffer.NormalKind
  24210. * - VertexBuffer.UVKind
  24211. * - VertexBuffer.UV2Kind
  24212. * - VertexBuffer.UV3Kind
  24213. * - VertexBuffer.UV4Kind
  24214. * - VertexBuffer.UV5Kind
  24215. * - VertexBuffer.UV6Kind
  24216. * - VertexBuffer.ColorKind
  24217. * - VertexBuffer.MatricesIndicesKind
  24218. * - VertexBuffer.MatricesIndicesExtraKind
  24219. * - VertexBuffer.MatricesWeightsKind
  24220. * - VertexBuffer.MatricesWeightsExtraKind
  24221. * @returns a boolean
  24222. */
  24223. isVerticesDataPresent(kind: string): boolean;
  24224. /**
  24225. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24226. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24227. * - VertexBuffer.PositionKind
  24228. * - VertexBuffer.UVKind
  24229. * - VertexBuffer.UV2Kind
  24230. * - VertexBuffer.UV3Kind
  24231. * - VertexBuffer.UV4Kind
  24232. * - VertexBuffer.UV5Kind
  24233. * - VertexBuffer.UV6Kind
  24234. * - VertexBuffer.ColorKind
  24235. * - VertexBuffer.MatricesIndicesKind
  24236. * - VertexBuffer.MatricesIndicesExtraKind
  24237. * - VertexBuffer.MatricesWeightsKind
  24238. * - VertexBuffer.MatricesWeightsExtraKind
  24239. * @returns a boolean
  24240. */
  24241. isVertexBufferUpdatable(kind: string): boolean;
  24242. /**
  24243. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24244. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24245. * - VertexBuffer.PositionKind
  24246. * - VertexBuffer.NormalKind
  24247. * - VertexBuffer.UVKind
  24248. * - VertexBuffer.UV2Kind
  24249. * - VertexBuffer.UV3Kind
  24250. * - VertexBuffer.UV4Kind
  24251. * - VertexBuffer.UV5Kind
  24252. * - VertexBuffer.UV6Kind
  24253. * - VertexBuffer.ColorKind
  24254. * - VertexBuffer.MatricesIndicesKind
  24255. * - VertexBuffer.MatricesIndicesExtraKind
  24256. * - VertexBuffer.MatricesWeightsKind
  24257. * - VertexBuffer.MatricesWeightsExtraKind
  24258. * @returns an array of strings
  24259. */
  24260. getVerticesDataKinds(): string[];
  24261. /**
  24262. * Returns a positive integer : the total number of indices in this mesh geometry.
  24263. * @returns the numner of indices or zero if the mesh has no geometry.
  24264. */
  24265. getTotalIndices(): number;
  24266. /**
  24267. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24268. * @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.
  24269. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24270. * @returns the indices array or an empty array if the mesh has no geometry
  24271. */
  24272. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24273. readonly isBlocked: boolean;
  24274. /**
  24275. * Determine if the current mesh is ready to be rendered
  24276. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24277. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24278. * @returns true if all associated assets are ready (material, textures, shaders)
  24279. */
  24280. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24281. /**
  24282. * 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.
  24283. */
  24284. readonly areNormalsFrozen: boolean;
  24285. /**
  24286. * 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.
  24287. * @returns the current mesh
  24288. */
  24289. freezeNormals(): Mesh;
  24290. /**
  24291. * 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
  24292. * @returns the current mesh
  24293. */
  24294. unfreezeNormals(): Mesh;
  24295. /**
  24296. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24297. */
  24298. overridenInstanceCount: number;
  24299. /** @hidden */
  24300. _preActivate(): Mesh;
  24301. /** @hidden */
  24302. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24303. /** @hidden */
  24304. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24305. /**
  24306. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24307. * This means the mesh underlying bounding box and sphere are recomputed.
  24308. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24309. * @returns the current mesh
  24310. */
  24311. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24312. /** @hidden */
  24313. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24314. /**
  24315. * This function will subdivide the mesh into multiple submeshes
  24316. * @param count defines the expected number of submeshes
  24317. */
  24318. subdivide(count: number): void;
  24319. /**
  24320. * Copy a FloatArray into a specific associated vertex buffer
  24321. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24322. * - VertexBuffer.PositionKind
  24323. * - VertexBuffer.UVKind
  24324. * - VertexBuffer.UV2Kind
  24325. * - VertexBuffer.UV3Kind
  24326. * - VertexBuffer.UV4Kind
  24327. * - VertexBuffer.UV5Kind
  24328. * - VertexBuffer.UV6Kind
  24329. * - VertexBuffer.ColorKind
  24330. * - VertexBuffer.MatricesIndicesKind
  24331. * - VertexBuffer.MatricesIndicesExtraKind
  24332. * - VertexBuffer.MatricesWeightsKind
  24333. * - VertexBuffer.MatricesWeightsExtraKind
  24334. * @param data defines the data source
  24335. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24336. * @param stride defines the data stride size (can be null)
  24337. * @returns the current mesh
  24338. */
  24339. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): Mesh;
  24340. /**
  24341. * Flags an associated vertex buffer as updatable
  24342. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24343. * - VertexBuffer.PositionKind
  24344. * - VertexBuffer.UVKind
  24345. * - VertexBuffer.UV2Kind
  24346. * - VertexBuffer.UV3Kind
  24347. * - VertexBuffer.UV4Kind
  24348. * - VertexBuffer.UV5Kind
  24349. * - VertexBuffer.UV6Kind
  24350. * - VertexBuffer.ColorKind
  24351. * - VertexBuffer.MatricesIndicesKind
  24352. * - VertexBuffer.MatricesIndicesExtraKind
  24353. * - VertexBuffer.MatricesWeightsKind
  24354. * - VertexBuffer.MatricesWeightsExtraKind
  24355. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24356. */
  24357. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24358. /**
  24359. * Sets the mesh global Vertex Buffer
  24360. * @param buffer defines the buffer to use
  24361. * @returns the current mesh
  24362. */
  24363. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24364. /**
  24365. * Update a specific associated vertex buffer
  24366. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24367. * - VertexBuffer.PositionKind
  24368. * - VertexBuffer.UVKind
  24369. * - VertexBuffer.UV2Kind
  24370. * - VertexBuffer.UV3Kind
  24371. * - VertexBuffer.UV4Kind
  24372. * - VertexBuffer.UV5Kind
  24373. * - VertexBuffer.UV6Kind
  24374. * - VertexBuffer.ColorKind
  24375. * - VertexBuffer.MatricesIndicesKind
  24376. * - VertexBuffer.MatricesIndicesExtraKind
  24377. * - VertexBuffer.MatricesWeightsKind
  24378. * - VertexBuffer.MatricesWeightsExtraKind
  24379. * @param data defines the data source
  24380. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24381. * @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)
  24382. * @returns the current mesh
  24383. */
  24384. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  24385. /**
  24386. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24387. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  24388. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  24389. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  24390. * @returns the current mesh
  24391. */
  24392. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  24393. /**
  24394. * Creates a un-shared specific occurence of the geometry for the mesh.
  24395. * @returns the current mesh
  24396. */
  24397. makeGeometryUnique(): Mesh;
  24398. /**
  24399. * Set the index buffer of this mesh
  24400. * @param indices defines the source data
  24401. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  24402. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  24403. * @returns the current mesh
  24404. */
  24405. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): Mesh;
  24406. /**
  24407. * Update the current index buffer
  24408. * @param indices defines the source data
  24409. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  24410. * @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)
  24411. * @returns the current mesh
  24412. */
  24413. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): Mesh;
  24414. /**
  24415. * Invert the geometry to move from a right handed system to a left handed one.
  24416. * @returns the current mesh
  24417. */
  24418. toLeftHanded(): Mesh;
  24419. /** @hidden */
  24420. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  24421. /** @hidden */
  24422. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  24423. /**
  24424. * Registers for this mesh a javascript function called just before the rendering process
  24425. * @param func defines the function to call before rendering this mesh
  24426. * @returns the current mesh
  24427. */
  24428. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24429. /**
  24430. * Disposes a previously registered javascript function called before the rendering
  24431. * @param func defines the function to remove
  24432. * @returns the current mesh
  24433. */
  24434. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24435. /**
  24436. * Registers for this mesh a javascript function called just after the rendering is complete
  24437. * @param func defines the function to call after rendering this mesh
  24438. * @returns the current mesh
  24439. */
  24440. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24441. /**
  24442. * Disposes a previously registered javascript function called after the rendering.
  24443. * @param func defines the function to remove
  24444. * @returns the current mesh
  24445. */
  24446. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24447. /** @hidden */
  24448. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  24449. /** @hidden */
  24450. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  24451. /** @hidden */
  24452. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  24453. /** @hidden */
  24454. _rebuild(): void;
  24455. /** @hidden */
  24456. _freeze(): void;
  24457. /** @hidden */
  24458. _unFreeze(): void;
  24459. /**
  24460. * 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
  24461. * @param subMesh defines the subMesh to render
  24462. * @param enableAlphaMode defines if alpha mode can be changed
  24463. * @returns the current mesh
  24464. */
  24465. render(subMesh: SubMesh, enableAlphaMode: boolean): Mesh;
  24466. private _onBeforeDraw;
  24467. /**
  24468. * Renormalize the mesh and patch it up if there are no weights
  24469. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  24470. * However in the case of zero weights then we set just a single influence to 1.
  24471. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  24472. */
  24473. cleanMatrixWeights(): void;
  24474. private normalizeSkinFourWeights;
  24475. private normalizeSkinWeightsAndExtra;
  24476. /**
  24477. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  24478. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  24479. * the user know there was an issue with importing the mesh
  24480. * @returns a validation object with skinned, valid and report string
  24481. */
  24482. validateSkinning(): {
  24483. skinned: boolean;
  24484. valid: boolean;
  24485. report: string;
  24486. };
  24487. /** @hidden */
  24488. _checkDelayState(): Mesh;
  24489. private _queueLoad;
  24490. /**
  24491. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  24492. * A mesh is in the frustum if its bounding box intersects the frustum
  24493. * @param frustumPlanes defines the frustum to test
  24494. * @returns true if the mesh is in the frustum planes
  24495. */
  24496. isInFrustum(frustumPlanes: Plane[]): boolean;
  24497. /**
  24498. * Sets the mesh material by the material or multiMaterial `id` property
  24499. * @param id is a string identifying the material or the multiMaterial
  24500. * @returns the current mesh
  24501. */
  24502. setMaterialByID(id: string): Mesh;
  24503. /**
  24504. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  24505. * @returns an array of IAnimatable
  24506. */
  24507. getAnimatables(): IAnimatable[];
  24508. /**
  24509. * Modifies the mesh geometry according to the passed transformation matrix.
  24510. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  24511. * The mesh normals are modified using the same transformation.
  24512. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24513. * @param transform defines the transform matrix to use
  24514. * @see http://doc.babylonjs.com/resources/baking_transformations
  24515. * @returns the current mesh
  24516. */
  24517. bakeTransformIntoVertices(transform: Matrix): Mesh;
  24518. /**
  24519. * Modifies the mesh geometry according to its own current World Matrix.
  24520. * The mesh World Matrix is then reset.
  24521. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  24522. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24523. * @see http://doc.babylonjs.com/resources/baking_transformations
  24524. * @returns the current mesh
  24525. */
  24526. bakeCurrentTransformIntoVertices(): Mesh;
  24527. /** @hidden */
  24528. readonly _positions: Nullable<Vector3[]>;
  24529. /** @hidden */
  24530. _resetPointsArrayCache(): Mesh;
  24531. /** @hidden */
  24532. _generatePointsArray(): boolean;
  24533. /**
  24534. * Returns a new Mesh object generated from the current mesh properties.
  24535. * This method must not get confused with createInstance()
  24536. * @param name is a string, the name given to the new mesh
  24537. * @param newParent can be any Node object (default `null`)
  24538. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  24539. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  24540. * @returns a new mesh
  24541. */
  24542. clone(name?: string, newParent?: Node, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  24543. /**
  24544. * Releases resources associated with this mesh.
  24545. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  24546. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  24547. */
  24548. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  24549. /**
  24550. * Modifies the mesh geometry according to a displacement map.
  24551. * 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.
  24552. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  24553. * @param url is a string, the URL from the image file is to be downloaded.
  24554. * @param minHeight is the lower limit of the displacement.
  24555. * @param maxHeight is the upper limit of the displacement.
  24556. * @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.
  24557. * @param uvOffset is an optional vector2 used to offset UV.
  24558. * @param uvScale is an optional vector2 used to scale UV.
  24559. * @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.
  24560. * @returns the Mesh.
  24561. */
  24562. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  24563. /**
  24564. * Modifies the mesh geometry according to a displacementMap buffer.
  24565. * 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.
  24566. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  24567. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  24568. * @param heightMapWidth is the width of the buffer image.
  24569. * @param heightMapHeight is the height of the buffer image.
  24570. * @param minHeight is the lower limit of the displacement.
  24571. * @param maxHeight is the upper limit of the displacement.
  24572. * @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.
  24573. * @param uvOffset is an optional vector2 used to offset UV.
  24574. * @param uvScale is an optional vector2 used to scale UV.
  24575. * @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.
  24576. * @returns the Mesh.
  24577. */
  24578. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  24579. /**
  24580. * Modify the mesh to get a flat shading rendering.
  24581. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  24582. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  24583. * @returns current mesh
  24584. */
  24585. convertToFlatShadedMesh(): Mesh;
  24586. /**
  24587. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  24588. * In other words, more vertices, no more indices and a single bigger VBO.
  24589. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  24590. * @returns current mesh
  24591. */
  24592. convertToUnIndexedMesh(): Mesh;
  24593. /**
  24594. * Inverses facet orientations.
  24595. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  24596. * @param flipNormals will also inverts the normals
  24597. * @returns current mesh
  24598. */
  24599. flipFaces(flipNormals?: boolean): Mesh;
  24600. /**
  24601. * Increase the number of facets and hence vertices in a mesh
  24602. * Vertex normals are interpolated from existing vertex normals
  24603. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  24604. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  24605. */
  24606. increaseVertices(numberPerEdge: number): void;
  24607. /**
  24608. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  24609. * This will undo any application of covertToFlatShadedMesh
  24610. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  24611. */
  24612. forceSharedVertices(): void;
  24613. /** @hidden */
  24614. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  24615. /** @hidden */
  24616. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  24617. /**
  24618. * Creates a new InstancedMesh object from the mesh model.
  24619. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24620. * @param name defines the name of the new instance
  24621. * @returns a new InstancedMesh
  24622. */
  24623. createInstance(name: string): InstancedMesh;
  24624. /**
  24625. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  24626. * After this call, all the mesh instances have the same submeshes than the current mesh.
  24627. * @returns the current mesh
  24628. */
  24629. synchronizeInstances(): Mesh;
  24630. /**
  24631. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  24632. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  24633. * This should be used together with the simplification to avoid disappearing triangles.
  24634. * @param successCallback an optional success callback to be called after the optimization finished.
  24635. * @returns the current mesh
  24636. */
  24637. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  24638. /**
  24639. * Serialize current mesh
  24640. * @param serializationObject defines the object which will receive the serialization data
  24641. */
  24642. serialize(serializationObject: any): void;
  24643. /** @hidden */
  24644. _syncGeometryWithMorphTargetManager(): void;
  24645. /** @hidden */
  24646. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  24647. /**
  24648. * Returns a new Mesh object parsed from the source provided.
  24649. * @param parsedMesh is the source
  24650. * @param scene defines the hosting scene
  24651. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  24652. * @returns a new Mesh
  24653. */
  24654. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  24655. /**
  24656. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  24657. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  24658. * @param name defines the name of the mesh to create
  24659. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  24660. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  24661. * @param closePath creates a seam between the first and the last points of each path of the path array
  24662. * @param offset is taken in account only if the `pathArray` is containing a single path
  24663. * @param scene defines the hosting scene
  24664. * @param updatable defines if the mesh must be flagged as updatable
  24665. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24666. * @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)
  24667. * @returns a new Mesh
  24668. */
  24669. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  24670. /**
  24671. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  24672. * @param name defines the name of the mesh to create
  24673. * @param radius sets the radius size (float) of the polygon (default 0.5)
  24674. * @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
  24675. * @param scene defines the hosting scene
  24676. * @param updatable defines if the mesh must be flagged as updatable
  24677. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24678. * @returns a new Mesh
  24679. */
  24680. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  24681. /**
  24682. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  24683. * @param name defines the name of the mesh to create
  24684. * @param size sets the size (float) of each box side (default 1)
  24685. * @param scene defines the hosting scene
  24686. * @param updatable defines if the mesh must be flagged as updatable
  24687. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24688. * @returns a new Mesh
  24689. */
  24690. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  24691. /**
  24692. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  24693. * @param name defines the name of the mesh to create
  24694. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  24695. * @param diameter sets the diameter size (float) of the sphere (default 1)
  24696. * @param scene defines the hosting scene
  24697. * @param updatable defines if the mesh must be flagged as updatable
  24698. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24699. * @returns a new Mesh
  24700. */
  24701. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24702. /**
  24703. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  24704. * @param name defines the name of the mesh to create
  24705. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  24706. * @param diameter sets the diameter size (float) of the sphere (default 1)
  24707. * @param scene defines the hosting scene
  24708. * @returns a new Mesh
  24709. */
  24710. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  24711. /**
  24712. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  24713. * @param name defines the name of the mesh to create
  24714. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  24715. * @param diameterTop set the top cap diameter (floats, default 1)
  24716. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  24717. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  24718. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  24719. * @param scene defines the hosting scene
  24720. * @param updatable defines if the mesh must be flagged as updatable
  24721. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24722. * @returns a new Mesh
  24723. */
  24724. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  24725. /**
  24726. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  24727. * @param name defines the name of the mesh to create
  24728. * @param diameter sets the diameter size (float) of the torus (default 1)
  24729. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  24730. * @param tessellation sets the number of torus sides (postive integer, default 16)
  24731. * @param scene defines the hosting scene
  24732. * @param updatable defines if the mesh must be flagged as updatable
  24733. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24734. * @returns a new Mesh
  24735. */
  24736. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24737. /**
  24738. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  24739. * @param name defines the name of the mesh to create
  24740. * @param radius sets the global radius size (float) of the torus knot (default 2)
  24741. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  24742. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  24743. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  24744. * @param p the number of windings on X axis (positive integers, default 2)
  24745. * @param q the number of windings on Y axis (positive integers, default 3)
  24746. * @param scene defines the hosting scene
  24747. * @param updatable defines if the mesh must be flagged as updatable
  24748. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24749. * @returns a new Mesh
  24750. */
  24751. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24752. /**
  24753. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  24754. * @param name defines the name of the mesh to create
  24755. * @param points is an array successive Vector3
  24756. * @param scene defines the hosting scene
  24757. * @param updatable defines if the mesh must be flagged as updatable
  24758. * @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).
  24759. * @returns a new Mesh
  24760. */
  24761. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  24762. /**
  24763. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  24764. * @param name defines the name of the mesh to create
  24765. * @param points is an array successive Vector3
  24766. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  24767. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  24768. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  24769. * @param scene defines the hosting scene
  24770. * @param updatable defines if the mesh must be flagged as updatable
  24771. * @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)
  24772. * @returns a new Mesh
  24773. */
  24774. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  24775. /**
  24776. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  24777. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  24778. * 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.
  24779. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  24780. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  24781. * Remember you can only change the shape positions, not their number when updating a polygon.
  24782. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  24783. * @param name defines the name of the mesh to create
  24784. * @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
  24785. * @param scene defines the hosting scene
  24786. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  24787. * @param updatable defines if the mesh must be flagged as updatable
  24788. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24789. * @param earcutInjection can be used to inject your own earcut reference
  24790. * @returns a new Mesh
  24791. */
  24792. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  24793. /**
  24794. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  24795. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  24796. * @param name defines the name of the mesh to create
  24797. * @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
  24798. * @param depth defines the height of extrusion
  24799. * @param scene defines the hosting scene
  24800. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  24801. * @param updatable defines if the mesh must be flagged as updatable
  24802. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24803. * @param earcutInjection can be used to inject your own earcut reference
  24804. * @returns a new Mesh
  24805. */
  24806. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  24807. /**
  24808. * Creates an extruded shape mesh.
  24809. * 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
  24810. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  24811. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  24812. * @param name defines the name of the mesh to create
  24813. * @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
  24814. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  24815. * @param scale is the value to scale the shape
  24816. * @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
  24817. * @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
  24818. * @param scene defines the hosting scene
  24819. * @param updatable defines if the mesh must be flagged as updatable
  24820. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24821. * @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)
  24822. * @returns a new Mesh
  24823. */
  24824. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  24825. /**
  24826. * Creates an custom extruded shape mesh.
  24827. * The custom extrusion is a parametric shape.
  24828. * It has no predefined shape. Its final shape will depend on the input parameters.
  24829. * Please consider using the same method from the MeshBuilder class instead
  24830. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  24831. * @param name defines the name of the mesh to create
  24832. * @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
  24833. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  24834. * @param scaleFunction is a custom Javascript function called on each path point
  24835. * @param rotationFunction is a custom Javascript function called on each path point
  24836. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  24837. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  24838. * @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
  24839. * @param scene defines the hosting scene
  24840. * @param updatable defines if the mesh must be flagged as updatable
  24841. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24842. * @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)
  24843. * @returns a new Mesh
  24844. */
  24845. 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;
  24846. /**
  24847. * Creates lathe mesh.
  24848. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  24849. * Please consider using the same method from the MeshBuilder class instead
  24850. * @param name defines the name of the mesh to create
  24851. * @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
  24852. * @param radius is the radius value of the lathe
  24853. * @param tessellation is the side number of the lathe.
  24854. * @param scene defines the hosting scene
  24855. * @param updatable defines if the mesh must be flagged as updatable
  24856. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24857. * @returns a new Mesh
  24858. */
  24859. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24860. /**
  24861. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  24862. * @param name defines the name of the mesh to create
  24863. * @param size sets the size (float) of both sides of the plane at once (default 1)
  24864. * @param scene defines the hosting scene
  24865. * @param updatable defines if the mesh must be flagged as updatable
  24866. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24867. * @returns a new Mesh
  24868. */
  24869. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  24870. /**
  24871. * Creates a ground mesh.
  24872. * Please consider using the same method from the MeshBuilder class instead
  24873. * @param name defines the name of the mesh to create
  24874. * @param width set the width of the ground
  24875. * @param height set the height of the ground
  24876. * @param subdivisions sets the number of subdivisions per side
  24877. * @param scene defines the hosting scene
  24878. * @param updatable defines if the mesh must be flagged as updatable
  24879. * @returns a new Mesh
  24880. */
  24881. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  24882. /**
  24883. * Creates a tiled ground mesh.
  24884. * Please consider using the same method from the MeshBuilder class instead
  24885. * @param name defines the name of the mesh to create
  24886. * @param xmin set the ground minimum X coordinate
  24887. * @param zmin set the ground minimum Y coordinate
  24888. * @param xmax set the ground maximum X coordinate
  24889. * @param zmax set the ground maximum Z coordinate
  24890. * @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
  24891. * @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
  24892. * @param scene defines the hosting scene
  24893. * @param updatable defines if the mesh must be flagged as updatable
  24894. * @returns a new Mesh
  24895. */
  24896. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  24897. w: number;
  24898. h: number;
  24899. }, precision: {
  24900. w: number;
  24901. h: number;
  24902. }, scene: Scene, updatable?: boolean): Mesh;
  24903. /**
  24904. * Creates a ground mesh from a height map.
  24905. * Please consider using the same method from the MeshBuilder class instead
  24906. * @see http://doc.babylonjs.com/babylon101/height_map
  24907. * @param name defines the name of the mesh to create
  24908. * @param url sets the URL of the height map image resource
  24909. * @param width set the ground width size
  24910. * @param height set the ground height size
  24911. * @param subdivisions sets the number of subdivision per side
  24912. * @param minHeight is the minimum altitude on the ground
  24913. * @param maxHeight is the maximum altitude on the ground
  24914. * @param scene defines the hosting scene
  24915. * @param updatable defines if the mesh must be flagged as updatable
  24916. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  24917. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  24918. * @returns a new Mesh
  24919. */
  24920. 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;
  24921. /**
  24922. * Creates a tube mesh.
  24923. * The tube is a parametric shape.
  24924. * It has no predefined shape. Its final shape will depend on the input parameters.
  24925. * Please consider using the same method from the MeshBuilder class instead
  24926. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  24927. * @param name defines the name of the mesh to create
  24928. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  24929. * @param radius sets the tube radius size
  24930. * @param tessellation is the number of sides on the tubular surface
  24931. * @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
  24932. * @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
  24933. * @param scene defines the hosting scene
  24934. * @param updatable defines if the mesh must be flagged as updatable
  24935. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  24936. * @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)
  24937. * @returns a new Mesh
  24938. */
  24939. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  24940. (i: number, distance: number): number;
  24941. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  24942. /**
  24943. * Creates a polyhedron mesh.
  24944. * Please consider using the same method from the MeshBuilder class instead.
  24945. * * 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
  24946. * * The parameter `size` (positive float, default 1) sets the polygon size
  24947. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  24948. * * 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`
  24949. * * 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
  24950. * * 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)`)
  24951. * * 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
  24952. * * 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
  24953. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  24954. * * If you create a double-sided mesh, you can choose what parts of 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
  24955. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  24956. * @param name defines the name of the mesh to create
  24957. * @param options defines the options used to create the mesh
  24958. * @param scene defines the hosting scene
  24959. * @returns a new Mesh
  24960. */
  24961. static CreatePolyhedron(name: string, options: {
  24962. type?: number;
  24963. size?: number;
  24964. sizeX?: number;
  24965. sizeY?: number;
  24966. sizeZ?: number;
  24967. custom?: any;
  24968. faceUV?: Vector4[];
  24969. faceColors?: Color4[];
  24970. updatable?: boolean;
  24971. sideOrientation?: number;
  24972. }, scene: Scene): Mesh;
  24973. /**
  24974. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  24975. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  24976. * * 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`)
  24977. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  24978. * * 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
  24979. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  24980. * * If you create a double-sided mesh, you can choose what parts of 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
  24981. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  24982. * @param name defines the name of the mesh
  24983. * @param options defines the options used to create the mesh
  24984. * @param scene defines the hosting scene
  24985. * @returns a new Mesh
  24986. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  24987. */
  24988. static CreateIcoSphere(name: string, options: {
  24989. radius?: number;
  24990. flat?: boolean;
  24991. subdivisions?: number;
  24992. sideOrientation?: number;
  24993. updatable?: boolean;
  24994. }, scene: Scene): Mesh;
  24995. /**
  24996. * Creates a decal mesh.
  24997. * Please consider using the same method from the MeshBuilder class instead.
  24998. * A decal is a mesh usually applied as a model onto the surface of another mesh
  24999. * @param name defines the name of the mesh
  25000. * @param sourceMesh defines the mesh receiving the decal
  25001. * @param position sets the position of the decal in world coordinates
  25002. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25003. * @param size sets the decal scaling
  25004. * @param angle sets the angle to rotate the decal
  25005. * @returns a new Mesh
  25006. */
  25007. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25008. /**
  25009. * Prepare internal position array for software CPU skinning
  25010. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25011. */
  25012. setPositionsForCPUSkinning(): Float32Array;
  25013. /**
  25014. * Prepare internal normal array for software CPU skinning
  25015. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25016. */
  25017. setNormalsForCPUSkinning(): Float32Array;
  25018. /**
  25019. * Updates the vertex buffer by applying transformation from the bones
  25020. * @param skeleton defines the skeleton to apply to current mesh
  25021. * @returns the current mesh
  25022. */
  25023. applySkeleton(skeleton: Skeleton): Mesh;
  25024. /**
  25025. * 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
  25026. * @param meshes defines the list of meshes to scan
  25027. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25028. */
  25029. static MinMax(meshes: AbstractMesh[]): {
  25030. min: Vector3;
  25031. max: Vector3;
  25032. };
  25033. /**
  25034. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25035. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25036. * @returns a vector3
  25037. */
  25038. static Center(meshesOrMinMaxVector: {
  25039. min: Vector3;
  25040. max: Vector3;
  25041. } | AbstractMesh[]): Vector3;
  25042. /**
  25043. * Merge the array of meshes into a single mesh for performance reasons.
  25044. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25045. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25046. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25047. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25048. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25049. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25050. * @returns a new mesh
  25051. */
  25052. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25053. /** @hidden */
  25054. addInstance(instance: InstancedMesh): void;
  25055. /** @hidden */
  25056. removeInstance(instance: InstancedMesh): void;
  25057. }
  25058. }
  25059. declare module "babylonjs/Cameras/camera" {
  25060. import { SmartArray } from "babylonjs/Misc/smartArray";
  25061. import { Observable } from "babylonjs/Misc/observable";
  25062. import { Nullable } from "babylonjs/types";
  25063. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25064. import { Scene } from "babylonjs/scene";
  25065. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  25066. import { Node } from "babylonjs/node";
  25067. import { Mesh } from "babylonjs/Meshes/mesh";
  25068. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25069. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25070. import { Viewport } from "babylonjs/Maths/math.viewport";
  25071. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25072. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25073. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25074. import { Ray } from "babylonjs/Culling/ray";
  25075. /**
  25076. * This is the base class of all the camera used in the application.
  25077. * @see http://doc.babylonjs.com/features/cameras
  25078. */
  25079. export class Camera extends Node {
  25080. /** @hidden */
  25081. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25082. /**
  25083. * This is the default projection mode used by the cameras.
  25084. * It helps recreating a feeling of perspective and better appreciate depth.
  25085. * This is the best way to simulate real life cameras.
  25086. */
  25087. static readonly PERSPECTIVE_CAMERA: number;
  25088. /**
  25089. * This helps creating camera with an orthographic mode.
  25090. * 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.
  25091. */
  25092. static readonly ORTHOGRAPHIC_CAMERA: number;
  25093. /**
  25094. * This is the default FOV mode for perspective cameras.
  25095. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25096. */
  25097. static readonly FOVMODE_VERTICAL_FIXED: number;
  25098. /**
  25099. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25100. */
  25101. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25102. /**
  25103. * This specifies ther is no need for a camera rig.
  25104. * Basically only one eye is rendered corresponding to the camera.
  25105. */
  25106. static readonly RIG_MODE_NONE: number;
  25107. /**
  25108. * Simulates a camera Rig with one blue eye and one red eye.
  25109. * This can be use with 3d blue and red glasses.
  25110. */
  25111. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25112. /**
  25113. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25114. */
  25115. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25116. /**
  25117. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25118. */
  25119. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25120. /**
  25121. * Defines that both eyes of the camera will be rendered over under each other.
  25122. */
  25123. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25124. /**
  25125. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25126. */
  25127. static readonly RIG_MODE_VR: number;
  25128. /**
  25129. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25130. */
  25131. static readonly RIG_MODE_WEBVR: number;
  25132. /**
  25133. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25134. */
  25135. static readonly RIG_MODE_CUSTOM: number;
  25136. /**
  25137. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25138. */
  25139. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25140. /**
  25141. * Define the input manager associated with the camera.
  25142. */
  25143. inputs: CameraInputsManager<Camera>;
  25144. /** @hidden */
  25145. _position: Vector3;
  25146. /**
  25147. * Define the current local position of the camera in the scene
  25148. */
  25149. position: Vector3;
  25150. /**
  25151. * The vector the camera should consider as up.
  25152. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25153. */
  25154. upVector: Vector3;
  25155. /**
  25156. * Define the current limit on the left side for an orthographic camera
  25157. * In scene unit
  25158. */
  25159. orthoLeft: Nullable<number>;
  25160. /**
  25161. * Define the current limit on the right side for an orthographic camera
  25162. * In scene unit
  25163. */
  25164. orthoRight: Nullable<number>;
  25165. /**
  25166. * Define the current limit on the bottom side for an orthographic camera
  25167. * In scene unit
  25168. */
  25169. orthoBottom: Nullable<number>;
  25170. /**
  25171. * Define the current limit on the top side for an orthographic camera
  25172. * In scene unit
  25173. */
  25174. orthoTop: Nullable<number>;
  25175. /**
  25176. * Field Of View is set in Radians. (default is 0.8)
  25177. */
  25178. fov: number;
  25179. /**
  25180. * Define the minimum distance the camera can see from.
  25181. * This is important to note that the depth buffer are not infinite and the closer it starts
  25182. * the more your scene might encounter depth fighting issue.
  25183. */
  25184. minZ: number;
  25185. /**
  25186. * Define the maximum distance the camera can see to.
  25187. * This is important to note that the depth buffer are not infinite and the further it end
  25188. * the more your scene might encounter depth fighting issue.
  25189. */
  25190. maxZ: number;
  25191. /**
  25192. * Define the default inertia of the camera.
  25193. * This helps giving a smooth feeling to the camera movement.
  25194. */
  25195. inertia: number;
  25196. /**
  25197. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25198. */
  25199. mode: number;
  25200. /**
  25201. * Define wether the camera is intermediate.
  25202. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25203. */
  25204. isIntermediate: boolean;
  25205. /**
  25206. * Define the viewport of the camera.
  25207. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25208. */
  25209. viewport: Viewport;
  25210. /**
  25211. * Restricts the camera to viewing objects with the same layerMask.
  25212. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25213. */
  25214. layerMask: number;
  25215. /**
  25216. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25217. */
  25218. fovMode: number;
  25219. /**
  25220. * Rig mode of the camera.
  25221. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25222. * This is normally controlled byt the camera themselves as internal use.
  25223. */
  25224. cameraRigMode: number;
  25225. /**
  25226. * Defines the distance between both "eyes" in case of a RIG
  25227. */
  25228. interaxialDistance: number;
  25229. /**
  25230. * Defines if stereoscopic rendering is done side by side or over under.
  25231. */
  25232. isStereoscopicSideBySide: boolean;
  25233. /**
  25234. * 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
  25235. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25236. * else in the scene. (Eg. security camera)
  25237. *
  25238. * 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)
  25239. */
  25240. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25241. /**
  25242. * When set, the camera will render to this render target instead of the default canvas
  25243. *
  25244. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25245. */
  25246. outputRenderTarget: Nullable<RenderTargetTexture>;
  25247. /**
  25248. * Observable triggered when the camera view matrix has changed.
  25249. */
  25250. onViewMatrixChangedObservable: Observable<Camera>;
  25251. /**
  25252. * Observable triggered when the camera Projection matrix has changed.
  25253. */
  25254. onProjectionMatrixChangedObservable: Observable<Camera>;
  25255. /**
  25256. * Observable triggered when the inputs have been processed.
  25257. */
  25258. onAfterCheckInputsObservable: Observable<Camera>;
  25259. /**
  25260. * Observable triggered when reset has been called and applied to the camera.
  25261. */
  25262. onRestoreStateObservable: Observable<Camera>;
  25263. /** @hidden */
  25264. _cameraRigParams: any;
  25265. /** @hidden */
  25266. _rigCameras: Camera[];
  25267. /** @hidden */
  25268. _rigPostProcess: Nullable<PostProcess>;
  25269. protected _webvrViewMatrix: Matrix;
  25270. /** @hidden */
  25271. _skipRendering: boolean;
  25272. /** @hidden */
  25273. _projectionMatrix: Matrix;
  25274. /** @hidden */
  25275. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25276. /** @hidden */
  25277. _activeMeshes: SmartArray<AbstractMesh>;
  25278. protected _globalPosition: Vector3;
  25279. /** @hidden */
  25280. _computedViewMatrix: Matrix;
  25281. private _doNotComputeProjectionMatrix;
  25282. private _transformMatrix;
  25283. private _frustumPlanes;
  25284. private _refreshFrustumPlanes;
  25285. private _storedFov;
  25286. private _stateStored;
  25287. /**
  25288. * Instantiates a new camera object.
  25289. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25290. * @see http://doc.babylonjs.com/features/cameras
  25291. * @param name Defines the name of the camera in the scene
  25292. * @param position Defines the position of the camera
  25293. * @param scene Defines the scene the camera belongs too
  25294. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25295. */
  25296. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25297. /**
  25298. * Store current camera state (fov, position, etc..)
  25299. * @returns the camera
  25300. */
  25301. storeState(): Camera;
  25302. /**
  25303. * Restores the camera state values if it has been stored. You must call storeState() first
  25304. */
  25305. protected _restoreStateValues(): boolean;
  25306. /**
  25307. * Restored camera state. You must call storeState() first.
  25308. * @returns true if restored and false otherwise
  25309. */
  25310. restoreState(): boolean;
  25311. /**
  25312. * Gets the class name of the camera.
  25313. * @returns the class name
  25314. */
  25315. getClassName(): string;
  25316. /** @hidden */
  25317. readonly _isCamera: boolean;
  25318. /**
  25319. * Gets a string representation of the camera useful for debug purpose.
  25320. * @param fullDetails Defines that a more verboe level of logging is required
  25321. * @returns the string representation
  25322. */
  25323. toString(fullDetails?: boolean): string;
  25324. /**
  25325. * Gets the current world space position of the camera.
  25326. */
  25327. readonly globalPosition: Vector3;
  25328. /**
  25329. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25330. * @returns the active meshe list
  25331. */
  25332. getActiveMeshes(): SmartArray<AbstractMesh>;
  25333. /**
  25334. * Check wether a mesh is part of the current active mesh list of the camera
  25335. * @param mesh Defines the mesh to check
  25336. * @returns true if active, false otherwise
  25337. */
  25338. isActiveMesh(mesh: Mesh): boolean;
  25339. /**
  25340. * Is this camera ready to be used/rendered
  25341. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25342. * @return true if the camera is ready
  25343. */
  25344. isReady(completeCheck?: boolean): boolean;
  25345. /** @hidden */
  25346. _initCache(): void;
  25347. /** @hidden */
  25348. _updateCache(ignoreParentClass?: boolean): void;
  25349. /** @hidden */
  25350. _isSynchronized(): boolean;
  25351. /** @hidden */
  25352. _isSynchronizedViewMatrix(): boolean;
  25353. /** @hidden */
  25354. _isSynchronizedProjectionMatrix(): boolean;
  25355. /**
  25356. * Attach the input controls to a specific dom element to get the input from.
  25357. * @param element Defines the element the controls should be listened from
  25358. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25359. */
  25360. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25361. /**
  25362. * Detach the current controls from the specified dom element.
  25363. * @param element Defines the element to stop listening the inputs from
  25364. */
  25365. detachControl(element: HTMLElement): void;
  25366. /**
  25367. * Update the camera state according to the different inputs gathered during the frame.
  25368. */
  25369. update(): void;
  25370. /** @hidden */
  25371. _checkInputs(): void;
  25372. /** @hidden */
  25373. readonly rigCameras: Camera[];
  25374. /**
  25375. * Gets the post process used by the rig cameras
  25376. */
  25377. readonly rigPostProcess: Nullable<PostProcess>;
  25378. /**
  25379. * Internal, gets the first post proces.
  25380. * @returns the first post process to be run on this camera.
  25381. */
  25382. _getFirstPostProcess(): Nullable<PostProcess>;
  25383. private _cascadePostProcessesToRigCams;
  25384. /**
  25385. * Attach a post process to the camera.
  25386. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25387. * @param postProcess The post process to attach to the camera
  25388. * @param insertAt The position of the post process in case several of them are in use in the scene
  25389. * @returns the position the post process has been inserted at
  25390. */
  25391. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  25392. /**
  25393. * Detach a post process to the camera.
  25394. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25395. * @param postProcess The post process to detach from the camera
  25396. */
  25397. detachPostProcess(postProcess: PostProcess): void;
  25398. /**
  25399. * Gets the current world matrix of the camera
  25400. */
  25401. getWorldMatrix(): Matrix;
  25402. /** @hidden */
  25403. _getViewMatrix(): Matrix;
  25404. /**
  25405. * Gets the current view matrix of the camera.
  25406. * @param force forces the camera to recompute the matrix without looking at the cached state
  25407. * @returns the view matrix
  25408. */
  25409. getViewMatrix(force?: boolean): Matrix;
  25410. /**
  25411. * Freeze the projection matrix.
  25412. * It will prevent the cache check of the camera projection compute and can speed up perf
  25413. * if no parameter of the camera are meant to change
  25414. * @param projection Defines manually a projection if necessary
  25415. */
  25416. freezeProjectionMatrix(projection?: Matrix): void;
  25417. /**
  25418. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  25419. */
  25420. unfreezeProjectionMatrix(): void;
  25421. /**
  25422. * Gets the current projection matrix of the camera.
  25423. * @param force forces the camera to recompute the matrix without looking at the cached state
  25424. * @returns the projection matrix
  25425. */
  25426. getProjectionMatrix(force?: boolean): Matrix;
  25427. /**
  25428. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  25429. * @returns a Matrix
  25430. */
  25431. getTransformationMatrix(): Matrix;
  25432. private _updateFrustumPlanes;
  25433. /**
  25434. * Checks if a cullable object (mesh...) is in the camera frustum
  25435. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  25436. * @param target The object to check
  25437. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  25438. * @returns true if the object is in frustum otherwise false
  25439. */
  25440. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  25441. /**
  25442. * Checks if a cullable object (mesh...) is in the camera frustum
  25443. * Unlike isInFrustum this cheks the full bounding box
  25444. * @param target The object to check
  25445. * @returns true if the object is in frustum otherwise false
  25446. */
  25447. isCompletelyInFrustum(target: ICullable): boolean;
  25448. /**
  25449. * Gets a ray in the forward direction from the camera.
  25450. * @param length Defines the length of the ray to create
  25451. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  25452. * @param origin Defines the start point of the ray which defaults to the camera position
  25453. * @returns the forward ray
  25454. */
  25455. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  25456. /**
  25457. * Releases resources associated with this node.
  25458. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25459. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25460. */
  25461. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25462. /** @hidden */
  25463. _isLeftCamera: boolean;
  25464. /**
  25465. * Gets the left camera of a rig setup in case of Rigged Camera
  25466. */
  25467. readonly isLeftCamera: boolean;
  25468. /** @hidden */
  25469. _isRightCamera: boolean;
  25470. /**
  25471. * Gets the right camera of a rig setup in case of Rigged Camera
  25472. */
  25473. readonly isRightCamera: boolean;
  25474. /**
  25475. * Gets the left camera of a rig setup in case of Rigged Camera
  25476. */
  25477. readonly leftCamera: Nullable<FreeCamera>;
  25478. /**
  25479. * Gets the right camera of a rig setup in case of Rigged Camera
  25480. */
  25481. readonly rightCamera: Nullable<FreeCamera>;
  25482. /**
  25483. * Gets the left camera target of a rig setup in case of Rigged Camera
  25484. * @returns the target position
  25485. */
  25486. getLeftTarget(): Nullable<Vector3>;
  25487. /**
  25488. * Gets the right camera target of a rig setup in case of Rigged Camera
  25489. * @returns the target position
  25490. */
  25491. getRightTarget(): Nullable<Vector3>;
  25492. /**
  25493. * @hidden
  25494. */
  25495. setCameraRigMode(mode: number, rigParams: any): void;
  25496. /** @hidden */
  25497. static _setStereoscopicRigMode(camera: Camera): void;
  25498. /** @hidden */
  25499. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  25500. /** @hidden */
  25501. static _setVRRigMode(camera: Camera, rigParams: any): void;
  25502. /** @hidden */
  25503. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  25504. /** @hidden */
  25505. _getVRProjectionMatrix(): Matrix;
  25506. protected _updateCameraRotationMatrix(): void;
  25507. protected _updateWebVRCameraRotationMatrix(): void;
  25508. /**
  25509. * This function MUST be overwritten by the different WebVR cameras available.
  25510. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25511. * @hidden
  25512. */
  25513. _getWebVRProjectionMatrix(): Matrix;
  25514. /**
  25515. * This function MUST be overwritten by the different WebVR cameras available.
  25516. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25517. * @hidden
  25518. */
  25519. _getWebVRViewMatrix(): Matrix;
  25520. /** @hidden */
  25521. setCameraRigParameter(name: string, value: any): void;
  25522. /**
  25523. * needs to be overridden by children so sub has required properties to be copied
  25524. * @hidden
  25525. */
  25526. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  25527. /**
  25528. * May need to be overridden by children
  25529. * @hidden
  25530. */
  25531. _updateRigCameras(): void;
  25532. /** @hidden */
  25533. _setupInputs(): void;
  25534. /**
  25535. * Serialiaze the camera setup to a json represention
  25536. * @returns the JSON representation
  25537. */
  25538. serialize(): any;
  25539. /**
  25540. * Clones the current camera.
  25541. * @param name The cloned camera name
  25542. * @returns the cloned camera
  25543. */
  25544. clone(name: string): Camera;
  25545. /**
  25546. * Gets the direction of the camera relative to a given local axis.
  25547. * @param localAxis Defines the reference axis to provide a relative direction.
  25548. * @return the direction
  25549. */
  25550. getDirection(localAxis: Vector3): Vector3;
  25551. /**
  25552. * Gets the direction of the camera relative to a given local axis into a passed vector.
  25553. * @param localAxis Defines the reference axis to provide a relative direction.
  25554. * @param result Defines the vector to store the result in
  25555. */
  25556. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  25557. /**
  25558. * Gets a camera constructor for a given camera type
  25559. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  25560. * @param name The name of the camera the result will be able to instantiate
  25561. * @param scene The scene the result will construct the camera in
  25562. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  25563. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  25564. * @returns a factory method to construc the camera
  25565. */
  25566. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  25567. /**
  25568. * Compute the world matrix of the camera.
  25569. * @returns the camera workd matrix
  25570. */
  25571. computeWorldMatrix(): Matrix;
  25572. /**
  25573. * Parse a JSON and creates the camera from the parsed information
  25574. * @param parsedCamera The JSON to parse
  25575. * @param scene The scene to instantiate the camera in
  25576. * @returns the newly constructed camera
  25577. */
  25578. static Parse(parsedCamera: any, scene: Scene): Camera;
  25579. }
  25580. }
  25581. declare module "babylonjs/Meshes/Builders/discBuilder" {
  25582. import { Nullable } from "babylonjs/types";
  25583. import { Scene } from "babylonjs/scene";
  25584. import { Vector4 } from "babylonjs/Maths/math.vector";
  25585. import { Mesh } from "babylonjs/Meshes/mesh";
  25586. /**
  25587. * Class containing static functions to help procedurally build meshes
  25588. */
  25589. export class DiscBuilder {
  25590. /**
  25591. * Creates a plane polygonal mesh. By default, this is a disc
  25592. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  25593. * * 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
  25594. * * 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
  25595. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  25596. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25597. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25598. * @param name defines the name of the mesh
  25599. * @param options defines the options used to create the mesh
  25600. * @param scene defines the hosting scene
  25601. * @returns the plane polygonal mesh
  25602. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  25603. */
  25604. static CreateDisc(name: string, options: {
  25605. radius?: number;
  25606. tessellation?: number;
  25607. arc?: number;
  25608. updatable?: boolean;
  25609. sideOrientation?: number;
  25610. frontUVs?: Vector4;
  25611. backUVs?: Vector4;
  25612. }, scene?: Nullable<Scene>): Mesh;
  25613. }
  25614. }
  25615. declare module "babylonjs/Particles/solidParticleSystem" {
  25616. import { Vector3 } from "babylonjs/Maths/math.vector";
  25617. import { Mesh } from "babylonjs/Meshes/mesh";
  25618. import { Scene, IDisposable } from "babylonjs/scene";
  25619. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  25620. /**
  25621. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  25622. *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.
  25623. * The SPS is also a particle system. It provides some methods to manage the particles.
  25624. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  25625. *
  25626. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  25627. */
  25628. export class SolidParticleSystem implements IDisposable {
  25629. /**
  25630. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  25631. * Example : var p = SPS.particles[i];
  25632. */
  25633. particles: SolidParticle[];
  25634. /**
  25635. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  25636. */
  25637. nbParticles: number;
  25638. /**
  25639. * If the particles must ever face the camera (default false). Useful for planar particles.
  25640. */
  25641. billboard: boolean;
  25642. /**
  25643. * Recompute normals when adding a shape
  25644. */
  25645. recomputeNormals: boolean;
  25646. /**
  25647. * This a counter ofr your own usage. It's not set by any SPS functions.
  25648. */
  25649. counter: number;
  25650. /**
  25651. * The SPS name. This name is also given to the underlying mesh.
  25652. */
  25653. name: string;
  25654. /**
  25655. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  25656. */
  25657. mesh: Mesh;
  25658. /**
  25659. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  25660. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  25661. */
  25662. vars: any;
  25663. /**
  25664. * This array is populated when the SPS is set as 'pickable'.
  25665. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  25666. * Each element of this array is an object `{idx: int, faceId: int}`.
  25667. * `idx` is the picked particle index in the `SPS.particles` array
  25668. * `faceId` is the picked face index counted within this particle.
  25669. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  25670. */
  25671. pickedParticles: {
  25672. idx: number;
  25673. faceId: number;
  25674. }[];
  25675. /**
  25676. * This array is populated when `enableDepthSort` is set to true.
  25677. * Each element of this array is an instance of the class DepthSortedParticle.
  25678. */
  25679. depthSortedParticles: DepthSortedParticle[];
  25680. /**
  25681. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  25682. * @hidden
  25683. */
  25684. _bSphereOnly: boolean;
  25685. /**
  25686. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  25687. * @hidden
  25688. */
  25689. _bSphereRadiusFactor: number;
  25690. private _scene;
  25691. private _positions;
  25692. private _indices;
  25693. private _normals;
  25694. private _colors;
  25695. private _uvs;
  25696. private _indices32;
  25697. private _positions32;
  25698. private _normals32;
  25699. private _fixedNormal32;
  25700. private _colors32;
  25701. private _uvs32;
  25702. private _index;
  25703. private _updatable;
  25704. private _pickable;
  25705. private _isVisibilityBoxLocked;
  25706. private _alwaysVisible;
  25707. private _depthSort;
  25708. private _shapeCounter;
  25709. private _copy;
  25710. private _color;
  25711. private _computeParticleColor;
  25712. private _computeParticleTexture;
  25713. private _computeParticleRotation;
  25714. private _computeParticleVertex;
  25715. private _computeBoundingBox;
  25716. private _depthSortParticles;
  25717. private _camera;
  25718. private _mustUnrotateFixedNormals;
  25719. private _particlesIntersect;
  25720. private _needs32Bits;
  25721. /**
  25722. * Creates a SPS (Solid Particle System) object.
  25723. * @param name (String) is the SPS name, this will be the underlying mesh name.
  25724. * @param scene (Scene) is the scene in which the SPS is added.
  25725. * @param options defines the options of the sps e.g.
  25726. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  25727. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  25728. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  25729. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  25730. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  25731. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  25732. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  25733. */
  25734. constructor(name: string, scene: Scene, options?: {
  25735. updatable?: boolean;
  25736. isPickable?: boolean;
  25737. enableDepthSort?: boolean;
  25738. particleIntersection?: boolean;
  25739. boundingSphereOnly?: boolean;
  25740. bSphereRadiusFactor?: number;
  25741. });
  25742. /**
  25743. * Builds the SPS underlying mesh. Returns a standard Mesh.
  25744. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  25745. * @returns the created mesh
  25746. */
  25747. buildMesh(): Mesh;
  25748. /**
  25749. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  25750. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  25751. * Thus the particles generated from `digest()` have their property `position` set yet.
  25752. * @param mesh ( Mesh ) is the mesh to be digested
  25753. * @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
  25754. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  25755. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  25756. * @returns the current SPS
  25757. */
  25758. digest(mesh: Mesh, options?: {
  25759. facetNb?: number;
  25760. number?: number;
  25761. delta?: number;
  25762. }): SolidParticleSystem;
  25763. private _unrotateFixedNormals;
  25764. private _resetCopy;
  25765. private _meshBuilder;
  25766. private _posToShape;
  25767. private _uvsToShapeUV;
  25768. private _addParticle;
  25769. /**
  25770. * Adds some particles to the SPS from the model shape. Returns the shape id.
  25771. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  25772. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  25773. * @param nb (positive integer) the number of particles to be created from this model
  25774. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  25775. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  25776. * @returns the number of shapes in the system
  25777. */
  25778. addShape(mesh: Mesh, nb: number, options?: {
  25779. positionFunction?: any;
  25780. vertexFunction?: any;
  25781. }): number;
  25782. private _rebuildParticle;
  25783. /**
  25784. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  25785. * @returns the SPS.
  25786. */
  25787. rebuildMesh(): SolidParticleSystem;
  25788. /**
  25789. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  25790. * This method calls `updateParticle()` for each particle of the SPS.
  25791. * For an animated SPS, it is usually called within the render loop.
  25792. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  25793. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  25794. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  25795. * @returns the SPS.
  25796. */
  25797. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  25798. /**
  25799. * Disposes the SPS.
  25800. */
  25801. dispose(): void;
  25802. /**
  25803. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  25804. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25805. * @returns the SPS.
  25806. */
  25807. refreshVisibleSize(): SolidParticleSystem;
  25808. /**
  25809. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  25810. * @param size the size (float) of the visibility box
  25811. * note : this doesn't lock the SPS mesh bounding box.
  25812. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25813. */
  25814. setVisibilityBox(size: number): void;
  25815. /**
  25816. * Gets whether the SPS as always visible or not
  25817. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25818. */
  25819. /**
  25820. * Sets the SPS as always visible or not
  25821. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25822. */
  25823. isAlwaysVisible: boolean;
  25824. /**
  25825. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  25826. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25827. */
  25828. /**
  25829. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  25830. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  25831. */
  25832. isVisibilityBoxLocked: boolean;
  25833. /**
  25834. * Tells to `setParticles()` to compute the particle rotations or not.
  25835. * Default value : true. The SPS is faster when it's set to false.
  25836. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  25837. */
  25838. /**
  25839. * Gets if `setParticles()` computes the particle rotations or not.
  25840. * Default value : true. The SPS is faster when it's set to false.
  25841. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  25842. */
  25843. computeParticleRotation: boolean;
  25844. /**
  25845. * Tells to `setParticles()` to compute the particle colors or not.
  25846. * Default value : true. The SPS is faster when it's set to false.
  25847. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  25848. */
  25849. /**
  25850. * Gets if `setParticles()` computes the particle colors or not.
  25851. * Default value : true. The SPS is faster when it's set to false.
  25852. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  25853. */
  25854. computeParticleColor: boolean;
  25855. /**
  25856. * Gets if `setParticles()` computes the particle textures or not.
  25857. * Default value : true. The SPS is faster when it's set to false.
  25858. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  25859. */
  25860. computeParticleTexture: boolean;
  25861. /**
  25862. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  25863. * Default value : false. The SPS is faster when it's set to false.
  25864. * Note : the particle custom vertex positions aren't stored values.
  25865. */
  25866. /**
  25867. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  25868. * Default value : false. The SPS is faster when it's set to false.
  25869. * Note : the particle custom vertex positions aren't stored values.
  25870. */
  25871. computeParticleVertex: boolean;
  25872. /**
  25873. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  25874. */
  25875. /**
  25876. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  25877. */
  25878. computeBoundingBox: boolean;
  25879. /**
  25880. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  25881. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  25882. * Default : `true`
  25883. */
  25884. /**
  25885. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  25886. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  25887. * Default : `true`
  25888. */
  25889. depthSortParticles: boolean;
  25890. /**
  25891. * This function does nothing. It may be overwritten to set all the particle first values.
  25892. * The SPS doesn't call this function, you may have to call it by your own.
  25893. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  25894. */
  25895. initParticles(): void;
  25896. /**
  25897. * This function does nothing. It may be overwritten to recycle a particle.
  25898. * The SPS doesn't call this function, you may have to call it by your own.
  25899. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  25900. * @param particle The particle to recycle
  25901. * @returns the recycled particle
  25902. */
  25903. recycleParticle(particle: SolidParticle): SolidParticle;
  25904. /**
  25905. * Updates a particle : this function should be overwritten by the user.
  25906. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  25907. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  25908. * @example : just set a particle position or velocity and recycle conditions
  25909. * @param particle The particle to update
  25910. * @returns the updated particle
  25911. */
  25912. updateParticle(particle: SolidParticle): SolidParticle;
  25913. /**
  25914. * Updates a vertex of a particle : it can be overwritten by the user.
  25915. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  25916. * @param particle the current particle
  25917. * @param vertex the current index of the current particle
  25918. * @param pt the index of the current vertex in the particle shape
  25919. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  25920. * @example : just set a vertex particle position
  25921. * @returns the updated vertex
  25922. */
  25923. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  25924. /**
  25925. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  25926. * This does nothing and may be overwritten by the user.
  25927. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  25928. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  25929. * @param update the boolean update value actually passed to setParticles()
  25930. */
  25931. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  25932. /**
  25933. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  25934. * This will be passed three parameters.
  25935. * This does nothing and may be overwritten by the user.
  25936. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  25937. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  25938. * @param update the boolean update value actually passed to setParticles()
  25939. */
  25940. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  25941. }
  25942. }
  25943. declare module "babylonjs/Particles/solidParticle" {
  25944. import { Nullable } from "babylonjs/types";
  25945. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  25946. import { Color4 } from "babylonjs/Maths/math.color";
  25947. import { Mesh } from "babylonjs/Meshes/mesh";
  25948. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  25949. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  25950. import { Plane } from "babylonjs/Maths/math.plane";
  25951. /**
  25952. * Represents one particle of a solid particle system.
  25953. */
  25954. export class SolidParticle {
  25955. /**
  25956. * particle global index
  25957. */
  25958. idx: number;
  25959. /**
  25960. * The color of the particle
  25961. */
  25962. color: Nullable<Color4>;
  25963. /**
  25964. * The world space position of the particle.
  25965. */
  25966. position: Vector3;
  25967. /**
  25968. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  25969. */
  25970. rotation: Vector3;
  25971. /**
  25972. * The world space rotation quaternion of the particle.
  25973. */
  25974. rotationQuaternion: Nullable<Quaternion>;
  25975. /**
  25976. * The scaling of the particle.
  25977. */
  25978. scaling: Vector3;
  25979. /**
  25980. * The uvs of the particle.
  25981. */
  25982. uvs: Vector4;
  25983. /**
  25984. * The current speed of the particle.
  25985. */
  25986. velocity: Vector3;
  25987. /**
  25988. * The pivot point in the particle local space.
  25989. */
  25990. pivot: Vector3;
  25991. /**
  25992. * Must the particle be translated from its pivot point in its local space ?
  25993. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  25994. * Default : false
  25995. */
  25996. translateFromPivot: boolean;
  25997. /**
  25998. * Is the particle active or not ?
  25999. */
  26000. alive: boolean;
  26001. /**
  26002. * Is the particle visible or not ?
  26003. */
  26004. isVisible: boolean;
  26005. /**
  26006. * Index of this particle in the global "positions" array (Internal use)
  26007. * @hidden
  26008. */
  26009. _pos: number;
  26010. /**
  26011. * @hidden Index of this particle in the global "indices" array (Internal use)
  26012. */
  26013. _ind: number;
  26014. /**
  26015. * @hidden ModelShape of this particle (Internal use)
  26016. */
  26017. _model: ModelShape;
  26018. /**
  26019. * ModelShape id of this particle
  26020. */
  26021. shapeId: number;
  26022. /**
  26023. * Index of the particle in its shape id (Internal use)
  26024. */
  26025. idxInShape: number;
  26026. /**
  26027. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26028. */
  26029. _modelBoundingInfo: BoundingInfo;
  26030. /**
  26031. * @hidden Particle BoundingInfo object (Internal use)
  26032. */
  26033. _boundingInfo: BoundingInfo;
  26034. /**
  26035. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26036. */
  26037. _sps: SolidParticleSystem;
  26038. /**
  26039. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26040. */
  26041. _stillInvisible: boolean;
  26042. /**
  26043. * @hidden Last computed particle rotation matrix
  26044. */
  26045. _rotationMatrix: number[];
  26046. /**
  26047. * Parent particle Id, if any.
  26048. * Default null.
  26049. */
  26050. parentId: Nullable<number>;
  26051. /**
  26052. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26053. * The possible values are :
  26054. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26055. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26056. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26057. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26058. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26059. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26060. * */
  26061. cullingStrategy: number;
  26062. /**
  26063. * @hidden Internal global position in the SPS.
  26064. */
  26065. _globalPosition: Vector3;
  26066. /**
  26067. * Creates a Solid Particle object.
  26068. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26069. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  26070. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26071. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26072. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26073. * @param shapeId (integer) is the model shape identifier in the SPS.
  26074. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26075. * @param sps defines the sps it is associated to
  26076. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26077. */
  26078. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26079. /**
  26080. * Legacy support, changed scale to scaling
  26081. */
  26082. /**
  26083. * Legacy support, changed scale to scaling
  26084. */
  26085. scale: Vector3;
  26086. /**
  26087. * Legacy support, changed quaternion to rotationQuaternion
  26088. */
  26089. /**
  26090. * Legacy support, changed quaternion to rotationQuaternion
  26091. */
  26092. quaternion: Nullable<Quaternion>;
  26093. /**
  26094. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26095. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26096. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26097. * @returns true if it intersects
  26098. */
  26099. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26100. /**
  26101. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26102. * A particle is in the frustum if its bounding box intersects the frustum
  26103. * @param frustumPlanes defines the frustum to test
  26104. * @returns true if the particle is in the frustum planes
  26105. */
  26106. isInFrustum(frustumPlanes: Plane[]): boolean;
  26107. /**
  26108. * get the rotation matrix of the particle
  26109. * @hidden
  26110. */
  26111. getRotationMatrix(m: Matrix): void;
  26112. }
  26113. /**
  26114. * Represents the shape of the model used by one particle of a solid particle system.
  26115. * SPS internal tool, don't use it manually.
  26116. */
  26117. export class ModelShape {
  26118. /**
  26119. * The shape id
  26120. * @hidden
  26121. */
  26122. shapeID: number;
  26123. /**
  26124. * flat array of model positions (internal use)
  26125. * @hidden
  26126. */
  26127. _shape: Vector3[];
  26128. /**
  26129. * flat array of model UVs (internal use)
  26130. * @hidden
  26131. */
  26132. _shapeUV: number[];
  26133. /**
  26134. * length of the shape in the model indices array (internal use)
  26135. * @hidden
  26136. */
  26137. _indicesLength: number;
  26138. /**
  26139. * Custom position function (internal use)
  26140. * @hidden
  26141. */
  26142. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26143. /**
  26144. * Custom vertex function (internal use)
  26145. * @hidden
  26146. */
  26147. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26148. /**
  26149. * 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.
  26150. * SPS internal tool, don't use it manually.
  26151. * @hidden
  26152. */
  26153. constructor(id: number, shape: Vector3[], indicesLength: number, shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  26154. }
  26155. /**
  26156. * Represents a Depth Sorted Particle in the solid particle system.
  26157. */
  26158. export class DepthSortedParticle {
  26159. /**
  26160. * Index of the particle in the "indices" array
  26161. */
  26162. ind: number;
  26163. /**
  26164. * Length of the particle shape in the "indices" array
  26165. */
  26166. indicesLength: number;
  26167. /**
  26168. * Squared distance from the particle to the camera
  26169. */
  26170. sqDistance: number;
  26171. }
  26172. }
  26173. declare module "babylonjs/Collisions/meshCollisionData" {
  26174. import { Collider } from "babylonjs/Collisions/collider";
  26175. import { Vector3 } from "babylonjs/Maths/math.vector";
  26176. import { Nullable } from "babylonjs/types";
  26177. import { Observer } from "babylonjs/Misc/observable";
  26178. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26179. /**
  26180. * @hidden
  26181. */
  26182. export class _MeshCollisionData {
  26183. _checkCollisions: boolean;
  26184. _collisionMask: number;
  26185. _collisionGroup: number;
  26186. _collider: Nullable<Collider>;
  26187. _oldPositionForCollisions: Vector3;
  26188. _diffPositionForCollisions: Vector3;
  26189. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26190. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26191. }
  26192. }
  26193. declare module "babylonjs/Meshes/abstractMesh" {
  26194. import { Observable } from "babylonjs/Misc/observable";
  26195. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26196. import { Camera } from "babylonjs/Cameras/camera";
  26197. import { Scene, IDisposable } from "babylonjs/scene";
  26198. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26199. import { Node } from "babylonjs/node";
  26200. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26201. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26202. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26203. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26204. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26205. import { Material } from "babylonjs/Materials/material";
  26206. import { Light } from "babylonjs/Lights/light";
  26207. import { Skeleton } from "babylonjs/Bones/skeleton";
  26208. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26209. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26210. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26211. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26212. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26213. import { Plane } from "babylonjs/Maths/math.plane";
  26214. import { Ray } from "babylonjs/Culling/ray";
  26215. import { Collider } from "babylonjs/Collisions/collider";
  26216. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26217. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26218. /** @hidden */
  26219. class _FacetDataStorage {
  26220. facetPositions: Vector3[];
  26221. facetNormals: Vector3[];
  26222. facetPartitioning: number[][];
  26223. facetNb: number;
  26224. partitioningSubdivisions: number;
  26225. partitioningBBoxRatio: number;
  26226. facetDataEnabled: boolean;
  26227. facetParameters: any;
  26228. bbSize: Vector3;
  26229. subDiv: {
  26230. max: number;
  26231. X: number;
  26232. Y: number;
  26233. Z: number;
  26234. };
  26235. facetDepthSort: boolean;
  26236. facetDepthSortEnabled: boolean;
  26237. depthSortedIndices: IndicesArray;
  26238. depthSortedFacets: {
  26239. ind: number;
  26240. sqDistance: number;
  26241. }[];
  26242. facetDepthSortFunction: (f1: {
  26243. ind: number;
  26244. sqDistance: number;
  26245. }, f2: {
  26246. ind: number;
  26247. sqDistance: number;
  26248. }) => number;
  26249. facetDepthSortFrom: Vector3;
  26250. facetDepthSortOrigin: Vector3;
  26251. invertedMatrix: Matrix;
  26252. }
  26253. /**
  26254. * @hidden
  26255. **/
  26256. class _InternalAbstractMeshDataInfo {
  26257. _hasVertexAlpha: boolean;
  26258. _useVertexColors: boolean;
  26259. _numBoneInfluencers: number;
  26260. _applyFog: boolean;
  26261. _receiveShadows: boolean;
  26262. _facetData: _FacetDataStorage;
  26263. _visibility: number;
  26264. _skeleton: Nullable<Skeleton>;
  26265. _layerMask: number;
  26266. _computeBonesUsingShaders: boolean;
  26267. _isActive: boolean;
  26268. _onlyForInstances: boolean;
  26269. _isActiveIntermediate: boolean;
  26270. _onlyForInstancesIntermediate: boolean;
  26271. }
  26272. /**
  26273. * Class used to store all common mesh properties
  26274. */
  26275. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  26276. /** No occlusion */
  26277. static OCCLUSION_TYPE_NONE: number;
  26278. /** Occlusion set to optimisitic */
  26279. static OCCLUSION_TYPE_OPTIMISTIC: number;
  26280. /** Occlusion set to strict */
  26281. static OCCLUSION_TYPE_STRICT: number;
  26282. /** Use an accurante occlusion algorithm */
  26283. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  26284. /** Use a conservative occlusion algorithm */
  26285. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  26286. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  26287. * Test order :
  26288. * Is the bounding sphere outside the frustum ?
  26289. * If not, are the bounding box vertices outside the frustum ?
  26290. * It not, then the cullable object is in the frustum.
  26291. */
  26292. static readonly CULLINGSTRATEGY_STANDARD: number;
  26293. /** Culling strategy : Bounding Sphere Only.
  26294. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  26295. * It's also less accurate than the standard because some not visible objects can still be selected.
  26296. * Test : is the bounding sphere outside the frustum ?
  26297. * If not, then the cullable object is in the frustum.
  26298. */
  26299. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  26300. /** Culling strategy : Optimistic Inclusion.
  26301. * This in an inclusion test first, then the standard exclusion test.
  26302. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  26303. * 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.
  26304. * Anyway, it's as accurate as the standard strategy.
  26305. * Test :
  26306. * Is the cullable object bounding sphere center in the frustum ?
  26307. * If not, apply the default culling strategy.
  26308. */
  26309. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  26310. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  26311. * This in an inclusion test first, then the bounding sphere only exclusion test.
  26312. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  26313. * 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.
  26314. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  26315. * Test :
  26316. * Is the cullable object bounding sphere center in the frustum ?
  26317. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  26318. */
  26319. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  26320. /**
  26321. * No billboard
  26322. */
  26323. static readonly BILLBOARDMODE_NONE: number;
  26324. /** Billboard on X axis */
  26325. static readonly BILLBOARDMODE_X: number;
  26326. /** Billboard on Y axis */
  26327. static readonly BILLBOARDMODE_Y: number;
  26328. /** Billboard on Z axis */
  26329. static readonly BILLBOARDMODE_Z: number;
  26330. /** Billboard on all axes */
  26331. static readonly BILLBOARDMODE_ALL: number;
  26332. /** Billboard on using position instead of orientation */
  26333. static readonly BILLBOARDMODE_USE_POSITION: number;
  26334. /** @hidden */
  26335. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  26336. /**
  26337. * The culling strategy to use to check whether the mesh must be rendered or not.
  26338. * This value can be changed at any time and will be used on the next render mesh selection.
  26339. * The possible values are :
  26340. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26341. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26342. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26343. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26344. * Please read each static variable documentation to get details about the culling process.
  26345. * */
  26346. cullingStrategy: number;
  26347. /**
  26348. * Gets the number of facets in the mesh
  26349. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26350. */
  26351. readonly facetNb: number;
  26352. /**
  26353. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  26354. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26355. */
  26356. partitioningSubdivisions: number;
  26357. /**
  26358. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  26359. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  26360. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26361. */
  26362. partitioningBBoxRatio: number;
  26363. /**
  26364. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  26365. * Works only for updatable meshes.
  26366. * Doesn't work with multi-materials
  26367. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26368. */
  26369. mustDepthSortFacets: boolean;
  26370. /**
  26371. * The location (Vector3) where the facet depth sort must be computed from.
  26372. * By default, the active camera position.
  26373. * Used only when facet depth sort is enabled
  26374. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26375. */
  26376. facetDepthSortFrom: Vector3;
  26377. /**
  26378. * gets a boolean indicating if facetData is enabled
  26379. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26380. */
  26381. readonly isFacetDataEnabled: boolean;
  26382. /** @hidden */
  26383. _updateNonUniformScalingState(value: boolean): boolean;
  26384. /**
  26385. * An event triggered when this mesh collides with another one
  26386. */
  26387. onCollideObservable: Observable<AbstractMesh>;
  26388. /** Set a function to call when this mesh collides with another one */
  26389. onCollide: () => void;
  26390. /**
  26391. * An event triggered when the collision's position changes
  26392. */
  26393. onCollisionPositionChangeObservable: Observable<Vector3>;
  26394. /** Set a function to call when the collision's position changes */
  26395. onCollisionPositionChange: () => void;
  26396. /**
  26397. * An event triggered when material is changed
  26398. */
  26399. onMaterialChangedObservable: Observable<AbstractMesh>;
  26400. /**
  26401. * Gets or sets the orientation for POV movement & rotation
  26402. */
  26403. definedFacingForward: boolean;
  26404. /** @hidden */
  26405. _occlusionQuery: Nullable<WebGLQuery>;
  26406. /** @hidden */
  26407. _renderingGroup: Nullable<RenderingGroup>;
  26408. /**
  26409. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26410. */
  26411. /**
  26412. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26413. */
  26414. visibility: number;
  26415. /** Gets or sets the alpha index used to sort transparent meshes
  26416. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  26417. */
  26418. alphaIndex: number;
  26419. /**
  26420. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  26421. */
  26422. isVisible: boolean;
  26423. /**
  26424. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  26425. */
  26426. isPickable: boolean;
  26427. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  26428. showSubMeshesBoundingBox: boolean;
  26429. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  26430. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  26431. */
  26432. isBlocker: boolean;
  26433. /**
  26434. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  26435. */
  26436. enablePointerMoveEvents: boolean;
  26437. /**
  26438. * Specifies the rendering group id for this mesh (0 by default)
  26439. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  26440. */
  26441. renderingGroupId: number;
  26442. private _material;
  26443. /** Gets or sets current material */
  26444. material: Nullable<Material>;
  26445. /**
  26446. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  26447. * @see http://doc.babylonjs.com/babylon101/shadows
  26448. */
  26449. receiveShadows: boolean;
  26450. /** Defines color to use when rendering outline */
  26451. outlineColor: Color3;
  26452. /** Define width to use when rendering outline */
  26453. outlineWidth: number;
  26454. /** Defines color to use when rendering overlay */
  26455. overlayColor: Color3;
  26456. /** Defines alpha to use when rendering overlay */
  26457. overlayAlpha: number;
  26458. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  26459. hasVertexAlpha: boolean;
  26460. /** 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) */
  26461. useVertexColors: boolean;
  26462. /**
  26463. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  26464. */
  26465. computeBonesUsingShaders: boolean;
  26466. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  26467. numBoneInfluencers: number;
  26468. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  26469. applyFog: boolean;
  26470. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  26471. useOctreeForRenderingSelection: boolean;
  26472. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  26473. useOctreeForPicking: boolean;
  26474. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  26475. useOctreeForCollisions: boolean;
  26476. /**
  26477. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  26478. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  26479. */
  26480. layerMask: number;
  26481. /**
  26482. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  26483. */
  26484. alwaysSelectAsActiveMesh: boolean;
  26485. /**
  26486. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  26487. */
  26488. doNotSyncBoundingInfo: boolean;
  26489. /**
  26490. * Gets or sets the current action manager
  26491. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  26492. */
  26493. actionManager: Nullable<AbstractActionManager>;
  26494. private _meshCollisionData;
  26495. /**
  26496. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  26497. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26498. */
  26499. ellipsoid: Vector3;
  26500. /**
  26501. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  26502. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26503. */
  26504. ellipsoidOffset: Vector3;
  26505. /**
  26506. * Gets or sets a collision mask used to mask collisions (default is -1).
  26507. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26508. */
  26509. collisionMask: number;
  26510. /**
  26511. * Gets or sets the current collision group mask (-1 by default).
  26512. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26513. */
  26514. collisionGroup: number;
  26515. /**
  26516. * Defines edge width used when edgesRenderer is enabled
  26517. * @see https://www.babylonjs-playground.com/#10OJSG#13
  26518. */
  26519. edgesWidth: number;
  26520. /**
  26521. * Defines edge color used when edgesRenderer is enabled
  26522. * @see https://www.babylonjs-playground.com/#10OJSG#13
  26523. */
  26524. edgesColor: Color4;
  26525. /** @hidden */
  26526. _edgesRenderer: Nullable<IEdgesRenderer>;
  26527. /** @hidden */
  26528. _masterMesh: Nullable<AbstractMesh>;
  26529. /** @hidden */
  26530. _boundingInfo: Nullable<BoundingInfo>;
  26531. /** @hidden */
  26532. _renderId: number;
  26533. /**
  26534. * Gets or sets the list of subMeshes
  26535. * @see http://doc.babylonjs.com/how_to/multi_materials
  26536. */
  26537. subMeshes: SubMesh[];
  26538. /** @hidden */
  26539. _intersectionsInProgress: AbstractMesh[];
  26540. /** @hidden */
  26541. _unIndexed: boolean;
  26542. /** @hidden */
  26543. _lightSources: Light[];
  26544. /** Gets the list of lights affecting that mesh */
  26545. readonly lightSources: Light[];
  26546. /** @hidden */
  26547. readonly _positions: Nullable<Vector3[]>;
  26548. /** @hidden */
  26549. _waitingData: {
  26550. lods: Nullable<any>;
  26551. actions: Nullable<any>;
  26552. freezeWorldMatrix: Nullable<boolean>;
  26553. };
  26554. /** @hidden */
  26555. _bonesTransformMatrices: Nullable<Float32Array>;
  26556. /** @hidden */
  26557. _transformMatrixTexture: Nullable<RawTexture>;
  26558. /**
  26559. * Gets or sets a skeleton to apply skining transformations
  26560. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  26561. */
  26562. skeleton: Nullable<Skeleton>;
  26563. /**
  26564. * An event triggered when the mesh is rebuilt.
  26565. */
  26566. onRebuildObservable: Observable<AbstractMesh>;
  26567. /**
  26568. * Creates a new AbstractMesh
  26569. * @param name defines the name of the mesh
  26570. * @param scene defines the hosting scene
  26571. */
  26572. constructor(name: string, scene?: Nullable<Scene>);
  26573. /**
  26574. * Returns the string "AbstractMesh"
  26575. * @returns "AbstractMesh"
  26576. */
  26577. getClassName(): string;
  26578. /**
  26579. * Gets a string representation of the current mesh
  26580. * @param fullDetails defines a boolean indicating if full details must be included
  26581. * @returns a string representation of the current mesh
  26582. */
  26583. toString(fullDetails?: boolean): string;
  26584. /**
  26585. * @hidden
  26586. */
  26587. protected _getEffectiveParent(): Nullable<Node>;
  26588. /** @hidden */
  26589. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  26590. /** @hidden */
  26591. _rebuild(): void;
  26592. /** @hidden */
  26593. _resyncLightSources(): void;
  26594. /** @hidden */
  26595. _resyncLighSource(light: Light): void;
  26596. /** @hidden */
  26597. _unBindEffect(): void;
  26598. /** @hidden */
  26599. _removeLightSource(light: Light): void;
  26600. private _markSubMeshesAsDirty;
  26601. /** @hidden */
  26602. _markSubMeshesAsLightDirty(): void;
  26603. /** @hidden */
  26604. _markSubMeshesAsAttributesDirty(): void;
  26605. /** @hidden */
  26606. _markSubMeshesAsMiscDirty(): void;
  26607. /**
  26608. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  26609. */
  26610. scaling: Vector3;
  26611. /**
  26612. * Returns true if the mesh is blocked. Implemented by child classes
  26613. */
  26614. readonly isBlocked: boolean;
  26615. /**
  26616. * Returns the mesh itself by default. Implemented by child classes
  26617. * @param camera defines the camera to use to pick the right LOD level
  26618. * @returns the currentAbstractMesh
  26619. */
  26620. getLOD(camera: Camera): Nullable<AbstractMesh>;
  26621. /**
  26622. * Returns 0 by default. Implemented by child classes
  26623. * @returns an integer
  26624. */
  26625. getTotalVertices(): number;
  26626. /**
  26627. * Returns a positive integer : the total number of indices in this mesh geometry.
  26628. * @returns the numner of indices or zero if the mesh has no geometry.
  26629. */
  26630. getTotalIndices(): number;
  26631. /**
  26632. * Returns null by default. Implemented by child classes
  26633. * @returns null
  26634. */
  26635. getIndices(): Nullable<IndicesArray>;
  26636. /**
  26637. * Returns the array of the requested vertex data kind. Implemented by child classes
  26638. * @param kind defines the vertex data kind to use
  26639. * @returns null
  26640. */
  26641. getVerticesData(kind: string): Nullable<FloatArray>;
  26642. /**
  26643. * Sets the vertex data of the mesh geometry for the requested `kind`.
  26644. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  26645. * Note that a new underlying VertexBuffer object is created each call.
  26646. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  26647. * @param kind defines vertex data kind:
  26648. * * VertexBuffer.PositionKind
  26649. * * VertexBuffer.UVKind
  26650. * * VertexBuffer.UV2Kind
  26651. * * VertexBuffer.UV3Kind
  26652. * * VertexBuffer.UV4Kind
  26653. * * VertexBuffer.UV5Kind
  26654. * * VertexBuffer.UV6Kind
  26655. * * VertexBuffer.ColorKind
  26656. * * VertexBuffer.MatricesIndicesKind
  26657. * * VertexBuffer.MatricesIndicesExtraKind
  26658. * * VertexBuffer.MatricesWeightsKind
  26659. * * VertexBuffer.MatricesWeightsExtraKind
  26660. * @param data defines the data source
  26661. * @param updatable defines if the data must be flagged as updatable (or static)
  26662. * @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
  26663. * @returns the current mesh
  26664. */
  26665. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  26666. /**
  26667. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  26668. * If the mesh has no geometry, it is simply returned as it is.
  26669. * @param kind defines vertex data kind:
  26670. * * VertexBuffer.PositionKind
  26671. * * VertexBuffer.UVKind
  26672. * * VertexBuffer.UV2Kind
  26673. * * VertexBuffer.UV3Kind
  26674. * * VertexBuffer.UV4Kind
  26675. * * VertexBuffer.UV5Kind
  26676. * * VertexBuffer.UV6Kind
  26677. * * VertexBuffer.ColorKind
  26678. * * VertexBuffer.MatricesIndicesKind
  26679. * * VertexBuffer.MatricesIndicesExtraKind
  26680. * * VertexBuffer.MatricesWeightsKind
  26681. * * VertexBuffer.MatricesWeightsExtraKind
  26682. * @param data defines the data source
  26683. * @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
  26684. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  26685. * @returns the current mesh
  26686. */
  26687. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  26688. /**
  26689. * Sets the mesh indices,
  26690. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  26691. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  26692. * @param totalVertices Defines the total number of vertices
  26693. * @returns the current mesh
  26694. */
  26695. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  26696. /**
  26697. * Gets a boolean indicating if specific vertex data is present
  26698. * @param kind defines the vertex data kind to use
  26699. * @returns true is data kind is present
  26700. */
  26701. isVerticesDataPresent(kind: string): boolean;
  26702. /**
  26703. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  26704. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  26705. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  26706. * @returns a BoundingInfo
  26707. */
  26708. getBoundingInfo(): BoundingInfo;
  26709. /**
  26710. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  26711. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  26712. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  26713. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  26714. * @returns the current mesh
  26715. */
  26716. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  26717. /**
  26718. * Overwrite the current bounding info
  26719. * @param boundingInfo defines the new bounding info
  26720. * @returns the current mesh
  26721. */
  26722. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  26723. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  26724. readonly useBones: boolean;
  26725. /** @hidden */
  26726. _preActivate(): void;
  26727. /** @hidden */
  26728. _preActivateForIntermediateRendering(renderId: number): void;
  26729. /** @hidden */
  26730. _activate(renderId: number, intermediateRendering: boolean): boolean;
  26731. /** @hidden */
  26732. _postActivate(): void;
  26733. /** @hidden */
  26734. _freeze(): void;
  26735. /** @hidden */
  26736. _unFreeze(): void;
  26737. /**
  26738. * Gets the current world matrix
  26739. * @returns a Matrix
  26740. */
  26741. getWorldMatrix(): Matrix;
  26742. /** @hidden */
  26743. _getWorldMatrixDeterminant(): number;
  26744. /**
  26745. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  26746. */
  26747. readonly isAnInstance: boolean;
  26748. /**
  26749. * Perform relative position change from the point of view of behind the front of the mesh.
  26750. * This is performed taking into account the meshes current rotation, so you do not have to care.
  26751. * Supports definition of mesh facing forward or backward
  26752. * @param amountRight defines the distance on the right axis
  26753. * @param amountUp defines the distance on the up axis
  26754. * @param amountForward defines the distance on the forward axis
  26755. * @returns the current mesh
  26756. */
  26757. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  26758. /**
  26759. * Calculate relative position change from the point of view of behind the front of the mesh.
  26760. * This is performed taking into account the meshes current rotation, so you do not have to care.
  26761. * Supports definition of mesh facing forward or backward
  26762. * @param amountRight defines the distance on the right axis
  26763. * @param amountUp defines the distance on the up axis
  26764. * @param amountForward defines the distance on the forward axis
  26765. * @returns the new displacement vector
  26766. */
  26767. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  26768. /**
  26769. * Perform relative rotation change from the point of view of behind the front of the mesh.
  26770. * Supports definition of mesh facing forward or backward
  26771. * @param flipBack defines the flip
  26772. * @param twirlClockwise defines the twirl
  26773. * @param tiltRight defines the tilt
  26774. * @returns the current mesh
  26775. */
  26776. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  26777. /**
  26778. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  26779. * Supports definition of mesh facing forward or backward.
  26780. * @param flipBack defines the flip
  26781. * @param twirlClockwise defines the twirl
  26782. * @param tiltRight defines the tilt
  26783. * @returns the new rotation vector
  26784. */
  26785. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  26786. /**
  26787. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  26788. * This means the mesh underlying bounding box and sphere are recomputed.
  26789. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  26790. * @returns the current mesh
  26791. */
  26792. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  26793. /** @hidden */
  26794. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  26795. /** @hidden */
  26796. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  26797. /** @hidden */
  26798. _updateBoundingInfo(): AbstractMesh;
  26799. /** @hidden */
  26800. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  26801. /** @hidden */
  26802. protected _afterComputeWorldMatrix(): void;
  26803. /** @hidden */
  26804. readonly _effectiveMesh: AbstractMesh;
  26805. /**
  26806. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  26807. * A mesh is in the frustum if its bounding box intersects the frustum
  26808. * @param frustumPlanes defines the frustum to test
  26809. * @returns true if the mesh is in the frustum planes
  26810. */
  26811. isInFrustum(frustumPlanes: Plane[]): boolean;
  26812. /**
  26813. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  26814. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  26815. * @param frustumPlanes defines the frustum to test
  26816. * @returns true if the mesh is completely in the frustum planes
  26817. */
  26818. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26819. /**
  26820. * True if the mesh intersects another mesh or a SolidParticle object
  26821. * @param mesh defines a target mesh or SolidParticle to test
  26822. * @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)
  26823. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  26824. * @returns true if there is an intersection
  26825. */
  26826. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  26827. /**
  26828. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  26829. * @param point defines the point to test
  26830. * @returns true if there is an intersection
  26831. */
  26832. intersectsPoint(point: Vector3): boolean;
  26833. /**
  26834. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  26835. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26836. */
  26837. checkCollisions: boolean;
  26838. /**
  26839. * Gets Collider object used to compute collisions (not physics)
  26840. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26841. */
  26842. readonly collider: Nullable<Collider>;
  26843. /**
  26844. * Move the mesh using collision engine
  26845. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26846. * @param displacement defines the requested displacement vector
  26847. * @returns the current mesh
  26848. */
  26849. moveWithCollisions(displacement: Vector3): AbstractMesh;
  26850. private _onCollisionPositionChange;
  26851. /** @hidden */
  26852. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  26853. /** @hidden */
  26854. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  26855. /** @hidden */
  26856. _checkCollision(collider: Collider): AbstractMesh;
  26857. /** @hidden */
  26858. _generatePointsArray(): boolean;
  26859. /**
  26860. * Checks if the passed Ray intersects with the mesh
  26861. * @param ray defines the ray to use
  26862. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  26863. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26864. * @returns the picking info
  26865. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  26866. */
  26867. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  26868. /**
  26869. * Clones the current mesh
  26870. * @param name defines the mesh name
  26871. * @param newParent defines the new mesh parent
  26872. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  26873. * @returns the new mesh
  26874. */
  26875. clone(name: string, newParent: Node, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  26876. /**
  26877. * Disposes all the submeshes of the current meshnp
  26878. * @returns the current mesh
  26879. */
  26880. releaseSubMeshes(): AbstractMesh;
  26881. /**
  26882. * Releases resources associated with this abstract mesh.
  26883. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  26884. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  26885. */
  26886. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  26887. /**
  26888. * Adds the passed mesh as a child to the current mesh
  26889. * @param mesh defines the child mesh
  26890. * @returns the current mesh
  26891. */
  26892. addChild(mesh: AbstractMesh): AbstractMesh;
  26893. /**
  26894. * Removes the passed mesh from the current mesh children list
  26895. * @param mesh defines the child mesh
  26896. * @returns the current mesh
  26897. */
  26898. removeChild(mesh: AbstractMesh): AbstractMesh;
  26899. /** @hidden */
  26900. private _initFacetData;
  26901. /**
  26902. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  26903. * This method can be called within the render loop.
  26904. * 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
  26905. * @returns the current mesh
  26906. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26907. */
  26908. updateFacetData(): AbstractMesh;
  26909. /**
  26910. * Returns the facetLocalNormals array.
  26911. * The normals are expressed in the mesh local spac
  26912. * @returns an array of Vector3
  26913. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26914. */
  26915. getFacetLocalNormals(): Vector3[];
  26916. /**
  26917. * Returns the facetLocalPositions array.
  26918. * The facet positions are expressed in the mesh local space
  26919. * @returns an array of Vector3
  26920. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26921. */
  26922. getFacetLocalPositions(): Vector3[];
  26923. /**
  26924. * Returns the facetLocalPartioning array
  26925. * @returns an array of array of numbers
  26926. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26927. */
  26928. getFacetLocalPartitioning(): number[][];
  26929. /**
  26930. * Returns the i-th facet position in the world system.
  26931. * This method allocates a new Vector3 per call
  26932. * @param i defines the facet index
  26933. * @returns a new Vector3
  26934. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26935. */
  26936. getFacetPosition(i: number): Vector3;
  26937. /**
  26938. * Sets the reference Vector3 with the i-th facet position in the world system
  26939. * @param i defines the facet index
  26940. * @param ref defines the target vector
  26941. * @returns the current mesh
  26942. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26943. */
  26944. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  26945. /**
  26946. * Returns the i-th facet normal in the world system.
  26947. * This method allocates a new Vector3 per call
  26948. * @param i defines the facet index
  26949. * @returns a new Vector3
  26950. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26951. */
  26952. getFacetNormal(i: number): Vector3;
  26953. /**
  26954. * Sets the reference Vector3 with the i-th facet normal in the world system
  26955. * @param i defines the facet index
  26956. * @param ref defines the target vector
  26957. * @returns the current mesh
  26958. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26959. */
  26960. getFacetNormalToRef(i: number, ref: Vector3): this;
  26961. /**
  26962. * 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)
  26963. * @param x defines x coordinate
  26964. * @param y defines y coordinate
  26965. * @param z defines z coordinate
  26966. * @returns the array of facet indexes
  26967. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26968. */
  26969. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  26970. /**
  26971. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  26972. * @param projected sets as the (x,y,z) world projection on the facet
  26973. * @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
  26974. * @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
  26975. * @param x defines x coordinate
  26976. * @param y defines y coordinate
  26977. * @param z defines z coordinate
  26978. * @returns the face index if found (or null instead)
  26979. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26980. */
  26981. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  26982. /**
  26983. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  26984. * @param projected sets as the (x,y,z) local projection on the facet
  26985. * @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
  26986. * @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
  26987. * @param x defines x coordinate
  26988. * @param y defines y coordinate
  26989. * @param z defines z coordinate
  26990. * @returns the face index if found (or null instead)
  26991. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26992. */
  26993. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  26994. /**
  26995. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  26996. * @returns the parameters
  26997. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  26998. */
  26999. getFacetDataParameters(): any;
  27000. /**
  27001. * Disables the feature FacetData and frees the related memory
  27002. * @returns the current mesh
  27003. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27004. */
  27005. disableFacetData(): AbstractMesh;
  27006. /**
  27007. * Updates the AbstractMesh indices array
  27008. * @param indices defines the data source
  27009. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27010. * @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)
  27011. * @returns the current mesh
  27012. */
  27013. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27014. /**
  27015. * Creates new normals data for the mesh
  27016. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27017. * @returns the current mesh
  27018. */
  27019. createNormals(updatable: boolean): AbstractMesh;
  27020. /**
  27021. * Align the mesh with a normal
  27022. * @param normal defines the normal to use
  27023. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27024. * @returns the current mesh
  27025. */
  27026. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27027. /** @hidden */
  27028. _checkOcclusionQuery(): boolean;
  27029. /**
  27030. * Disables the mesh edge rendering mode
  27031. * @returns the currentAbstractMesh
  27032. */
  27033. disableEdgesRendering(): AbstractMesh;
  27034. /**
  27035. * Enables the edge rendering mode on the mesh.
  27036. * This mode makes the mesh edges visible
  27037. * @param epsilon defines the maximal distance between two angles to detect a face
  27038. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27039. * @returns the currentAbstractMesh
  27040. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27041. */
  27042. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27043. }
  27044. }
  27045. declare module "babylonjs/Actions/actionEvent" {
  27046. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27047. import { Nullable } from "babylonjs/types";
  27048. import { Sprite } from "babylonjs/Sprites/sprite";
  27049. import { Scene } from "babylonjs/scene";
  27050. import { Vector2 } from "babylonjs/Maths/math.vector";
  27051. /**
  27052. * Interface used to define ActionEvent
  27053. */
  27054. export interface IActionEvent {
  27055. /** The mesh or sprite that triggered the action */
  27056. source: any;
  27057. /** The X mouse cursor position at the time of the event */
  27058. pointerX: number;
  27059. /** The Y mouse cursor position at the time of the event */
  27060. pointerY: number;
  27061. /** The mesh that is currently pointed at (can be null) */
  27062. meshUnderPointer: Nullable<AbstractMesh>;
  27063. /** the original (browser) event that triggered the ActionEvent */
  27064. sourceEvent?: any;
  27065. /** additional data for the event */
  27066. additionalData?: any;
  27067. }
  27068. /**
  27069. * ActionEvent is the event being sent when an action is triggered.
  27070. */
  27071. export class ActionEvent implements IActionEvent {
  27072. /** The mesh or sprite that triggered the action */
  27073. source: any;
  27074. /** The X mouse cursor position at the time of the event */
  27075. pointerX: number;
  27076. /** The Y mouse cursor position at the time of the event */
  27077. pointerY: number;
  27078. /** The mesh that is currently pointed at (can be null) */
  27079. meshUnderPointer: Nullable<AbstractMesh>;
  27080. /** the original (browser) event that triggered the ActionEvent */
  27081. sourceEvent?: any;
  27082. /** additional data for the event */
  27083. additionalData?: any;
  27084. /**
  27085. * Creates a new ActionEvent
  27086. * @param source The mesh or sprite that triggered the action
  27087. * @param pointerX The X mouse cursor position at the time of the event
  27088. * @param pointerY The Y mouse cursor position at the time of the event
  27089. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27090. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27091. * @param additionalData additional data for the event
  27092. */
  27093. constructor(
  27094. /** The mesh or sprite that triggered the action */
  27095. source: any,
  27096. /** The X mouse cursor position at the time of the event */
  27097. pointerX: number,
  27098. /** The Y mouse cursor position at the time of the event */
  27099. pointerY: number,
  27100. /** The mesh that is currently pointed at (can be null) */
  27101. meshUnderPointer: Nullable<AbstractMesh>,
  27102. /** the original (browser) event that triggered the ActionEvent */
  27103. sourceEvent?: any,
  27104. /** additional data for the event */
  27105. additionalData?: any);
  27106. /**
  27107. * Helper function to auto-create an ActionEvent from a source mesh.
  27108. * @param source The source mesh that triggered the event
  27109. * @param evt The original (browser) event
  27110. * @param additionalData additional data for the event
  27111. * @returns the new ActionEvent
  27112. */
  27113. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27114. /**
  27115. * Helper function to auto-create an ActionEvent from a source sprite
  27116. * @param source The source sprite that triggered the event
  27117. * @param scene Scene associated with the sprite
  27118. * @param evt The original (browser) event
  27119. * @param additionalData additional data for the event
  27120. * @returns the new ActionEvent
  27121. */
  27122. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27123. /**
  27124. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27125. * @param scene the scene where the event occurred
  27126. * @param evt The original (browser) event
  27127. * @returns the new ActionEvent
  27128. */
  27129. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27130. /**
  27131. * Helper function to auto-create an ActionEvent from a primitive
  27132. * @param prim defines the target primitive
  27133. * @param pointerPos defines the pointer position
  27134. * @param evt The original (browser) event
  27135. * @param additionalData additional data for the event
  27136. * @returns the new ActionEvent
  27137. */
  27138. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27139. }
  27140. }
  27141. declare module "babylonjs/Actions/abstractActionManager" {
  27142. import { IDisposable } from "babylonjs/scene";
  27143. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27144. import { IAction } from "babylonjs/Actions/action";
  27145. import { Nullable } from "babylonjs/types";
  27146. /**
  27147. * Abstract class used to decouple action Manager from scene and meshes.
  27148. * Do not instantiate.
  27149. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27150. */
  27151. export abstract class AbstractActionManager implements IDisposable {
  27152. /** Gets the list of active triggers */
  27153. static Triggers: {
  27154. [key: string]: number;
  27155. };
  27156. /** Gets the cursor to use when hovering items */
  27157. hoverCursor: string;
  27158. /** Gets the list of actions */
  27159. actions: IAction[];
  27160. /**
  27161. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27162. */
  27163. isRecursive: boolean;
  27164. /**
  27165. * Releases all associated resources
  27166. */
  27167. abstract dispose(): void;
  27168. /**
  27169. * Does this action manager has pointer triggers
  27170. */
  27171. abstract readonly hasPointerTriggers: boolean;
  27172. /**
  27173. * Does this action manager has pick triggers
  27174. */
  27175. abstract readonly hasPickTriggers: boolean;
  27176. /**
  27177. * Process a specific trigger
  27178. * @param trigger defines the trigger to process
  27179. * @param evt defines the event details to be processed
  27180. */
  27181. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27182. /**
  27183. * Does this action manager handles actions of any of the given triggers
  27184. * @param triggers defines the triggers to be tested
  27185. * @return a boolean indicating whether one (or more) of the triggers is handled
  27186. */
  27187. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27188. /**
  27189. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27190. * speed.
  27191. * @param triggerA defines the trigger to be tested
  27192. * @param triggerB defines the trigger to be tested
  27193. * @return a boolean indicating whether one (or more) of the triggers is handled
  27194. */
  27195. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27196. /**
  27197. * Does this action manager handles actions of a given trigger
  27198. * @param trigger defines the trigger to be tested
  27199. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27200. * @return whether the trigger is handled
  27201. */
  27202. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27203. /**
  27204. * Serialize this manager to a JSON object
  27205. * @param name defines the property name to store this manager
  27206. * @returns a JSON representation of this manager
  27207. */
  27208. abstract serialize(name: string): any;
  27209. /**
  27210. * Registers an action to this action manager
  27211. * @param action defines the action to be registered
  27212. * @return the action amended (prepared) after registration
  27213. */
  27214. abstract registerAction(action: IAction): Nullable<IAction>;
  27215. /**
  27216. * Unregisters an action to this action manager
  27217. * @param action defines the action to be unregistered
  27218. * @return a boolean indicating whether the action has been unregistered
  27219. */
  27220. abstract unregisterAction(action: IAction): Boolean;
  27221. /**
  27222. * Does exist one action manager with at least one trigger
  27223. **/
  27224. static readonly HasTriggers: boolean;
  27225. /**
  27226. * Does exist one action manager with at least one pick trigger
  27227. **/
  27228. static readonly HasPickTriggers: boolean;
  27229. /**
  27230. * Does exist one action manager that handles actions of a given trigger
  27231. * @param trigger defines the trigger to be tested
  27232. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  27233. **/
  27234. static HasSpecificTrigger(trigger: number): boolean;
  27235. }
  27236. }
  27237. declare module "babylonjs/node" {
  27238. import { Scene } from "babylonjs/scene";
  27239. import { Nullable } from "babylonjs/types";
  27240. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  27241. import { Engine } from "babylonjs/Engines/engine";
  27242. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  27243. import { Observable } from "babylonjs/Misc/observable";
  27244. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  27245. import { IInspectable } from "babylonjs/Misc/iInspectable";
  27246. import { Animatable } from "babylonjs/Animations/animatable";
  27247. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27248. import { Animation } from "babylonjs/Animations/animation";
  27249. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27250. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27251. /**
  27252. * Defines how a node can be built from a string name.
  27253. */
  27254. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  27255. /**
  27256. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  27257. */
  27258. export class Node implements IBehaviorAware<Node> {
  27259. /** @hidden */
  27260. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  27261. private static _NodeConstructors;
  27262. /**
  27263. * Add a new node constructor
  27264. * @param type defines the type name of the node to construct
  27265. * @param constructorFunc defines the constructor function
  27266. */
  27267. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  27268. /**
  27269. * Returns a node constructor based on type name
  27270. * @param type defines the type name
  27271. * @param name defines the new node name
  27272. * @param scene defines the hosting scene
  27273. * @param options defines optional options to transmit to constructors
  27274. * @returns the new constructor or null
  27275. */
  27276. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  27277. /**
  27278. * Gets or sets the name of the node
  27279. */
  27280. name: string;
  27281. /**
  27282. * Gets or sets the id of the node
  27283. */
  27284. id: string;
  27285. /**
  27286. * Gets or sets the unique id of the node
  27287. */
  27288. uniqueId: number;
  27289. /**
  27290. * Gets or sets a string used to store user defined state for the node
  27291. */
  27292. state: string;
  27293. /**
  27294. * Gets or sets an object used to store user defined information for the node
  27295. */
  27296. metadata: any;
  27297. /**
  27298. * For internal use only. Please do not use.
  27299. */
  27300. reservedDataStore: any;
  27301. /**
  27302. * List of inspectable custom properties (used by the Inspector)
  27303. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  27304. */
  27305. inspectableCustomProperties: IInspectable[];
  27306. /**
  27307. * Gets or sets a boolean used to define if the node must be serialized
  27308. */
  27309. doNotSerialize: boolean;
  27310. /** @hidden */
  27311. _isDisposed: boolean;
  27312. /**
  27313. * Gets a list of Animations associated with the node
  27314. */
  27315. animations: import("babylonjs/Animations/animation").Animation[];
  27316. protected _ranges: {
  27317. [name: string]: Nullable<AnimationRange>;
  27318. };
  27319. /**
  27320. * Callback raised when the node is ready to be used
  27321. */
  27322. onReady: Nullable<(node: Node) => void>;
  27323. private _isEnabled;
  27324. private _isParentEnabled;
  27325. private _isReady;
  27326. /** @hidden */
  27327. _currentRenderId: number;
  27328. private _parentUpdateId;
  27329. /** @hidden */
  27330. _childUpdateId: number;
  27331. /** @hidden */
  27332. _waitingParentId: Nullable<string>;
  27333. /** @hidden */
  27334. _scene: Scene;
  27335. /** @hidden */
  27336. _cache: any;
  27337. private _parentNode;
  27338. private _children;
  27339. /** @hidden */
  27340. _worldMatrix: Matrix;
  27341. /** @hidden */
  27342. _worldMatrixDeterminant: number;
  27343. /** @hidden */
  27344. _worldMatrixDeterminantIsDirty: boolean;
  27345. /** @hidden */
  27346. private _sceneRootNodesIndex;
  27347. /**
  27348. * Gets a boolean indicating if the node has been disposed
  27349. * @returns true if the node was disposed
  27350. */
  27351. isDisposed(): boolean;
  27352. /**
  27353. * Gets or sets the parent of the node (without keeping the current position in the scene)
  27354. * @see https://doc.babylonjs.com/how_to/parenting
  27355. */
  27356. parent: Nullable<Node>;
  27357. private addToSceneRootNodes;
  27358. private removeFromSceneRootNodes;
  27359. private _animationPropertiesOverride;
  27360. /**
  27361. * Gets or sets the animation properties override
  27362. */
  27363. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  27364. /**
  27365. * Gets a string idenfifying the name of the class
  27366. * @returns "Node" string
  27367. */
  27368. getClassName(): string;
  27369. /** @hidden */
  27370. readonly _isNode: boolean;
  27371. /**
  27372. * An event triggered when the mesh is disposed
  27373. */
  27374. onDisposeObservable: Observable<Node>;
  27375. private _onDisposeObserver;
  27376. /**
  27377. * Sets a callback that will be raised when the node will be disposed
  27378. */
  27379. onDispose: () => void;
  27380. /**
  27381. * Creates a new Node
  27382. * @param name the name and id to be given to this node
  27383. * @param scene the scene this node will be added to
  27384. * @param addToRootNodes the node will be added to scene.rootNodes
  27385. */
  27386. constructor(name: string, scene?: Nullable<Scene>, addToRootNodes?: boolean);
  27387. /**
  27388. * Gets the scene of the node
  27389. * @returns a scene
  27390. */
  27391. getScene(): Scene;
  27392. /**
  27393. * Gets the engine of the node
  27394. * @returns a Engine
  27395. */
  27396. getEngine(): Engine;
  27397. private _behaviors;
  27398. /**
  27399. * Attach a behavior to the node
  27400. * @see http://doc.babylonjs.com/features/behaviour
  27401. * @param behavior defines the behavior to attach
  27402. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  27403. * @returns the current Node
  27404. */
  27405. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  27406. /**
  27407. * Remove an attached behavior
  27408. * @see http://doc.babylonjs.com/features/behaviour
  27409. * @param behavior defines the behavior to attach
  27410. * @returns the current Node
  27411. */
  27412. removeBehavior(behavior: Behavior<Node>): Node;
  27413. /**
  27414. * Gets the list of attached behaviors
  27415. * @see http://doc.babylonjs.com/features/behaviour
  27416. */
  27417. readonly behaviors: Behavior<Node>[];
  27418. /**
  27419. * Gets an attached behavior by name
  27420. * @param name defines the name of the behavior to look for
  27421. * @see http://doc.babylonjs.com/features/behaviour
  27422. * @returns null if behavior was not found else the requested behavior
  27423. */
  27424. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  27425. /**
  27426. * Returns the latest update of the World matrix
  27427. * @returns a Matrix
  27428. */
  27429. getWorldMatrix(): Matrix;
  27430. /** @hidden */
  27431. _getWorldMatrixDeterminant(): number;
  27432. /**
  27433. * Returns directly the latest state of the mesh World matrix.
  27434. * A Matrix is returned.
  27435. */
  27436. readonly worldMatrixFromCache: Matrix;
  27437. /** @hidden */
  27438. _initCache(): void;
  27439. /** @hidden */
  27440. updateCache(force?: boolean): void;
  27441. /** @hidden */
  27442. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27443. /** @hidden */
  27444. _updateCache(ignoreParentClass?: boolean): void;
  27445. /** @hidden */
  27446. _isSynchronized(): boolean;
  27447. /** @hidden */
  27448. _markSyncedWithParent(): void;
  27449. /** @hidden */
  27450. isSynchronizedWithParent(): boolean;
  27451. /** @hidden */
  27452. isSynchronized(): boolean;
  27453. /**
  27454. * Is this node ready to be used/rendered
  27455. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  27456. * @return true if the node is ready
  27457. */
  27458. isReady(completeCheck?: boolean): boolean;
  27459. /**
  27460. * Is this node enabled?
  27461. * 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
  27462. * @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
  27463. * @return whether this node (and its parent) is enabled
  27464. */
  27465. isEnabled(checkAncestors?: boolean): boolean;
  27466. /** @hidden */
  27467. protected _syncParentEnabledState(): void;
  27468. /**
  27469. * Set the enabled state of this node
  27470. * @param value defines the new enabled state
  27471. */
  27472. setEnabled(value: boolean): void;
  27473. /**
  27474. * Is this node a descendant of the given node?
  27475. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  27476. * @param ancestor defines the parent node to inspect
  27477. * @returns a boolean indicating if this node is a descendant of the given node
  27478. */
  27479. isDescendantOf(ancestor: Node): boolean;
  27480. /** @hidden */
  27481. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  27482. /**
  27483. * Will return all nodes that have this node as ascendant
  27484. * @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
  27485. * @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
  27486. * @return all children nodes of all types
  27487. */
  27488. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  27489. /**
  27490. * Get all child-meshes of this node
  27491. * @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)
  27492. * @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
  27493. * @returns an array of AbstractMesh
  27494. */
  27495. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  27496. /**
  27497. * Get all direct children of this node
  27498. * @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
  27499. * @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)
  27500. * @returns an array of Node
  27501. */
  27502. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  27503. /** @hidden */
  27504. _setReady(state: boolean): void;
  27505. /**
  27506. * Get an animation by name
  27507. * @param name defines the name of the animation to look for
  27508. * @returns null if not found else the requested animation
  27509. */
  27510. getAnimationByName(name: string): Nullable<Animation>;
  27511. /**
  27512. * Creates an animation range for this node
  27513. * @param name defines the name of the range
  27514. * @param from defines the starting key
  27515. * @param to defines the end key
  27516. */
  27517. createAnimationRange(name: string, from: number, to: number): void;
  27518. /**
  27519. * Delete a specific animation range
  27520. * @param name defines the name of the range to delete
  27521. * @param deleteFrames defines if animation frames from the range must be deleted as well
  27522. */
  27523. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  27524. /**
  27525. * Get an animation range by name
  27526. * @param name defines the name of the animation range to look for
  27527. * @returns null if not found else the requested animation range
  27528. */
  27529. getAnimationRange(name: string): Nullable<AnimationRange>;
  27530. /**
  27531. * Gets the list of all animation ranges defined on this node
  27532. * @returns an array
  27533. */
  27534. getAnimationRanges(): Nullable<AnimationRange>[];
  27535. /**
  27536. * Will start the animation sequence
  27537. * @param name defines the range frames for animation sequence
  27538. * @param loop defines if the animation should loop (false by default)
  27539. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  27540. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  27541. * @returns the object created for this animation. If range does not exist, it will return null
  27542. */
  27543. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  27544. /**
  27545. * Serialize animation ranges into a JSON compatible object
  27546. * @returns serialization object
  27547. */
  27548. serializeAnimationRanges(): any;
  27549. /**
  27550. * Computes the world matrix of the node
  27551. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  27552. * @returns the world matrix
  27553. */
  27554. computeWorldMatrix(force?: boolean): Matrix;
  27555. /**
  27556. * Releases resources associated with this node.
  27557. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27558. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27559. */
  27560. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27561. /**
  27562. * Parse animation range data from a serialization object and store them into a given node
  27563. * @param node defines where to store the animation ranges
  27564. * @param parsedNode defines the serialization object to read data from
  27565. * @param scene defines the hosting scene
  27566. */
  27567. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  27568. /**
  27569. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  27570. * @param includeDescendants Include bounding info from descendants as well (true by default)
  27571. * @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
  27572. * @returns the new bounding vectors
  27573. */
  27574. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  27575. min: Vector3;
  27576. max: Vector3;
  27577. };
  27578. }
  27579. }
  27580. declare module "babylonjs/Animations/animation" {
  27581. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  27582. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  27583. import { Color3 } from "babylonjs/Maths/math.color";
  27584. import { Nullable } from "babylonjs/types";
  27585. import { Scene } from "babylonjs/scene";
  27586. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  27587. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27588. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  27589. import { Node } from "babylonjs/node";
  27590. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27591. import { Size } from "babylonjs/Maths/math.size";
  27592. import { Animatable } from "babylonjs/Animations/animatable";
  27593. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  27594. /**
  27595. * @hidden
  27596. */
  27597. export class _IAnimationState {
  27598. key: number;
  27599. repeatCount: number;
  27600. workValue?: any;
  27601. loopMode?: number;
  27602. offsetValue?: any;
  27603. highLimitValue?: any;
  27604. }
  27605. /**
  27606. * Class used to store any kind of animation
  27607. */
  27608. export class Animation {
  27609. /**Name of the animation */
  27610. name: string;
  27611. /**Property to animate */
  27612. targetProperty: string;
  27613. /**The frames per second of the animation */
  27614. framePerSecond: number;
  27615. /**The data type of the animation */
  27616. dataType: number;
  27617. /**The loop mode of the animation */
  27618. loopMode?: number | undefined;
  27619. /**Specifies if blending should be enabled */
  27620. enableBlending?: boolean | undefined;
  27621. /**
  27622. * Use matrix interpolation instead of using direct key value when animating matrices
  27623. */
  27624. static AllowMatricesInterpolation: boolean;
  27625. /**
  27626. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  27627. */
  27628. static AllowMatrixDecomposeForInterpolation: boolean;
  27629. /**
  27630. * Stores the key frames of the animation
  27631. */
  27632. private _keys;
  27633. /**
  27634. * Stores the easing function of the animation
  27635. */
  27636. private _easingFunction;
  27637. /**
  27638. * @hidden Internal use only
  27639. */
  27640. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  27641. /**
  27642. * The set of event that will be linked to this animation
  27643. */
  27644. private _events;
  27645. /**
  27646. * Stores an array of target property paths
  27647. */
  27648. targetPropertyPath: string[];
  27649. /**
  27650. * Stores the blending speed of the animation
  27651. */
  27652. blendingSpeed: number;
  27653. /**
  27654. * Stores the animation ranges for the animation
  27655. */
  27656. private _ranges;
  27657. /**
  27658. * @hidden Internal use
  27659. */
  27660. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  27661. /**
  27662. * Sets up an animation
  27663. * @param property The property to animate
  27664. * @param animationType The animation type to apply
  27665. * @param framePerSecond The frames per second of the animation
  27666. * @param easingFunction The easing function used in the animation
  27667. * @returns The created animation
  27668. */
  27669. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  27670. /**
  27671. * Create and start an animation on a node
  27672. * @param name defines the name of the global animation that will be run on all nodes
  27673. * @param node defines the root node where the animation will take place
  27674. * @param targetProperty defines property to animate
  27675. * @param framePerSecond defines the number of frame per second yo use
  27676. * @param totalFrame defines the number of frames in total
  27677. * @param from defines the initial value
  27678. * @param to defines the final value
  27679. * @param loopMode defines which loop mode you want to use (off by default)
  27680. * @param easingFunction defines the easing function to use (linear by default)
  27681. * @param onAnimationEnd defines the callback to call when animation end
  27682. * @returns the animatable created for this animation
  27683. */
  27684. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  27685. /**
  27686. * Create and start an animation on a node and its descendants
  27687. * @param name defines the name of the global animation that will be run on all nodes
  27688. * @param node defines the root node where the animation will take place
  27689. * @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
  27690. * @param targetProperty defines property to animate
  27691. * @param framePerSecond defines the number of frame per second to use
  27692. * @param totalFrame defines the number of frames in total
  27693. * @param from defines the initial value
  27694. * @param to defines the final value
  27695. * @param loopMode defines which loop mode you want to use (off by default)
  27696. * @param easingFunction defines the easing function to use (linear by default)
  27697. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  27698. * @returns the list of animatables created for all nodes
  27699. * @example https://www.babylonjs-playground.com/#MH0VLI
  27700. */
  27701. 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[]>;
  27702. /**
  27703. * Creates a new animation, merges it with the existing animations and starts it
  27704. * @param name Name of the animation
  27705. * @param node Node which contains the scene that begins the animations
  27706. * @param targetProperty Specifies which property to animate
  27707. * @param framePerSecond The frames per second of the animation
  27708. * @param totalFrame The total number of frames
  27709. * @param from The frame at the beginning of the animation
  27710. * @param to The frame at the end of the animation
  27711. * @param loopMode Specifies the loop mode of the animation
  27712. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  27713. * @param onAnimationEnd Callback to run once the animation is complete
  27714. * @returns Nullable animation
  27715. */
  27716. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  27717. /**
  27718. * Transition property of an host to the target Value
  27719. * @param property The property to transition
  27720. * @param targetValue The target Value of the property
  27721. * @param host The object where the property to animate belongs
  27722. * @param scene Scene used to run the animation
  27723. * @param frameRate Framerate (in frame/s) to use
  27724. * @param transition The transition type we want to use
  27725. * @param duration The duration of the animation, in milliseconds
  27726. * @param onAnimationEnd Callback trigger at the end of the animation
  27727. * @returns Nullable animation
  27728. */
  27729. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  27730. /**
  27731. * Return the array of runtime animations currently using this animation
  27732. */
  27733. readonly runtimeAnimations: RuntimeAnimation[];
  27734. /**
  27735. * Specifies if any of the runtime animations are currently running
  27736. */
  27737. readonly hasRunningRuntimeAnimations: boolean;
  27738. /**
  27739. * Initializes the animation
  27740. * @param name Name of the animation
  27741. * @param targetProperty Property to animate
  27742. * @param framePerSecond The frames per second of the animation
  27743. * @param dataType The data type of the animation
  27744. * @param loopMode The loop mode of the animation
  27745. * @param enableBlending Specifies if blending should be enabled
  27746. */
  27747. constructor(
  27748. /**Name of the animation */
  27749. name: string,
  27750. /**Property to animate */
  27751. targetProperty: string,
  27752. /**The frames per second of the animation */
  27753. framePerSecond: number,
  27754. /**The data type of the animation */
  27755. dataType: number,
  27756. /**The loop mode of the animation */
  27757. loopMode?: number | undefined,
  27758. /**Specifies if blending should be enabled */
  27759. enableBlending?: boolean | undefined);
  27760. /**
  27761. * Converts the animation to a string
  27762. * @param fullDetails support for multiple levels of logging within scene loading
  27763. * @returns String form of the animation
  27764. */
  27765. toString(fullDetails?: boolean): string;
  27766. /**
  27767. * Add an event to this animation
  27768. * @param event Event to add
  27769. */
  27770. addEvent(event: AnimationEvent): void;
  27771. /**
  27772. * Remove all events found at the given frame
  27773. * @param frame The frame to remove events from
  27774. */
  27775. removeEvents(frame: number): void;
  27776. /**
  27777. * Retrieves all the events from the animation
  27778. * @returns Events from the animation
  27779. */
  27780. getEvents(): AnimationEvent[];
  27781. /**
  27782. * Creates an animation range
  27783. * @param name Name of the animation range
  27784. * @param from Starting frame of the animation range
  27785. * @param to Ending frame of the animation
  27786. */
  27787. createRange(name: string, from: number, to: number): void;
  27788. /**
  27789. * Deletes an animation range by name
  27790. * @param name Name of the animation range to delete
  27791. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  27792. */
  27793. deleteRange(name: string, deleteFrames?: boolean): void;
  27794. /**
  27795. * Gets the animation range by name, or null if not defined
  27796. * @param name Name of the animation range
  27797. * @returns Nullable animation range
  27798. */
  27799. getRange(name: string): Nullable<AnimationRange>;
  27800. /**
  27801. * Gets the key frames from the animation
  27802. * @returns The key frames of the animation
  27803. */
  27804. getKeys(): Array<IAnimationKey>;
  27805. /**
  27806. * Gets the highest frame rate of the animation
  27807. * @returns Highest frame rate of the animation
  27808. */
  27809. getHighestFrame(): number;
  27810. /**
  27811. * Gets the easing function of the animation
  27812. * @returns Easing function of the animation
  27813. */
  27814. getEasingFunction(): IEasingFunction;
  27815. /**
  27816. * Sets the easing function of the animation
  27817. * @param easingFunction A custom mathematical formula for animation
  27818. */
  27819. setEasingFunction(easingFunction: EasingFunction): void;
  27820. /**
  27821. * Interpolates a scalar linearly
  27822. * @param startValue Start value of the animation curve
  27823. * @param endValue End value of the animation curve
  27824. * @param gradient Scalar amount to interpolate
  27825. * @returns Interpolated scalar value
  27826. */
  27827. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  27828. /**
  27829. * Interpolates a scalar cubically
  27830. * @param startValue Start value of the animation curve
  27831. * @param outTangent End tangent of the animation
  27832. * @param endValue End value of the animation curve
  27833. * @param inTangent Start tangent of the animation curve
  27834. * @param gradient Scalar amount to interpolate
  27835. * @returns Interpolated scalar value
  27836. */
  27837. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  27838. /**
  27839. * Interpolates a quaternion using a spherical linear interpolation
  27840. * @param startValue Start value of the animation curve
  27841. * @param endValue End value of the animation curve
  27842. * @param gradient Scalar amount to interpolate
  27843. * @returns Interpolated quaternion value
  27844. */
  27845. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  27846. /**
  27847. * Interpolates a quaternion cubically
  27848. * @param startValue Start value of the animation curve
  27849. * @param outTangent End tangent of the animation curve
  27850. * @param endValue End value of the animation curve
  27851. * @param inTangent Start tangent of the animation curve
  27852. * @param gradient Scalar amount to interpolate
  27853. * @returns Interpolated quaternion value
  27854. */
  27855. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  27856. /**
  27857. * Interpolates a Vector3 linearl
  27858. * @param startValue Start value of the animation curve
  27859. * @param endValue End value of the animation curve
  27860. * @param gradient Scalar amount to interpolate
  27861. * @returns Interpolated scalar value
  27862. */
  27863. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  27864. /**
  27865. * Interpolates a Vector3 cubically
  27866. * @param startValue Start value of the animation curve
  27867. * @param outTangent End tangent of the animation
  27868. * @param endValue End value of the animation curve
  27869. * @param inTangent Start tangent of the animation curve
  27870. * @param gradient Scalar amount to interpolate
  27871. * @returns InterpolatedVector3 value
  27872. */
  27873. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  27874. /**
  27875. * Interpolates a Vector2 linearly
  27876. * @param startValue Start value of the animation curve
  27877. * @param endValue End value of the animation curve
  27878. * @param gradient Scalar amount to interpolate
  27879. * @returns Interpolated Vector2 value
  27880. */
  27881. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  27882. /**
  27883. * Interpolates a Vector2 cubically
  27884. * @param startValue Start value of the animation curve
  27885. * @param outTangent End tangent of the animation
  27886. * @param endValue End value of the animation curve
  27887. * @param inTangent Start tangent of the animation curve
  27888. * @param gradient Scalar amount to interpolate
  27889. * @returns Interpolated Vector2 value
  27890. */
  27891. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  27892. /**
  27893. * Interpolates a size linearly
  27894. * @param startValue Start value of the animation curve
  27895. * @param endValue End value of the animation curve
  27896. * @param gradient Scalar amount to interpolate
  27897. * @returns Interpolated Size value
  27898. */
  27899. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  27900. /**
  27901. * Interpolates a Color3 linearly
  27902. * @param startValue Start value of the animation curve
  27903. * @param endValue End value of the animation curve
  27904. * @param gradient Scalar amount to interpolate
  27905. * @returns Interpolated Color3 value
  27906. */
  27907. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  27908. /**
  27909. * @hidden Internal use only
  27910. */
  27911. _getKeyValue(value: any): any;
  27912. /**
  27913. * @hidden Internal use only
  27914. */
  27915. _interpolate(currentFrame: number, state: _IAnimationState): any;
  27916. /**
  27917. * Defines the function to use to interpolate matrices
  27918. * @param startValue defines the start matrix
  27919. * @param endValue defines the end matrix
  27920. * @param gradient defines the gradient between both matrices
  27921. * @param result defines an optional target matrix where to store the interpolation
  27922. * @returns the interpolated matrix
  27923. */
  27924. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  27925. /**
  27926. * Makes a copy of the animation
  27927. * @returns Cloned animation
  27928. */
  27929. clone(): Animation;
  27930. /**
  27931. * Sets the key frames of the animation
  27932. * @param values The animation key frames to set
  27933. */
  27934. setKeys(values: Array<IAnimationKey>): void;
  27935. /**
  27936. * Serializes the animation to an object
  27937. * @returns Serialized object
  27938. */
  27939. serialize(): any;
  27940. /**
  27941. * Float animation type
  27942. */
  27943. private static _ANIMATIONTYPE_FLOAT;
  27944. /**
  27945. * Vector3 animation type
  27946. */
  27947. private static _ANIMATIONTYPE_VECTOR3;
  27948. /**
  27949. * Quaternion animation type
  27950. */
  27951. private static _ANIMATIONTYPE_QUATERNION;
  27952. /**
  27953. * Matrix animation type
  27954. */
  27955. private static _ANIMATIONTYPE_MATRIX;
  27956. /**
  27957. * Color3 animation type
  27958. */
  27959. private static _ANIMATIONTYPE_COLOR3;
  27960. /**
  27961. * Vector2 animation type
  27962. */
  27963. private static _ANIMATIONTYPE_VECTOR2;
  27964. /**
  27965. * Size animation type
  27966. */
  27967. private static _ANIMATIONTYPE_SIZE;
  27968. /**
  27969. * Relative Loop Mode
  27970. */
  27971. private static _ANIMATIONLOOPMODE_RELATIVE;
  27972. /**
  27973. * Cycle Loop Mode
  27974. */
  27975. private static _ANIMATIONLOOPMODE_CYCLE;
  27976. /**
  27977. * Constant Loop Mode
  27978. */
  27979. private static _ANIMATIONLOOPMODE_CONSTANT;
  27980. /**
  27981. * Get the float animation type
  27982. */
  27983. static readonly ANIMATIONTYPE_FLOAT: number;
  27984. /**
  27985. * Get the Vector3 animation type
  27986. */
  27987. static readonly ANIMATIONTYPE_VECTOR3: number;
  27988. /**
  27989. * Get the Vector2 animation type
  27990. */
  27991. static readonly ANIMATIONTYPE_VECTOR2: number;
  27992. /**
  27993. * Get the Size animation type
  27994. */
  27995. static readonly ANIMATIONTYPE_SIZE: number;
  27996. /**
  27997. * Get the Quaternion animation type
  27998. */
  27999. static readonly ANIMATIONTYPE_QUATERNION: number;
  28000. /**
  28001. * Get the Matrix animation type
  28002. */
  28003. static readonly ANIMATIONTYPE_MATRIX: number;
  28004. /**
  28005. * Get the Color3 animation type
  28006. */
  28007. static readonly ANIMATIONTYPE_COLOR3: number;
  28008. /**
  28009. * Get the Relative Loop Mode
  28010. */
  28011. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28012. /**
  28013. * Get the Cycle Loop Mode
  28014. */
  28015. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28016. /**
  28017. * Get the Constant Loop Mode
  28018. */
  28019. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28020. /** @hidden */
  28021. static _UniversalLerp(left: any, right: any, amount: number): any;
  28022. /**
  28023. * Parses an animation object and creates an animation
  28024. * @param parsedAnimation Parsed animation object
  28025. * @returns Animation object
  28026. */
  28027. static Parse(parsedAnimation: any): Animation;
  28028. /**
  28029. * Appends the serialized animations from the source animations
  28030. * @param source Source containing the animations
  28031. * @param destination Target to store the animations
  28032. */
  28033. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28034. }
  28035. }
  28036. declare module "babylonjs/Animations/animatable.interface" {
  28037. import { Nullable } from "babylonjs/types";
  28038. import { Animation } from "babylonjs/Animations/animation";
  28039. /**
  28040. * Interface containing an array of animations
  28041. */
  28042. export interface IAnimatable {
  28043. /**
  28044. * Array of animations
  28045. */
  28046. animations: Nullable<Array<Animation>>;
  28047. }
  28048. }
  28049. declare module "babylonjs/Materials/fresnelParameters" {
  28050. import { Color3 } from "babylonjs/Maths/math.color";
  28051. /**
  28052. * This represents all the required information to add a fresnel effect on a material:
  28053. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28054. */
  28055. export class FresnelParameters {
  28056. private _isEnabled;
  28057. /**
  28058. * Define if the fresnel effect is enable or not.
  28059. */
  28060. isEnabled: boolean;
  28061. /**
  28062. * Define the color used on edges (grazing angle)
  28063. */
  28064. leftColor: Color3;
  28065. /**
  28066. * Define the color used on center
  28067. */
  28068. rightColor: Color3;
  28069. /**
  28070. * Define bias applied to computed fresnel term
  28071. */
  28072. bias: number;
  28073. /**
  28074. * Defined the power exponent applied to fresnel term
  28075. */
  28076. power: number;
  28077. /**
  28078. * Clones the current fresnel and its valuues
  28079. * @returns a clone fresnel configuration
  28080. */
  28081. clone(): FresnelParameters;
  28082. /**
  28083. * Serializes the current fresnel parameters to a JSON representation.
  28084. * @return the JSON serialization
  28085. */
  28086. serialize(): any;
  28087. /**
  28088. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28089. * @param parsedFresnelParameters Define the JSON representation
  28090. * @returns the parsed parameters
  28091. */
  28092. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28093. }
  28094. }
  28095. declare module "babylonjs/Misc/decorators" {
  28096. import { Nullable } from "babylonjs/types";
  28097. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28098. import { Scene } from "babylonjs/scene";
  28099. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28100. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28101. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28102. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28103. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28104. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28105. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28106. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28107. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28108. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28109. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28110. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28111. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28112. /**
  28113. * Decorator used to define property that can be serialized as reference to a camera
  28114. * @param sourceName defines the name of the property to decorate
  28115. */
  28116. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28117. /**
  28118. * Class used to help serialization objects
  28119. */
  28120. export class SerializationHelper {
  28121. /** @hidden */
  28122. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28123. /** @hidden */
  28124. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28125. /** @hidden */
  28126. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28127. /** @hidden */
  28128. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28129. /**
  28130. * Appends the serialized animations from the source animations
  28131. * @param source Source containing the animations
  28132. * @param destination Target to store the animations
  28133. */
  28134. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28135. /**
  28136. * Static function used to serialized a specific entity
  28137. * @param entity defines the entity to serialize
  28138. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28139. * @returns a JSON compatible object representing the serialization of the entity
  28140. */
  28141. static Serialize<T>(entity: T, serializationObject?: any): any;
  28142. /**
  28143. * Creates a new entity from a serialization data object
  28144. * @param creationFunction defines a function used to instanciated the new entity
  28145. * @param source defines the source serialization data
  28146. * @param scene defines the hosting scene
  28147. * @param rootUrl defines the root url for resources
  28148. * @returns a new entity
  28149. */
  28150. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28151. /**
  28152. * Clones an object
  28153. * @param creationFunction defines the function used to instanciate the new object
  28154. * @param source defines the source object
  28155. * @returns the cloned object
  28156. */
  28157. static Clone<T>(creationFunction: () => T, source: T): T;
  28158. /**
  28159. * Instanciates a new object based on a source one (some data will be shared between both object)
  28160. * @param creationFunction defines the function used to instanciate the new object
  28161. * @param source defines the source object
  28162. * @returns the new object
  28163. */
  28164. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28165. }
  28166. }
  28167. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  28168. import { Nullable } from "babylonjs/types";
  28169. /**
  28170. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  28171. */
  28172. export interface CubeMapInfo {
  28173. /**
  28174. * The pixel array for the front face.
  28175. * This is stored in format, left to right, up to down format.
  28176. */
  28177. front: Nullable<ArrayBufferView>;
  28178. /**
  28179. * The pixel array for the back face.
  28180. * This is stored in format, left to right, up to down format.
  28181. */
  28182. back: Nullable<ArrayBufferView>;
  28183. /**
  28184. * The pixel array for the left face.
  28185. * This is stored in format, left to right, up to down format.
  28186. */
  28187. left: Nullable<ArrayBufferView>;
  28188. /**
  28189. * The pixel array for the right face.
  28190. * This is stored in format, left to right, up to down format.
  28191. */
  28192. right: Nullable<ArrayBufferView>;
  28193. /**
  28194. * The pixel array for the up face.
  28195. * This is stored in format, left to right, up to down format.
  28196. */
  28197. up: Nullable<ArrayBufferView>;
  28198. /**
  28199. * The pixel array for the down face.
  28200. * This is stored in format, left to right, up to down format.
  28201. */
  28202. down: Nullable<ArrayBufferView>;
  28203. /**
  28204. * The size of the cubemap stored.
  28205. *
  28206. * Each faces will be size * size pixels.
  28207. */
  28208. size: number;
  28209. /**
  28210. * The format of the texture.
  28211. *
  28212. * RGBA, RGB.
  28213. */
  28214. format: number;
  28215. /**
  28216. * The type of the texture data.
  28217. *
  28218. * UNSIGNED_INT, FLOAT.
  28219. */
  28220. type: number;
  28221. /**
  28222. * Specifies whether the texture is in gamma space.
  28223. */
  28224. gammaSpace: boolean;
  28225. }
  28226. /**
  28227. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  28228. */
  28229. export class PanoramaToCubeMapTools {
  28230. private static FACE_FRONT;
  28231. private static FACE_BACK;
  28232. private static FACE_RIGHT;
  28233. private static FACE_LEFT;
  28234. private static FACE_DOWN;
  28235. private static FACE_UP;
  28236. /**
  28237. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  28238. *
  28239. * @param float32Array The source data.
  28240. * @param inputWidth The width of the input panorama.
  28241. * @param inputHeight The height of the input panorama.
  28242. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  28243. * @return The cubemap data
  28244. */
  28245. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  28246. private static CreateCubemapTexture;
  28247. private static CalcProjectionSpherical;
  28248. }
  28249. }
  28250. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  28251. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  28252. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28253. import { Nullable } from "babylonjs/types";
  28254. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  28255. /**
  28256. * Helper class dealing with the extraction of spherical polynomial dataArray
  28257. * from a cube map.
  28258. */
  28259. export class CubeMapToSphericalPolynomialTools {
  28260. private static FileFaces;
  28261. /**
  28262. * Converts a texture to the according Spherical Polynomial data.
  28263. * This extracts the first 3 orders only as they are the only one used in the lighting.
  28264. *
  28265. * @param texture The texture to extract the information from.
  28266. * @return The Spherical Polynomial data.
  28267. */
  28268. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  28269. /**
  28270. * Converts a cubemap to the according Spherical Polynomial data.
  28271. * This extracts the first 3 orders only as they are the only one used in the lighting.
  28272. *
  28273. * @param cubeInfo The Cube map to extract the information from.
  28274. * @return The Spherical Polynomial data.
  28275. */
  28276. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  28277. }
  28278. }
  28279. declare module "babylonjs/Misc/guid" {
  28280. /**
  28281. * Class used to manipulate GUIDs
  28282. */
  28283. export class GUID {
  28284. /**
  28285. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28286. * Be aware Math.random() could cause collisions, but:
  28287. * "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"
  28288. * @returns a pseudo random id
  28289. */
  28290. static RandomId(): string;
  28291. }
  28292. }
  28293. declare module "babylonjs/Materials/Textures/baseTexture" {
  28294. import { Observable } from "babylonjs/Misc/observable";
  28295. import { Nullable } from "babylonjs/types";
  28296. import { Scene } from "babylonjs/scene";
  28297. import { Matrix } from "babylonjs/Maths/math.vector";
  28298. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  28299. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28300. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28301. import { ISize } from "babylonjs/Maths/math.size";
  28302. /**
  28303. * Base class of all the textures in babylon.
  28304. * It groups all the common properties the materials, post process, lights... might need
  28305. * in order to make a correct use of the texture.
  28306. */
  28307. export class BaseTexture implements IAnimatable {
  28308. /**
  28309. * Default anisotropic filtering level for the application.
  28310. * It is set to 4 as a good tradeoff between perf and quality.
  28311. */
  28312. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28313. /**
  28314. * Gets or sets the unique id of the texture
  28315. */
  28316. uniqueId: number;
  28317. /**
  28318. * Define the name of the texture.
  28319. */
  28320. name: string;
  28321. /**
  28322. * Gets or sets an object used to store user defined information.
  28323. */
  28324. metadata: any;
  28325. /**
  28326. * For internal use only. Please do not use.
  28327. */
  28328. reservedDataStore: any;
  28329. private _hasAlpha;
  28330. /**
  28331. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28332. */
  28333. hasAlpha: boolean;
  28334. /**
  28335. * Defines if the alpha value should be determined via the rgb values.
  28336. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28337. */
  28338. getAlphaFromRGB: boolean;
  28339. /**
  28340. * Intensity or strength of the texture.
  28341. * It is commonly used by materials to fine tune the intensity of the texture
  28342. */
  28343. level: number;
  28344. /**
  28345. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28346. * This is part of the texture as textures usually maps to one uv set.
  28347. */
  28348. coordinatesIndex: number;
  28349. private _coordinatesMode;
  28350. /**
  28351. * How a texture is mapped.
  28352. *
  28353. * | Value | Type | Description |
  28354. * | ----- | ----------------------------------- | ----------- |
  28355. * | 0 | EXPLICIT_MODE | |
  28356. * | 1 | SPHERICAL_MODE | |
  28357. * | 2 | PLANAR_MODE | |
  28358. * | 3 | CUBIC_MODE | |
  28359. * | 4 | PROJECTION_MODE | |
  28360. * | 5 | SKYBOX_MODE | |
  28361. * | 6 | INVCUBIC_MODE | |
  28362. * | 7 | EQUIRECTANGULAR_MODE | |
  28363. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  28364. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  28365. */
  28366. coordinatesMode: number;
  28367. /**
  28368. * | Value | Type | Description |
  28369. * | ----- | ------------------ | ----------- |
  28370. * | 0 | CLAMP_ADDRESSMODE | |
  28371. * | 1 | WRAP_ADDRESSMODE | |
  28372. * | 2 | MIRROR_ADDRESSMODE | |
  28373. */
  28374. wrapU: number;
  28375. /**
  28376. * | Value | Type | Description |
  28377. * | ----- | ------------------ | ----------- |
  28378. * | 0 | CLAMP_ADDRESSMODE | |
  28379. * | 1 | WRAP_ADDRESSMODE | |
  28380. * | 2 | MIRROR_ADDRESSMODE | |
  28381. */
  28382. wrapV: number;
  28383. /**
  28384. * | Value | Type | Description |
  28385. * | ----- | ------------------ | ----------- |
  28386. * | 0 | CLAMP_ADDRESSMODE | |
  28387. * | 1 | WRAP_ADDRESSMODE | |
  28388. * | 2 | MIRROR_ADDRESSMODE | |
  28389. */
  28390. wrapR: number;
  28391. /**
  28392. * With compliant hardware and browser (supporting anisotropic filtering)
  28393. * this defines the level of anisotropic filtering in the texture.
  28394. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  28395. */
  28396. anisotropicFilteringLevel: number;
  28397. /**
  28398. * Define if the texture is a cube texture or if false a 2d texture.
  28399. */
  28400. isCube: boolean;
  28401. /**
  28402. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  28403. */
  28404. is3D: boolean;
  28405. /**
  28406. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  28407. * HDR texture are usually stored in linear space.
  28408. * This only impacts the PBR and Background materials
  28409. */
  28410. gammaSpace: boolean;
  28411. /**
  28412. * Gets whether or not the texture contains RGBD data.
  28413. */
  28414. readonly isRGBD: boolean;
  28415. /**
  28416. * Is Z inverted in the texture (useful in a cube texture).
  28417. */
  28418. invertZ: boolean;
  28419. /**
  28420. * Are mip maps generated for this texture or not.
  28421. */
  28422. readonly noMipmap: boolean;
  28423. /**
  28424. * @hidden
  28425. */
  28426. lodLevelInAlpha: boolean;
  28427. /**
  28428. * With prefiltered texture, defined the offset used during the prefiltering steps.
  28429. */
  28430. lodGenerationOffset: number;
  28431. /**
  28432. * With prefiltered texture, defined the scale used during the prefiltering steps.
  28433. */
  28434. lodGenerationScale: number;
  28435. /**
  28436. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  28437. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  28438. * average roughness values.
  28439. */
  28440. linearSpecularLOD: boolean;
  28441. /**
  28442. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  28443. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  28444. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  28445. */
  28446. irradianceTexture: Nullable<BaseTexture>;
  28447. /**
  28448. * Define if the texture is a render target.
  28449. */
  28450. isRenderTarget: boolean;
  28451. /**
  28452. * Define the unique id of the texture in the scene.
  28453. */
  28454. readonly uid: string;
  28455. /**
  28456. * Return a string representation of the texture.
  28457. * @returns the texture as a string
  28458. */
  28459. toString(): string;
  28460. /**
  28461. * Get the class name of the texture.
  28462. * @returns "BaseTexture"
  28463. */
  28464. getClassName(): string;
  28465. /**
  28466. * Define the list of animation attached to the texture.
  28467. */
  28468. animations: import("babylonjs/Animations/animation").Animation[];
  28469. /**
  28470. * An event triggered when the texture is disposed.
  28471. */
  28472. onDisposeObservable: Observable<BaseTexture>;
  28473. private _onDisposeObserver;
  28474. /**
  28475. * Callback triggered when the texture has been disposed.
  28476. * Kept for back compatibility, you can use the onDisposeObservable instead.
  28477. */
  28478. onDispose: () => void;
  28479. /**
  28480. * Define the current state of the loading sequence when in delayed load mode.
  28481. */
  28482. delayLoadState: number;
  28483. private _scene;
  28484. /** @hidden */
  28485. _texture: Nullable<InternalTexture>;
  28486. private _uid;
  28487. /**
  28488. * Define if the texture is preventinga material to render or not.
  28489. * If not and the texture is not ready, the engine will use a default black texture instead.
  28490. */
  28491. readonly isBlocking: boolean;
  28492. /**
  28493. * Instantiates a new BaseTexture.
  28494. * Base class of all the textures in babylon.
  28495. * It groups all the common properties the materials, post process, lights... might need
  28496. * in order to make a correct use of the texture.
  28497. * @param scene Define the scene the texture blongs to
  28498. */
  28499. constructor(scene: Nullable<Scene>);
  28500. /**
  28501. * Get the scene the texture belongs to.
  28502. * @returns the scene or null if undefined
  28503. */
  28504. getScene(): Nullable<Scene>;
  28505. /**
  28506. * Get the texture transform matrix used to offset tile the texture for istance.
  28507. * @returns the transformation matrix
  28508. */
  28509. getTextureMatrix(): Matrix;
  28510. /**
  28511. * Get the texture reflection matrix used to rotate/transform the reflection.
  28512. * @returns the reflection matrix
  28513. */
  28514. getReflectionTextureMatrix(): Matrix;
  28515. /**
  28516. * Get the underlying lower level texture from Babylon.
  28517. * @returns the insternal texture
  28518. */
  28519. getInternalTexture(): Nullable<InternalTexture>;
  28520. /**
  28521. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  28522. * @returns true if ready or not blocking
  28523. */
  28524. isReadyOrNotBlocking(): boolean;
  28525. /**
  28526. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  28527. * @returns true if fully ready
  28528. */
  28529. isReady(): boolean;
  28530. private _cachedSize;
  28531. /**
  28532. * Get the size of the texture.
  28533. * @returns the texture size.
  28534. */
  28535. getSize(): ISize;
  28536. /**
  28537. * Get the base size of the texture.
  28538. * It can be different from the size if the texture has been resized for POT for instance
  28539. * @returns the base size
  28540. */
  28541. getBaseSize(): ISize;
  28542. /**
  28543. * Update the sampling mode of the texture.
  28544. * Default is Trilinear mode.
  28545. *
  28546. * | Value | Type | Description |
  28547. * | ----- | ------------------ | ----------- |
  28548. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  28549. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  28550. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  28551. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  28552. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  28553. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  28554. * | 7 | NEAREST_LINEAR | |
  28555. * | 8 | NEAREST_NEAREST | |
  28556. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  28557. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  28558. * | 11 | LINEAR_LINEAR | |
  28559. * | 12 | LINEAR_NEAREST | |
  28560. *
  28561. * > _mag_: magnification filter (close to the viewer)
  28562. * > _min_: minification filter (far from the viewer)
  28563. * > _mip_: filter used between mip map levels
  28564. *@param samplingMode Define the new sampling mode of the texture
  28565. */
  28566. updateSamplingMode(samplingMode: number): void;
  28567. /**
  28568. * Scales the texture if is `canRescale()`
  28569. * @param ratio the resize factor we want to use to rescale
  28570. */
  28571. scale(ratio: number): void;
  28572. /**
  28573. * Get if the texture can rescale.
  28574. */
  28575. readonly canRescale: boolean;
  28576. /** @hidden */
  28577. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  28578. /** @hidden */
  28579. _rebuild(): void;
  28580. /**
  28581. * Triggers the load sequence in delayed load mode.
  28582. */
  28583. delayLoad(): void;
  28584. /**
  28585. * Clones the texture.
  28586. * @returns the cloned texture
  28587. */
  28588. clone(): Nullable<BaseTexture>;
  28589. /**
  28590. * Get the texture underlying type (INT, FLOAT...)
  28591. */
  28592. readonly textureType: number;
  28593. /**
  28594. * Get the texture underlying format (RGB, RGBA...)
  28595. */
  28596. readonly textureFormat: number;
  28597. /**
  28598. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  28599. * This will returns an RGBA array buffer containing either in values (0-255) or
  28600. * float values (0-1) depending of the underlying buffer type.
  28601. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  28602. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  28603. * @param buffer defines a user defined buffer to fill with data (can be null)
  28604. * @returns The Array buffer containing the pixels data.
  28605. */
  28606. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  28607. /**
  28608. * Release and destroy the underlying lower level texture aka internalTexture.
  28609. */
  28610. releaseInternalTexture(): void;
  28611. /**
  28612. * Get the polynomial representation of the texture data.
  28613. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  28614. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  28615. */
  28616. sphericalPolynomial: Nullable<SphericalPolynomial>;
  28617. /** @hidden */
  28618. readonly _lodTextureHigh: Nullable<BaseTexture>;
  28619. /** @hidden */
  28620. readonly _lodTextureMid: Nullable<BaseTexture>;
  28621. /** @hidden */
  28622. readonly _lodTextureLow: Nullable<BaseTexture>;
  28623. /**
  28624. * Dispose the texture and release its associated resources.
  28625. */
  28626. dispose(): void;
  28627. /**
  28628. * Serialize the texture into a JSON representation that can be parsed later on.
  28629. * @returns the JSON representation of the texture
  28630. */
  28631. serialize(): any;
  28632. /**
  28633. * Helper function to be called back once a list of texture contains only ready textures.
  28634. * @param textures Define the list of textures to wait for
  28635. * @param callback Define the callback triggered once the entire list will be ready
  28636. */
  28637. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  28638. }
  28639. }
  28640. declare module "babylonjs/Materials/Textures/internalTexture" {
  28641. import { Observable } from "babylonjs/Misc/observable";
  28642. import { Nullable, int } from "babylonjs/types";
  28643. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  28644. import { Engine } from "babylonjs/Engines/engine";
  28645. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28646. /**
  28647. * Class used to store data associated with WebGL texture data for the engine
  28648. * This class should not be used directly
  28649. */
  28650. export class InternalTexture {
  28651. /** @hidden */
  28652. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  28653. /**
  28654. * The source of the texture data is unknown
  28655. */
  28656. static DATASOURCE_UNKNOWN: number;
  28657. /**
  28658. * Texture data comes from an URL
  28659. */
  28660. static DATASOURCE_URL: number;
  28661. /**
  28662. * Texture data is only used for temporary storage
  28663. */
  28664. static DATASOURCE_TEMP: number;
  28665. /**
  28666. * Texture data comes from raw data (ArrayBuffer)
  28667. */
  28668. static DATASOURCE_RAW: number;
  28669. /**
  28670. * Texture content is dynamic (video or dynamic texture)
  28671. */
  28672. static DATASOURCE_DYNAMIC: number;
  28673. /**
  28674. * Texture content is generated by rendering to it
  28675. */
  28676. static DATASOURCE_RENDERTARGET: number;
  28677. /**
  28678. * Texture content is part of a multi render target process
  28679. */
  28680. static DATASOURCE_MULTIRENDERTARGET: number;
  28681. /**
  28682. * Texture data comes from a cube data file
  28683. */
  28684. static DATASOURCE_CUBE: number;
  28685. /**
  28686. * Texture data comes from a raw cube data
  28687. */
  28688. static DATASOURCE_CUBERAW: number;
  28689. /**
  28690. * Texture data come from a prefiltered cube data file
  28691. */
  28692. static DATASOURCE_CUBEPREFILTERED: number;
  28693. /**
  28694. * Texture content is raw 3D data
  28695. */
  28696. static DATASOURCE_RAW3D: number;
  28697. /**
  28698. * Texture content is a depth texture
  28699. */
  28700. static DATASOURCE_DEPTHTEXTURE: number;
  28701. /**
  28702. * Texture data comes from a raw cube data encoded with RGBD
  28703. */
  28704. static DATASOURCE_CUBERAW_RGBD: number;
  28705. /**
  28706. * Defines if the texture is ready
  28707. */
  28708. isReady: boolean;
  28709. /**
  28710. * Defines if the texture is a cube texture
  28711. */
  28712. isCube: boolean;
  28713. /**
  28714. * Defines if the texture contains 3D data
  28715. */
  28716. is3D: boolean;
  28717. /**
  28718. * Defines if the texture contains multiview data
  28719. */
  28720. isMultiview: boolean;
  28721. /**
  28722. * Gets the URL used to load this texture
  28723. */
  28724. url: string;
  28725. /**
  28726. * Gets the sampling mode of the texture
  28727. */
  28728. samplingMode: number;
  28729. /**
  28730. * Gets a boolean indicating if the texture needs mipmaps generation
  28731. */
  28732. generateMipMaps: boolean;
  28733. /**
  28734. * Gets the number of samples used by the texture (WebGL2+ only)
  28735. */
  28736. samples: number;
  28737. /**
  28738. * Gets the type of the texture (int, float...)
  28739. */
  28740. type: number;
  28741. /**
  28742. * Gets the format of the texture (RGB, RGBA...)
  28743. */
  28744. format: number;
  28745. /**
  28746. * Observable called when the texture is loaded
  28747. */
  28748. onLoadedObservable: Observable<InternalTexture>;
  28749. /**
  28750. * Gets the width of the texture
  28751. */
  28752. width: number;
  28753. /**
  28754. * Gets the height of the texture
  28755. */
  28756. height: number;
  28757. /**
  28758. * Gets the depth of the texture
  28759. */
  28760. depth: number;
  28761. /**
  28762. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  28763. */
  28764. baseWidth: number;
  28765. /**
  28766. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  28767. */
  28768. baseHeight: number;
  28769. /**
  28770. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  28771. */
  28772. baseDepth: number;
  28773. /**
  28774. * Gets a boolean indicating if the texture is inverted on Y axis
  28775. */
  28776. invertY: boolean;
  28777. /** @hidden */
  28778. _invertVScale: boolean;
  28779. /** @hidden */
  28780. _associatedChannel: number;
  28781. /** @hidden */
  28782. _dataSource: number;
  28783. /** @hidden */
  28784. _buffer: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>;
  28785. /** @hidden */
  28786. _bufferView: Nullable<ArrayBufferView>;
  28787. /** @hidden */
  28788. _bufferViewArray: Nullable<ArrayBufferView[]>;
  28789. /** @hidden */
  28790. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  28791. /** @hidden */
  28792. _size: number;
  28793. /** @hidden */
  28794. _extension: string;
  28795. /** @hidden */
  28796. _files: Nullable<string[]>;
  28797. /** @hidden */
  28798. _workingCanvas: Nullable<HTMLCanvasElement>;
  28799. /** @hidden */
  28800. _workingContext: Nullable<CanvasRenderingContext2D>;
  28801. /** @hidden */
  28802. _framebuffer: Nullable<WebGLFramebuffer>;
  28803. /** @hidden */
  28804. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  28805. /** @hidden */
  28806. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  28807. /** @hidden */
  28808. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  28809. /** @hidden */
  28810. _attachments: Nullable<number[]>;
  28811. /** @hidden */
  28812. _cachedCoordinatesMode: Nullable<number>;
  28813. /** @hidden */
  28814. _cachedWrapU: Nullable<number>;
  28815. /** @hidden */
  28816. _cachedWrapV: Nullable<number>;
  28817. /** @hidden */
  28818. _cachedWrapR: Nullable<number>;
  28819. /** @hidden */
  28820. _cachedAnisotropicFilteringLevel: Nullable<number>;
  28821. /** @hidden */
  28822. _isDisabled: boolean;
  28823. /** @hidden */
  28824. _compression: Nullable<string>;
  28825. /** @hidden */
  28826. _generateStencilBuffer: boolean;
  28827. /** @hidden */
  28828. _generateDepthBuffer: boolean;
  28829. /** @hidden */
  28830. _comparisonFunction: number;
  28831. /** @hidden */
  28832. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  28833. /** @hidden */
  28834. _lodGenerationScale: number;
  28835. /** @hidden */
  28836. _lodGenerationOffset: number;
  28837. /** @hidden */
  28838. _colorTextureArray: Nullable<WebGLTexture>;
  28839. /** @hidden */
  28840. _depthStencilTextureArray: Nullable<WebGLTexture>;
  28841. /** @hidden */
  28842. _lodTextureHigh: Nullable<BaseTexture>;
  28843. /** @hidden */
  28844. _lodTextureMid: Nullable<BaseTexture>;
  28845. /** @hidden */
  28846. _lodTextureLow: Nullable<BaseTexture>;
  28847. /** @hidden */
  28848. _isRGBD: boolean;
  28849. /** @hidden */
  28850. _linearSpecularLOD: boolean;
  28851. /** @hidden */
  28852. _irradianceTexture: Nullable<BaseTexture>;
  28853. /** @hidden */
  28854. _webGLTexture: Nullable<WebGLTexture>;
  28855. /** @hidden */
  28856. _references: number;
  28857. private _engine;
  28858. /**
  28859. * Gets the Engine the texture belongs to.
  28860. * @returns The babylon engine
  28861. */
  28862. getEngine(): Engine;
  28863. /**
  28864. * Gets the data source type of the texture (can be one of the InternalTexture.DATASOURCE_XXXX)
  28865. */
  28866. readonly dataSource: number;
  28867. /**
  28868. * Creates a new InternalTexture
  28869. * @param engine defines the engine to use
  28870. * @param dataSource defines the type of data that will be used
  28871. * @param delayAllocation if the texture allocation should be delayed (default: false)
  28872. */
  28873. constructor(engine: Engine, dataSource: number, delayAllocation?: boolean);
  28874. /**
  28875. * Increments the number of references (ie. the number of Texture that point to it)
  28876. */
  28877. incrementReferences(): void;
  28878. /**
  28879. * Change the size of the texture (not the size of the content)
  28880. * @param width defines the new width
  28881. * @param height defines the new height
  28882. * @param depth defines the new depth (1 by default)
  28883. */
  28884. updateSize(width: int, height: int, depth?: int): void;
  28885. /** @hidden */
  28886. _rebuild(): void;
  28887. /** @hidden */
  28888. _swapAndDie(target: InternalTexture): void;
  28889. /**
  28890. * Dispose the current allocated resources
  28891. */
  28892. dispose(): void;
  28893. }
  28894. }
  28895. declare module "babylonjs/Materials/effect" {
  28896. import { Observable } from "babylonjs/Misc/observable";
  28897. import { Nullable } from "babylonjs/types";
  28898. import { IDisposable } from "babylonjs/scene";
  28899. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  28900. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  28901. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  28902. import { Engine } from "babylonjs/Engines/engine";
  28903. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28904. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28905. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  28906. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  28907. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28908. /**
  28909. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  28910. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  28911. */
  28912. export class EffectFallbacks {
  28913. private _defines;
  28914. private _currentRank;
  28915. private _maxRank;
  28916. private _mesh;
  28917. /**
  28918. * Removes the fallback from the bound mesh.
  28919. */
  28920. unBindMesh(): void;
  28921. /**
  28922. * Adds a fallback on the specified property.
  28923. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  28924. * @param define The name of the define in the shader
  28925. */
  28926. addFallback(rank: number, define: string): void;
  28927. /**
  28928. * Sets the mesh to use CPU skinning when needing to fallback.
  28929. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  28930. * @param mesh The mesh to use the fallbacks.
  28931. */
  28932. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  28933. /**
  28934. * Checks to see if more fallbacks are still availible.
  28935. */
  28936. readonly isMoreFallbacks: boolean;
  28937. /**
  28938. * Removes the defines that should be removed when falling back.
  28939. * @param currentDefines defines the current define statements for the shader.
  28940. * @param effect defines the current effect we try to compile
  28941. * @returns The resulting defines with defines of the current rank removed.
  28942. */
  28943. reduce(currentDefines: string, effect: Effect): string;
  28944. }
  28945. /**
  28946. * Options to be used when creating an effect.
  28947. */
  28948. export class EffectCreationOptions {
  28949. /**
  28950. * Atrributes that will be used in the shader.
  28951. */
  28952. attributes: string[];
  28953. /**
  28954. * Uniform varible names that will be set in the shader.
  28955. */
  28956. uniformsNames: string[];
  28957. /**
  28958. * Uniform buffer varible names that will be set in the shader.
  28959. */
  28960. uniformBuffersNames: string[];
  28961. /**
  28962. * Sampler texture variable names that will be set in the shader.
  28963. */
  28964. samplers: string[];
  28965. /**
  28966. * Define statements that will be set in the shader.
  28967. */
  28968. defines: any;
  28969. /**
  28970. * Possible fallbacks for this effect to improve performance when needed.
  28971. */
  28972. fallbacks: Nullable<EffectFallbacks>;
  28973. /**
  28974. * Callback that will be called when the shader is compiled.
  28975. */
  28976. onCompiled: Nullable<(effect: Effect) => void>;
  28977. /**
  28978. * Callback that will be called if an error occurs during shader compilation.
  28979. */
  28980. onError: Nullable<(effect: Effect, errors: string) => void>;
  28981. /**
  28982. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  28983. */
  28984. indexParameters: any;
  28985. /**
  28986. * Max number of lights that can be used in the shader.
  28987. */
  28988. maxSimultaneousLights: number;
  28989. /**
  28990. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  28991. */
  28992. transformFeedbackVaryings: Nullable<string[]>;
  28993. }
  28994. /**
  28995. * Effect containing vertex and fragment shader that can be executed on an object.
  28996. */
  28997. export class Effect implements IDisposable {
  28998. /**
  28999. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29000. */
  29001. static ShadersRepository: string;
  29002. /**
  29003. * Name of the effect.
  29004. */
  29005. name: any;
  29006. /**
  29007. * String container all the define statements that should be set on the shader.
  29008. */
  29009. defines: string;
  29010. /**
  29011. * Callback that will be called when the shader is compiled.
  29012. */
  29013. onCompiled: Nullable<(effect: Effect) => void>;
  29014. /**
  29015. * Callback that will be called if an error occurs during shader compilation.
  29016. */
  29017. onError: Nullable<(effect: Effect, errors: string) => void>;
  29018. /**
  29019. * Callback that will be called when effect is bound.
  29020. */
  29021. onBind: Nullable<(effect: Effect) => void>;
  29022. /**
  29023. * Unique ID of the effect.
  29024. */
  29025. uniqueId: number;
  29026. /**
  29027. * Observable that will be called when the shader is compiled.
  29028. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29029. */
  29030. onCompileObservable: Observable<Effect>;
  29031. /**
  29032. * Observable that will be called if an error occurs during shader compilation.
  29033. */
  29034. onErrorObservable: Observable<Effect>;
  29035. /** @hidden */
  29036. _onBindObservable: Nullable<Observable<Effect>>;
  29037. /**
  29038. * Observable that will be called when effect is bound.
  29039. */
  29040. readonly onBindObservable: Observable<Effect>;
  29041. /** @hidden */
  29042. _bonesComputationForcedToCPU: boolean;
  29043. private static _uniqueIdSeed;
  29044. private _engine;
  29045. private _uniformBuffersNames;
  29046. private _uniformsNames;
  29047. private _samplerList;
  29048. private _samplers;
  29049. private _isReady;
  29050. private _compilationError;
  29051. private _attributesNames;
  29052. private _attributes;
  29053. private _uniforms;
  29054. /**
  29055. * Key for the effect.
  29056. * @hidden
  29057. */
  29058. _key: string;
  29059. private _indexParameters;
  29060. private _fallbacks;
  29061. private _vertexSourceCode;
  29062. private _fragmentSourceCode;
  29063. private _vertexSourceCodeOverride;
  29064. private _fragmentSourceCodeOverride;
  29065. private _transformFeedbackVaryings;
  29066. /**
  29067. * Compiled shader to webGL program.
  29068. * @hidden
  29069. */
  29070. _pipelineContext: Nullable<IPipelineContext>;
  29071. private _valueCache;
  29072. private static _baseCache;
  29073. /**
  29074. * Instantiates an effect.
  29075. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29076. * @param baseName Name of the effect.
  29077. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29078. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29079. * @param samplers List of sampler variables that will be passed to the shader.
  29080. * @param engine Engine to be used to render the effect
  29081. * @param defines Define statements to be added to the shader.
  29082. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29083. * @param onCompiled Callback that will be called when the shader is compiled.
  29084. * @param onError Callback that will be called if an error occurs during shader compilation.
  29085. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29086. */
  29087. constructor(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: Nullable<string[]>, engine?: Engine, defines?: Nullable<string>, fallbacks?: Nullable<EffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  29088. private _useFinalCode;
  29089. /**
  29090. * Unique key for this effect
  29091. */
  29092. readonly key: string;
  29093. /**
  29094. * If the effect has been compiled and prepared.
  29095. * @returns if the effect is compiled and prepared.
  29096. */
  29097. isReady(): boolean;
  29098. /**
  29099. * The engine the effect was initialized with.
  29100. * @returns the engine.
  29101. */
  29102. getEngine(): Engine;
  29103. /**
  29104. * The pipeline context for this effect
  29105. * @returns the associated pipeline context
  29106. */
  29107. getPipelineContext(): Nullable<IPipelineContext>;
  29108. /**
  29109. * The set of names of attribute variables for the shader.
  29110. * @returns An array of attribute names.
  29111. */
  29112. getAttributesNames(): string[];
  29113. /**
  29114. * Returns the attribute at the given index.
  29115. * @param index The index of the attribute.
  29116. * @returns The location of the attribute.
  29117. */
  29118. getAttributeLocation(index: number): number;
  29119. /**
  29120. * Returns the attribute based on the name of the variable.
  29121. * @param name of the attribute to look up.
  29122. * @returns the attribute location.
  29123. */
  29124. getAttributeLocationByName(name: string): number;
  29125. /**
  29126. * The number of attributes.
  29127. * @returns the numnber of attributes.
  29128. */
  29129. getAttributesCount(): number;
  29130. /**
  29131. * Gets the index of a uniform variable.
  29132. * @param uniformName of the uniform to look up.
  29133. * @returns the index.
  29134. */
  29135. getUniformIndex(uniformName: string): number;
  29136. /**
  29137. * Returns the attribute based on the name of the variable.
  29138. * @param uniformName of the uniform to look up.
  29139. * @returns the location of the uniform.
  29140. */
  29141. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29142. /**
  29143. * Returns an array of sampler variable names
  29144. * @returns The array of sampler variable neames.
  29145. */
  29146. getSamplers(): string[];
  29147. /**
  29148. * The error from the last compilation.
  29149. * @returns the error string.
  29150. */
  29151. getCompilationError(): string;
  29152. /**
  29153. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29154. * @param func The callback to be used.
  29155. */
  29156. executeWhenCompiled(func: (effect: Effect) => void): void;
  29157. private _checkIsReady;
  29158. /** @hidden */
  29159. _loadVertexShader(vertex: any, callback: (data: any) => void): void;
  29160. /** @hidden */
  29161. _loadFragmentShader(fragment: any, callback: (data: any) => void): void;
  29162. /** @hidden */
  29163. _dumpShadersSource(vertexCode: string, fragmentCode: string, defines: string): void;
  29164. /**
  29165. * Recompiles the webGL program
  29166. * @param vertexSourceCode The source code for the vertex shader.
  29167. * @param fragmentSourceCode The source code for the fragment shader.
  29168. * @param onCompiled Callback called when completed.
  29169. * @param onError Callback called on error.
  29170. * @hidden
  29171. */
  29172. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29173. /**
  29174. * Prepares the effect
  29175. * @hidden
  29176. */
  29177. _prepareEffect(): void;
  29178. /**
  29179. * Checks if the effect is supported. (Must be called after compilation)
  29180. */
  29181. readonly isSupported: boolean;
  29182. /**
  29183. * Binds a texture to the engine to be used as output of the shader.
  29184. * @param channel Name of the output variable.
  29185. * @param texture Texture to bind.
  29186. * @hidden
  29187. */
  29188. _bindTexture(channel: string, texture: InternalTexture): void;
  29189. /**
  29190. * Sets a texture on the engine to be used in the shader.
  29191. * @param channel Name of the sampler variable.
  29192. * @param texture Texture to set.
  29193. */
  29194. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29195. /**
  29196. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29197. * @param channel Name of the sampler variable.
  29198. * @param texture Texture to set.
  29199. */
  29200. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29201. /**
  29202. * Sets an array of textures on the engine to be used in the shader.
  29203. * @param channel Name of the variable.
  29204. * @param textures Textures to set.
  29205. */
  29206. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29207. /**
  29208. * 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)
  29209. * @param channel Name of the sampler variable.
  29210. * @param postProcess Post process to get the input texture from.
  29211. */
  29212. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29213. /**
  29214. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29215. * 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)
  29216. * @param channel Name of the sampler variable.
  29217. * @param postProcess Post process to get the output texture from.
  29218. */
  29219. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29220. /** @hidden */
  29221. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29222. /** @hidden */
  29223. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29224. /** @hidden */
  29225. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29226. /** @hidden */
  29227. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29228. /**
  29229. * Binds a buffer to a uniform.
  29230. * @param buffer Buffer to bind.
  29231. * @param name Name of the uniform variable to bind to.
  29232. */
  29233. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29234. /**
  29235. * Binds block to a uniform.
  29236. * @param blockName Name of the block to bind.
  29237. * @param index Index to bind.
  29238. */
  29239. bindUniformBlock(blockName: string, index: number): void;
  29240. /**
  29241. * Sets an interger value on a uniform variable.
  29242. * @param uniformName Name of the variable.
  29243. * @param value Value to be set.
  29244. * @returns this effect.
  29245. */
  29246. setInt(uniformName: string, value: number): Effect;
  29247. /**
  29248. * Sets an int array on a uniform variable.
  29249. * @param uniformName Name of the variable.
  29250. * @param array array to be set.
  29251. * @returns this effect.
  29252. */
  29253. setIntArray(uniformName: string, array: Int32Array): Effect;
  29254. /**
  29255. * 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)
  29256. * @param uniformName Name of the variable.
  29257. * @param array array to be set.
  29258. * @returns this effect.
  29259. */
  29260. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29261. /**
  29262. * 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)
  29263. * @param uniformName Name of the variable.
  29264. * @param array array to be set.
  29265. * @returns this effect.
  29266. */
  29267. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29268. /**
  29269. * 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)
  29270. * @param uniformName Name of the variable.
  29271. * @param array array to be set.
  29272. * @returns this effect.
  29273. */
  29274. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29275. /**
  29276. * Sets an float array on a uniform variable.
  29277. * @param uniformName Name of the variable.
  29278. * @param array array to be set.
  29279. * @returns this effect.
  29280. */
  29281. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29282. /**
  29283. * 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)
  29284. * @param uniformName Name of the variable.
  29285. * @param array array to be set.
  29286. * @returns this effect.
  29287. */
  29288. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29289. /**
  29290. * 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)
  29291. * @param uniformName Name of the variable.
  29292. * @param array array to be set.
  29293. * @returns this effect.
  29294. */
  29295. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29296. /**
  29297. * 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)
  29298. * @param uniformName Name of the variable.
  29299. * @param array array to be set.
  29300. * @returns this effect.
  29301. */
  29302. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29303. /**
  29304. * Sets an array on a uniform variable.
  29305. * @param uniformName Name of the variable.
  29306. * @param array array to be set.
  29307. * @returns this effect.
  29308. */
  29309. setArray(uniformName: string, array: number[]): Effect;
  29310. /**
  29311. * 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)
  29312. * @param uniformName Name of the variable.
  29313. * @param array array to be set.
  29314. * @returns this effect.
  29315. */
  29316. setArray2(uniformName: string, array: number[]): Effect;
  29317. /**
  29318. * 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)
  29319. * @param uniformName Name of the variable.
  29320. * @param array array to be set.
  29321. * @returns this effect.
  29322. */
  29323. setArray3(uniformName: string, array: number[]): Effect;
  29324. /**
  29325. * 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)
  29326. * @param uniformName Name of the variable.
  29327. * @param array array to be set.
  29328. * @returns this effect.
  29329. */
  29330. setArray4(uniformName: string, array: number[]): Effect;
  29331. /**
  29332. * Sets matrices on a uniform variable.
  29333. * @param uniformName Name of the variable.
  29334. * @param matrices matrices to be set.
  29335. * @returns this effect.
  29336. */
  29337. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29338. /**
  29339. * Sets matrix on a uniform variable.
  29340. * @param uniformName Name of the variable.
  29341. * @param matrix matrix to be set.
  29342. * @returns this effect.
  29343. */
  29344. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29345. /**
  29346. * 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)
  29347. * @param uniformName Name of the variable.
  29348. * @param matrix matrix to be set.
  29349. * @returns this effect.
  29350. */
  29351. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29352. /**
  29353. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29354. * @param uniformName Name of the variable.
  29355. * @param matrix matrix to be set.
  29356. * @returns this effect.
  29357. */
  29358. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29359. /**
  29360. * Sets a float on a uniform variable.
  29361. * @param uniformName Name of the variable.
  29362. * @param value value to be set.
  29363. * @returns this effect.
  29364. */
  29365. setFloat(uniformName: string, value: number): Effect;
  29366. /**
  29367. * Sets a boolean on a uniform variable.
  29368. * @param uniformName Name of the variable.
  29369. * @param bool value to be set.
  29370. * @returns this effect.
  29371. */
  29372. setBool(uniformName: string, bool: boolean): Effect;
  29373. /**
  29374. * Sets a Vector2 on a uniform variable.
  29375. * @param uniformName Name of the variable.
  29376. * @param vector2 vector2 to be set.
  29377. * @returns this effect.
  29378. */
  29379. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29380. /**
  29381. * Sets a float2 on a uniform variable.
  29382. * @param uniformName Name of the variable.
  29383. * @param x First float in float2.
  29384. * @param y Second float in float2.
  29385. * @returns this effect.
  29386. */
  29387. setFloat2(uniformName: string, x: number, y: number): Effect;
  29388. /**
  29389. * Sets a Vector3 on a uniform variable.
  29390. * @param uniformName Name of the variable.
  29391. * @param vector3 Value to be set.
  29392. * @returns this effect.
  29393. */
  29394. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29395. /**
  29396. * Sets a float3 on a uniform variable.
  29397. * @param uniformName Name of the variable.
  29398. * @param x First float in float3.
  29399. * @param y Second float in float3.
  29400. * @param z Third float in float3.
  29401. * @returns this effect.
  29402. */
  29403. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29404. /**
  29405. * Sets a Vector4 on a uniform variable.
  29406. * @param uniformName Name of the variable.
  29407. * @param vector4 Value to be set.
  29408. * @returns this effect.
  29409. */
  29410. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29411. /**
  29412. * Sets a float4 on a uniform variable.
  29413. * @param uniformName Name of the variable.
  29414. * @param x First float in float4.
  29415. * @param y Second float in float4.
  29416. * @param z Third float in float4.
  29417. * @param w Fourth float in float4.
  29418. * @returns this effect.
  29419. */
  29420. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29421. /**
  29422. * Sets a Color3 on a uniform variable.
  29423. * @param uniformName Name of the variable.
  29424. * @param color3 Value to be set.
  29425. * @returns this effect.
  29426. */
  29427. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29428. /**
  29429. * Sets a Color4 on a uniform variable.
  29430. * @param uniformName Name of the variable.
  29431. * @param color3 Value to be set.
  29432. * @param alpha Alpha value to be set.
  29433. * @returns this effect.
  29434. */
  29435. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29436. /**
  29437. * Sets a Color4 on a uniform variable
  29438. * @param uniformName defines the name of the variable
  29439. * @param color4 defines the value to be set
  29440. * @returns this effect.
  29441. */
  29442. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29443. /** Release all associated resources */
  29444. dispose(): void;
  29445. /**
  29446. * This function will add a new shader to the shader store
  29447. * @param name the name of the shader
  29448. * @param pixelShader optional pixel shader content
  29449. * @param vertexShader optional vertex shader content
  29450. */
  29451. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29452. /**
  29453. * Store of each shader (The can be looked up using effect.key)
  29454. */
  29455. static ShadersStore: {
  29456. [key: string]: string;
  29457. };
  29458. /**
  29459. * Store of each included file for a shader (The can be looked up using effect.key)
  29460. */
  29461. static IncludesShadersStore: {
  29462. [key: string]: string;
  29463. };
  29464. /**
  29465. * Resets the cache of effects.
  29466. */
  29467. static ResetCache(): void;
  29468. }
  29469. }
  29470. declare module "babylonjs/Materials/uniformBuffer" {
  29471. import { Nullable, FloatArray } from "babylonjs/types";
  29472. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  29473. import { Engine } from "babylonjs/Engines/engine";
  29474. import { Effect } from "babylonjs/Materials/effect";
  29475. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29476. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29477. import { Color3 } from "babylonjs/Maths/math.color";
  29478. /**
  29479. * Uniform buffer objects.
  29480. *
  29481. * Handles blocks of uniform on the GPU.
  29482. *
  29483. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  29484. *
  29485. * For more information, please refer to :
  29486. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  29487. */
  29488. export class UniformBuffer {
  29489. private _engine;
  29490. private _buffer;
  29491. private _data;
  29492. private _bufferData;
  29493. private _dynamic?;
  29494. private _uniformLocations;
  29495. private _uniformSizes;
  29496. private _uniformLocationPointer;
  29497. private _needSync;
  29498. private _noUBO;
  29499. private _currentEffect;
  29500. private static _MAX_UNIFORM_SIZE;
  29501. private static _tempBuffer;
  29502. /**
  29503. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  29504. * This is dynamic to allow compat with webgl 1 and 2.
  29505. * You will need to pass the name of the uniform as well as the value.
  29506. */
  29507. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  29508. /**
  29509. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  29510. * This is dynamic to allow compat with webgl 1 and 2.
  29511. * You will need to pass the name of the uniform as well as the value.
  29512. */
  29513. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  29514. /**
  29515. * Lambda to Update a single float in a uniform buffer.
  29516. * This is dynamic to allow compat with webgl 1 and 2.
  29517. * You will need to pass the name of the uniform as well as the value.
  29518. */
  29519. updateFloat: (name: string, x: number) => void;
  29520. /**
  29521. * Lambda to Update a vec2 of float in a uniform buffer.
  29522. * This is dynamic to allow compat with webgl 1 and 2.
  29523. * You will need to pass the name of the uniform as well as the value.
  29524. */
  29525. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  29526. /**
  29527. * Lambda to Update a vec3 of float in a uniform buffer.
  29528. * This is dynamic to allow compat with webgl 1 and 2.
  29529. * You will need to pass the name of the uniform as well as the value.
  29530. */
  29531. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  29532. /**
  29533. * Lambda to Update a vec4 of float in a uniform buffer.
  29534. * This is dynamic to allow compat with webgl 1 and 2.
  29535. * You will need to pass the name of the uniform as well as the value.
  29536. */
  29537. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  29538. /**
  29539. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  29540. * This is dynamic to allow compat with webgl 1 and 2.
  29541. * You will need to pass the name of the uniform as well as the value.
  29542. */
  29543. updateMatrix: (name: string, mat: Matrix) => void;
  29544. /**
  29545. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  29546. * This is dynamic to allow compat with webgl 1 and 2.
  29547. * You will need to pass the name of the uniform as well as the value.
  29548. */
  29549. updateVector3: (name: string, vector: Vector3) => void;
  29550. /**
  29551. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  29552. * This is dynamic to allow compat with webgl 1 and 2.
  29553. * You will need to pass the name of the uniform as well as the value.
  29554. */
  29555. updateVector4: (name: string, vector: Vector4) => void;
  29556. /**
  29557. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  29558. * This is dynamic to allow compat with webgl 1 and 2.
  29559. * You will need to pass the name of the uniform as well as the value.
  29560. */
  29561. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  29562. /**
  29563. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  29564. * This is dynamic to allow compat with webgl 1 and 2.
  29565. * You will need to pass the name of the uniform as well as the value.
  29566. */
  29567. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  29568. /**
  29569. * Instantiates a new Uniform buffer objects.
  29570. *
  29571. * Handles blocks of uniform on the GPU.
  29572. *
  29573. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  29574. *
  29575. * For more information, please refer to :
  29576. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  29577. * @param engine Define the engine the buffer is associated with
  29578. * @param data Define the data contained in the buffer
  29579. * @param dynamic Define if the buffer is updatable
  29580. */
  29581. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  29582. /**
  29583. * Indicates if the buffer is using the WebGL2 UBO implementation,
  29584. * or just falling back on setUniformXXX calls.
  29585. */
  29586. readonly useUbo: boolean;
  29587. /**
  29588. * Indicates if the WebGL underlying uniform buffer is in sync
  29589. * with the javascript cache data.
  29590. */
  29591. readonly isSync: boolean;
  29592. /**
  29593. * Indicates if the WebGL underlying uniform buffer is dynamic.
  29594. * Also, a dynamic UniformBuffer will disable cache verification and always
  29595. * update the underlying WebGL uniform buffer to the GPU.
  29596. * @returns if Dynamic, otherwise false
  29597. */
  29598. isDynamic(): boolean;
  29599. /**
  29600. * The data cache on JS side.
  29601. * @returns the underlying data as a float array
  29602. */
  29603. getData(): Float32Array;
  29604. /**
  29605. * The underlying WebGL Uniform buffer.
  29606. * @returns the webgl buffer
  29607. */
  29608. getBuffer(): Nullable<DataBuffer>;
  29609. /**
  29610. * std140 layout specifies how to align data within an UBO structure.
  29611. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  29612. * for specs.
  29613. */
  29614. private _fillAlignment;
  29615. /**
  29616. * Adds an uniform in the buffer.
  29617. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  29618. * for the layout to be correct !
  29619. * @param name Name of the uniform, as used in the uniform block in the shader.
  29620. * @param size Data size, or data directly.
  29621. */
  29622. addUniform(name: string, size: number | number[]): void;
  29623. /**
  29624. * Adds a Matrix 4x4 to the uniform buffer.
  29625. * @param name Name of the uniform, as used in the uniform block in the shader.
  29626. * @param mat A 4x4 matrix.
  29627. */
  29628. addMatrix(name: string, mat: Matrix): void;
  29629. /**
  29630. * Adds a vec2 to the uniform buffer.
  29631. * @param name Name of the uniform, as used in the uniform block in the shader.
  29632. * @param x Define the x component value of the vec2
  29633. * @param y Define the y component value of the vec2
  29634. */
  29635. addFloat2(name: string, x: number, y: number): void;
  29636. /**
  29637. * Adds a vec3 to the uniform buffer.
  29638. * @param name Name of the uniform, as used in the uniform block in the shader.
  29639. * @param x Define the x component value of the vec3
  29640. * @param y Define the y component value of the vec3
  29641. * @param z Define the z component value of the vec3
  29642. */
  29643. addFloat3(name: string, x: number, y: number, z: number): void;
  29644. /**
  29645. * Adds a vec3 to the uniform buffer.
  29646. * @param name Name of the uniform, as used in the uniform block in the shader.
  29647. * @param color Define the vec3 from a Color
  29648. */
  29649. addColor3(name: string, color: Color3): void;
  29650. /**
  29651. * Adds a vec4 to the uniform buffer.
  29652. * @param name Name of the uniform, as used in the uniform block in the shader.
  29653. * @param color Define the rgb components from a Color
  29654. * @param alpha Define the a component of the vec4
  29655. */
  29656. addColor4(name: string, color: Color3, alpha: number): void;
  29657. /**
  29658. * Adds a vec3 to the uniform buffer.
  29659. * @param name Name of the uniform, as used in the uniform block in the shader.
  29660. * @param vector Define the vec3 components from a Vector
  29661. */
  29662. addVector3(name: string, vector: Vector3): void;
  29663. /**
  29664. * Adds a Matrix 3x3 to the uniform buffer.
  29665. * @param name Name of the uniform, as used in the uniform block in the shader.
  29666. */
  29667. addMatrix3x3(name: string): void;
  29668. /**
  29669. * Adds a Matrix 2x2 to the uniform buffer.
  29670. * @param name Name of the uniform, as used in the uniform block in the shader.
  29671. */
  29672. addMatrix2x2(name: string): void;
  29673. /**
  29674. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  29675. */
  29676. create(): void;
  29677. /** @hidden */
  29678. _rebuild(): void;
  29679. /**
  29680. * Updates the WebGL Uniform Buffer on the GPU.
  29681. * If the `dynamic` flag is set to true, no cache comparison is done.
  29682. * Otherwise, the buffer will be updated only if the cache differs.
  29683. */
  29684. update(): void;
  29685. /**
  29686. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  29687. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  29688. * @param data Define the flattened data
  29689. * @param size Define the size of the data.
  29690. */
  29691. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  29692. private _updateMatrix3x3ForUniform;
  29693. private _updateMatrix3x3ForEffect;
  29694. private _updateMatrix2x2ForEffect;
  29695. private _updateMatrix2x2ForUniform;
  29696. private _updateFloatForEffect;
  29697. private _updateFloatForUniform;
  29698. private _updateFloat2ForEffect;
  29699. private _updateFloat2ForUniform;
  29700. private _updateFloat3ForEffect;
  29701. private _updateFloat3ForUniform;
  29702. private _updateFloat4ForEffect;
  29703. private _updateFloat4ForUniform;
  29704. private _updateMatrixForEffect;
  29705. private _updateMatrixForUniform;
  29706. private _updateVector3ForEffect;
  29707. private _updateVector3ForUniform;
  29708. private _updateVector4ForEffect;
  29709. private _updateVector4ForUniform;
  29710. private _updateColor3ForEffect;
  29711. private _updateColor3ForUniform;
  29712. private _updateColor4ForEffect;
  29713. private _updateColor4ForUniform;
  29714. /**
  29715. * Sets a sampler uniform on the effect.
  29716. * @param name Define the name of the sampler.
  29717. * @param texture Define the texture to set in the sampler
  29718. */
  29719. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  29720. /**
  29721. * Directly updates the value of the uniform in the cache AND on the GPU.
  29722. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  29723. * @param data Define the flattened data
  29724. */
  29725. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  29726. /**
  29727. * Binds this uniform buffer to an effect.
  29728. * @param effect Define the effect to bind the buffer to
  29729. * @param name Name of the uniform block in the shader.
  29730. */
  29731. bindToEffect(effect: Effect, name: string): void;
  29732. /**
  29733. * Disposes the uniform buffer.
  29734. */
  29735. dispose(): void;
  29736. }
  29737. }
  29738. declare module "babylonjs/Audio/analyser" {
  29739. import { Scene } from "babylonjs/scene";
  29740. /**
  29741. * Class used to work with sound analyzer using fast fourier transform (FFT)
  29742. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29743. */
  29744. export class Analyser {
  29745. /**
  29746. * Gets or sets the smoothing
  29747. * @ignorenaming
  29748. */
  29749. SMOOTHING: number;
  29750. /**
  29751. * Gets or sets the FFT table size
  29752. * @ignorenaming
  29753. */
  29754. FFT_SIZE: number;
  29755. /**
  29756. * Gets or sets the bar graph amplitude
  29757. * @ignorenaming
  29758. */
  29759. BARGRAPHAMPLITUDE: number;
  29760. /**
  29761. * Gets or sets the position of the debug canvas
  29762. * @ignorenaming
  29763. */
  29764. DEBUGCANVASPOS: {
  29765. x: number;
  29766. y: number;
  29767. };
  29768. /**
  29769. * Gets or sets the debug canvas size
  29770. * @ignorenaming
  29771. */
  29772. DEBUGCANVASSIZE: {
  29773. width: number;
  29774. height: number;
  29775. };
  29776. private _byteFreqs;
  29777. private _byteTime;
  29778. private _floatFreqs;
  29779. private _webAudioAnalyser;
  29780. private _debugCanvas;
  29781. private _debugCanvasContext;
  29782. private _scene;
  29783. private _registerFunc;
  29784. private _audioEngine;
  29785. /**
  29786. * Creates a new analyser
  29787. * @param scene defines hosting scene
  29788. */
  29789. constructor(scene: Scene);
  29790. /**
  29791. * Get the number of data values you will have to play with for the visualization
  29792. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  29793. * @returns a number
  29794. */
  29795. getFrequencyBinCount(): number;
  29796. /**
  29797. * Gets the current frequency data as a byte array
  29798. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  29799. * @returns a Uint8Array
  29800. */
  29801. getByteFrequencyData(): Uint8Array;
  29802. /**
  29803. * Gets the current waveform as a byte array
  29804. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  29805. * @returns a Uint8Array
  29806. */
  29807. getByteTimeDomainData(): Uint8Array;
  29808. /**
  29809. * Gets the current frequency data as a float array
  29810. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  29811. * @returns a Float32Array
  29812. */
  29813. getFloatFrequencyData(): Float32Array;
  29814. /**
  29815. * Renders the debug canvas
  29816. */
  29817. drawDebugCanvas(): void;
  29818. /**
  29819. * Stops rendering the debug canvas and removes it
  29820. */
  29821. stopDebugCanvas(): void;
  29822. /**
  29823. * Connects two audio nodes
  29824. * @param inputAudioNode defines first node to connect
  29825. * @param outputAudioNode defines second node to connect
  29826. */
  29827. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  29828. /**
  29829. * Releases all associated resources
  29830. */
  29831. dispose(): void;
  29832. }
  29833. }
  29834. declare module "babylonjs/Audio/audioEngine" {
  29835. import { IDisposable } from "babylonjs/scene";
  29836. import { Analyser } from "babylonjs/Audio/analyser";
  29837. import { Nullable } from "babylonjs/types";
  29838. import { Observable } from "babylonjs/Misc/observable";
  29839. /**
  29840. * This represents an audio engine and it is responsible
  29841. * to play, synchronize and analyse sounds throughout the application.
  29842. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29843. */
  29844. export interface IAudioEngine extends IDisposable {
  29845. /**
  29846. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  29847. */
  29848. readonly canUseWebAudio: boolean;
  29849. /**
  29850. * Gets the current AudioContext if available.
  29851. */
  29852. readonly audioContext: Nullable<AudioContext>;
  29853. /**
  29854. * The master gain node defines the global audio volume of your audio engine.
  29855. */
  29856. readonly masterGain: GainNode;
  29857. /**
  29858. * Gets whether or not mp3 are supported by your browser.
  29859. */
  29860. readonly isMP3supported: boolean;
  29861. /**
  29862. * Gets whether or not ogg are supported by your browser.
  29863. */
  29864. readonly isOGGsupported: boolean;
  29865. /**
  29866. * Defines if Babylon should emit a warning if WebAudio is not supported.
  29867. * @ignoreNaming
  29868. */
  29869. WarnedWebAudioUnsupported: boolean;
  29870. /**
  29871. * Defines if the audio engine relies on a custom unlocked button.
  29872. * In this case, the embedded button will not be displayed.
  29873. */
  29874. useCustomUnlockedButton: boolean;
  29875. /**
  29876. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  29877. */
  29878. readonly unlocked: boolean;
  29879. /**
  29880. * Event raised when audio has been unlocked on the browser.
  29881. */
  29882. onAudioUnlockedObservable: Observable<AudioEngine>;
  29883. /**
  29884. * Event raised when audio has been locked on the browser.
  29885. */
  29886. onAudioLockedObservable: Observable<AudioEngine>;
  29887. /**
  29888. * Flags the audio engine in Locked state.
  29889. * This happens due to new browser policies preventing audio to autoplay.
  29890. */
  29891. lock(): void;
  29892. /**
  29893. * Unlocks the audio engine once a user action has been done on the dom.
  29894. * This is helpful to resume play once browser policies have been satisfied.
  29895. */
  29896. unlock(): void;
  29897. }
  29898. /**
  29899. * This represents the default audio engine used in babylon.
  29900. * It is responsible to play, synchronize and analyse sounds throughout the application.
  29901. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29902. */
  29903. export class AudioEngine implements IAudioEngine {
  29904. private _audioContext;
  29905. private _audioContextInitialized;
  29906. private _muteButton;
  29907. private _hostElement;
  29908. /**
  29909. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  29910. */
  29911. canUseWebAudio: boolean;
  29912. /**
  29913. * The master gain node defines the global audio volume of your audio engine.
  29914. */
  29915. masterGain: GainNode;
  29916. /**
  29917. * Defines if Babylon should emit a warning if WebAudio is not supported.
  29918. * @ignoreNaming
  29919. */
  29920. WarnedWebAudioUnsupported: boolean;
  29921. /**
  29922. * Gets whether or not mp3 are supported by your browser.
  29923. */
  29924. isMP3supported: boolean;
  29925. /**
  29926. * Gets whether or not ogg are supported by your browser.
  29927. */
  29928. isOGGsupported: boolean;
  29929. /**
  29930. * Gets whether audio has been unlocked on the device.
  29931. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  29932. * a user interaction has happened.
  29933. */
  29934. unlocked: boolean;
  29935. /**
  29936. * Defines if the audio engine relies on a custom unlocked button.
  29937. * In this case, the embedded button will not be displayed.
  29938. */
  29939. useCustomUnlockedButton: boolean;
  29940. /**
  29941. * Event raised when audio has been unlocked on the browser.
  29942. */
  29943. onAudioUnlockedObservable: Observable<AudioEngine>;
  29944. /**
  29945. * Event raised when audio has been locked on the browser.
  29946. */
  29947. onAudioLockedObservable: Observable<AudioEngine>;
  29948. /**
  29949. * Gets the current AudioContext if available.
  29950. */
  29951. readonly audioContext: Nullable<AudioContext>;
  29952. private _connectedAnalyser;
  29953. /**
  29954. * Instantiates a new audio engine.
  29955. *
  29956. * There should be only one per page as some browsers restrict the number
  29957. * of audio contexts you can create.
  29958. * @param hostElement defines the host element where to display the mute icon if necessary
  29959. */
  29960. constructor(hostElement?: Nullable<HTMLElement>);
  29961. /**
  29962. * Flags the audio engine in Locked state.
  29963. * This happens due to new browser policies preventing audio to autoplay.
  29964. */
  29965. lock(): void;
  29966. /**
  29967. * Unlocks the audio engine once a user action has been done on the dom.
  29968. * This is helpful to resume play once browser policies have been satisfied.
  29969. */
  29970. unlock(): void;
  29971. private _resumeAudioContext;
  29972. private _initializeAudioContext;
  29973. private _tryToRun;
  29974. private _triggerRunningState;
  29975. private _triggerSuspendedState;
  29976. private _displayMuteButton;
  29977. private _moveButtonToTopLeft;
  29978. private _onResize;
  29979. private _hideMuteButton;
  29980. /**
  29981. * Destroy and release the resources associated with the audio ccontext.
  29982. */
  29983. dispose(): void;
  29984. /**
  29985. * Gets the global volume sets on the master gain.
  29986. * @returns the global volume if set or -1 otherwise
  29987. */
  29988. getGlobalVolume(): number;
  29989. /**
  29990. * Sets the global volume of your experience (sets on the master gain).
  29991. * @param newVolume Defines the new global volume of the application
  29992. */
  29993. setGlobalVolume(newVolume: number): void;
  29994. /**
  29995. * Connect the audio engine to an audio analyser allowing some amazing
  29996. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  29997. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  29998. * @param analyser The analyser to connect to the engine
  29999. */
  30000. connectToAnalyser(analyser: Analyser): void;
  30001. }
  30002. }
  30003. declare module "babylonjs/Loading/loadingScreen" {
  30004. /**
  30005. * Interface used to present a loading screen while loading a scene
  30006. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  30007. */
  30008. export interface ILoadingScreen {
  30009. /**
  30010. * Function called to display the loading screen
  30011. */
  30012. displayLoadingUI: () => void;
  30013. /**
  30014. * Function called to hide the loading screen
  30015. */
  30016. hideLoadingUI: () => void;
  30017. /**
  30018. * Gets or sets the color to use for the background
  30019. */
  30020. loadingUIBackgroundColor: string;
  30021. /**
  30022. * Gets or sets the text to display while loading
  30023. */
  30024. loadingUIText: string;
  30025. }
  30026. /**
  30027. * Class used for the default loading screen
  30028. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  30029. */
  30030. export class DefaultLoadingScreen implements ILoadingScreen {
  30031. private _renderingCanvas;
  30032. private _loadingText;
  30033. private _loadingDivBackgroundColor;
  30034. private _loadingDiv;
  30035. private _loadingTextDiv;
  30036. /** Gets or sets the logo url to use for the default loading screen */
  30037. static DefaultLogoUrl: string;
  30038. /** Gets or sets the spinner url to use for the default loading screen */
  30039. static DefaultSpinnerUrl: string;
  30040. /**
  30041. * Creates a new default loading screen
  30042. * @param _renderingCanvas defines the canvas used to render the scene
  30043. * @param _loadingText defines the default text to display
  30044. * @param _loadingDivBackgroundColor defines the default background color
  30045. */
  30046. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  30047. /**
  30048. * Function called to display the loading screen
  30049. */
  30050. displayLoadingUI(): void;
  30051. /**
  30052. * Function called to hide the loading screen
  30053. */
  30054. hideLoadingUI(): void;
  30055. /**
  30056. * Gets or sets the text to display while loading
  30057. */
  30058. loadingUIText: string;
  30059. /**
  30060. * Gets or sets the color to use for the background
  30061. */
  30062. loadingUIBackgroundColor: string;
  30063. private _resizeLoadingUI;
  30064. }
  30065. }
  30066. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  30067. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30068. import { Engine } from "babylonjs/Engines/engine";
  30069. import { Nullable } from "babylonjs/types";
  30070. /** @hidden */
  30071. export class WebGLPipelineContext implements IPipelineContext {
  30072. engine: Engine;
  30073. program: Nullable<WebGLProgram>;
  30074. context?: WebGLRenderingContext;
  30075. vertexShader?: WebGLShader;
  30076. fragmentShader?: WebGLShader;
  30077. isParallelCompiled: boolean;
  30078. onCompiled?: () => void;
  30079. transformFeedback?: WebGLTransformFeedback | null;
  30080. readonly isAsync: boolean;
  30081. readonly isReady: boolean;
  30082. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  30083. }
  30084. }
  30085. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  30086. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30087. /** @hidden */
  30088. export class WebGLDataBuffer extends DataBuffer {
  30089. private _buffer;
  30090. constructor(resource: WebGLBuffer);
  30091. readonly underlyingResource: any;
  30092. }
  30093. }
  30094. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  30095. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30096. /** @hidden */
  30097. export class WebGL2ShaderProcessor implements IShaderProcessor {
  30098. attributeProcessor(attribute: string): string;
  30099. varyingProcessor(varying: string, isFragment: boolean): string;
  30100. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  30101. }
  30102. }
  30103. declare module "babylonjs/Misc/perfCounter" {
  30104. /**
  30105. * This class is used to track a performance counter which is number based.
  30106. * The user has access to many properties which give statistics of different nature.
  30107. *
  30108. * The implementer can track two kinds of Performance Counter: time and count.
  30109. * 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.
  30110. * 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.
  30111. */
  30112. export class PerfCounter {
  30113. /**
  30114. * Gets or sets a global boolean to turn on and off all the counters
  30115. */
  30116. static Enabled: boolean;
  30117. /**
  30118. * Returns the smallest value ever
  30119. */
  30120. readonly min: number;
  30121. /**
  30122. * Returns the biggest value ever
  30123. */
  30124. readonly max: number;
  30125. /**
  30126. * Returns the average value since the performance counter is running
  30127. */
  30128. readonly average: number;
  30129. /**
  30130. * Returns the average value of the last second the counter was monitored
  30131. */
  30132. readonly lastSecAverage: number;
  30133. /**
  30134. * Returns the current value
  30135. */
  30136. readonly current: number;
  30137. /**
  30138. * Gets the accumulated total
  30139. */
  30140. readonly total: number;
  30141. /**
  30142. * Gets the total value count
  30143. */
  30144. readonly count: number;
  30145. /**
  30146. * Creates a new counter
  30147. */
  30148. constructor();
  30149. /**
  30150. * Call this method to start monitoring a new frame.
  30151. * 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.
  30152. */
  30153. fetchNewFrame(): void;
  30154. /**
  30155. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  30156. * @param newCount the count value to add to the monitored count
  30157. * @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.
  30158. */
  30159. addCount(newCount: number, fetchResult: boolean): void;
  30160. /**
  30161. * Start monitoring this performance counter
  30162. */
  30163. beginMonitoring(): void;
  30164. /**
  30165. * Compute the time lapsed since the previous beginMonitoring() call.
  30166. * @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
  30167. */
  30168. endMonitoring(newFrame?: boolean): void;
  30169. private _fetchResult;
  30170. private _startMonitoringTime;
  30171. private _min;
  30172. private _max;
  30173. private _average;
  30174. private _current;
  30175. private _totalValueCount;
  30176. private _totalAccumulated;
  30177. private _lastSecAverage;
  30178. private _lastSecAccumulated;
  30179. private _lastSecTime;
  30180. private _lastSecValueCount;
  30181. }
  30182. }
  30183. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  30184. /**
  30185. * Interface for any object that can request an animation frame
  30186. */
  30187. export interface ICustomAnimationFrameRequester {
  30188. /**
  30189. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  30190. */
  30191. renderFunction?: Function;
  30192. /**
  30193. * Called to request the next frame to render to
  30194. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  30195. */
  30196. requestAnimationFrame: Function;
  30197. /**
  30198. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  30199. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  30200. */
  30201. requestID?: number;
  30202. }
  30203. }
  30204. declare module "babylonjs/Materials/Textures/videoTexture" {
  30205. import { Observable } from "babylonjs/Misc/observable";
  30206. import { Nullable } from "babylonjs/types";
  30207. import { Scene } from "babylonjs/scene";
  30208. import { Texture } from "babylonjs/Materials/Textures/texture";
  30209. /**
  30210. * Settings for finer control over video usage
  30211. */
  30212. export interface VideoTextureSettings {
  30213. /**
  30214. * Applies `autoplay` to video, if specified
  30215. */
  30216. autoPlay?: boolean;
  30217. /**
  30218. * Applies `loop` to video, if specified
  30219. */
  30220. loop?: boolean;
  30221. /**
  30222. * Automatically updates internal texture from video at every frame in the render loop
  30223. */
  30224. autoUpdateTexture: boolean;
  30225. /**
  30226. * Image src displayed during the video loading or until the user interacts with the video.
  30227. */
  30228. poster?: string;
  30229. }
  30230. /**
  30231. * If you want to display a video in your scene, this is the special texture for that.
  30232. * This special texture works similar to other textures, with the exception of a few parameters.
  30233. * @see https://doc.babylonjs.com/how_to/video_texture
  30234. */
  30235. export class VideoTexture extends Texture {
  30236. /**
  30237. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  30238. */
  30239. readonly autoUpdateTexture: boolean;
  30240. /**
  30241. * The video instance used by the texture internally
  30242. */
  30243. readonly video: HTMLVideoElement;
  30244. private _onUserActionRequestedObservable;
  30245. /**
  30246. * Event triggerd when a dom action is required by the user to play the video.
  30247. * This happens due to recent changes in browser policies preventing video to auto start.
  30248. */
  30249. readonly onUserActionRequestedObservable: Observable<Texture>;
  30250. private _generateMipMaps;
  30251. private _engine;
  30252. private _stillImageCaptured;
  30253. private _displayingPosterTexture;
  30254. private _settings;
  30255. private _createInternalTextureOnEvent;
  30256. /**
  30257. * Creates a video texture.
  30258. * If you want to display a video in your scene, this is the special texture for that.
  30259. * This special texture works similar to other textures, with the exception of a few parameters.
  30260. * @see https://doc.babylonjs.com/how_to/video_texture
  30261. * @param name optional name, will detect from video source, if not defined
  30262. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  30263. * @param scene is obviously the current scene.
  30264. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  30265. * @param invertY is false by default but can be used to invert video on Y axis
  30266. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  30267. * @param settings allows finer control over video usage
  30268. */
  30269. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  30270. private _getName;
  30271. private _getVideo;
  30272. private _createInternalTexture;
  30273. private reset;
  30274. /**
  30275. * @hidden Internal method to initiate `update`.
  30276. */
  30277. _rebuild(): void;
  30278. /**
  30279. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  30280. */
  30281. update(): void;
  30282. /**
  30283. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  30284. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  30285. */
  30286. updateTexture(isVisible: boolean): void;
  30287. protected _updateInternalTexture: () => void;
  30288. /**
  30289. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  30290. * @param url New url.
  30291. */
  30292. updateURL(url: string): void;
  30293. /**
  30294. * Dispose the texture and release its associated resources.
  30295. */
  30296. dispose(): void;
  30297. /**
  30298. * Creates a video texture straight from a stream.
  30299. * @param scene Define the scene the texture should be created in
  30300. * @param stream Define the stream the texture should be created from
  30301. * @returns The created video texture as a promise
  30302. */
  30303. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  30304. /**
  30305. * Creates a video texture straight from your WebCam video feed.
  30306. * @param scene Define the scene the texture should be created in
  30307. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30308. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30309. * @returns The created video texture as a promise
  30310. */
  30311. static CreateFromWebCamAsync(scene: Scene, constraints: {
  30312. minWidth: number;
  30313. maxWidth: number;
  30314. minHeight: number;
  30315. maxHeight: number;
  30316. deviceId: string;
  30317. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  30318. /**
  30319. * Creates a video texture straight from your WebCam video feed.
  30320. * @param scene Define the scene the texture should be created in
  30321. * @param onReady Define a callback to triggered once the texture will be ready
  30322. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30323. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30324. */
  30325. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  30326. minWidth: number;
  30327. maxWidth: number;
  30328. minHeight: number;
  30329. maxHeight: number;
  30330. deviceId: string;
  30331. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  30332. }
  30333. }
  30334. declare module "babylonjs/Engines/engine" {
  30335. import { Observable } from "babylonjs/Misc/observable";
  30336. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  30337. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  30338. import { Scene } from "babylonjs/scene";
  30339. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  30340. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  30341. import { Effect, EffectCreationOptions, EffectFallbacks } from "babylonjs/Materials/effect";
  30342. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  30343. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30345. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  30346. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  30347. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  30348. import { _DepthCullingState, _StencilState, _AlphaState } from "babylonjs/States/index";
  30349. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  30350. import { WebRequest } from "babylonjs/Misc/webRequest";
  30351. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  30352. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30353. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30354. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30355. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  30356. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  30357. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  30358. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  30359. import { Material } from "babylonjs/Materials/material";
  30360. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30361. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30362. /**
  30363. * Defines the interface used by objects containing a viewport (like a camera)
  30364. */
  30365. interface IViewportOwnerLike {
  30366. /**
  30367. * Gets or sets the viewport
  30368. */
  30369. viewport: IViewportLike;
  30370. }
  30371. /**
  30372. * Interface for attribute information associated with buffer instanciation
  30373. */
  30374. export class InstancingAttributeInfo {
  30375. /**
  30376. * Index/offset of the attribute in the vertex shader
  30377. */
  30378. index: number;
  30379. /**
  30380. * size of the attribute, 1, 2, 3 or 4
  30381. */
  30382. attributeSize: number;
  30383. /**
  30384. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  30385. * default is FLOAT
  30386. */
  30387. attribyteType: number;
  30388. /**
  30389. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  30390. */
  30391. normalized: boolean;
  30392. /**
  30393. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  30394. */
  30395. offset: number;
  30396. /**
  30397. * Name of the GLSL attribute, for debugging purpose only
  30398. */
  30399. attributeName: string;
  30400. }
  30401. /**
  30402. * Define options used to create a depth texture
  30403. */
  30404. export class DepthTextureCreationOptions {
  30405. /** Specifies whether or not a stencil should be allocated in the texture */
  30406. generateStencil?: boolean;
  30407. /** Specifies whether or not bilinear filtering is enable on the texture */
  30408. bilinearFiltering?: boolean;
  30409. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  30410. comparisonFunction?: number;
  30411. /** Specifies if the created texture is a cube texture */
  30412. isCube?: boolean;
  30413. }
  30414. /**
  30415. * Class used to describe the capabilities of the engine relatively to the current browser
  30416. */
  30417. export class EngineCapabilities {
  30418. /** Maximum textures units per fragment shader */
  30419. maxTexturesImageUnits: number;
  30420. /** Maximum texture units per vertex shader */
  30421. maxVertexTextureImageUnits: number;
  30422. /** Maximum textures units in the entire pipeline */
  30423. maxCombinedTexturesImageUnits: number;
  30424. /** Maximum texture size */
  30425. maxTextureSize: number;
  30426. /** Maximum cube texture size */
  30427. maxCubemapTextureSize: number;
  30428. /** Maximum render texture size */
  30429. maxRenderTextureSize: number;
  30430. /** Maximum number of vertex attributes */
  30431. maxVertexAttribs: number;
  30432. /** Maximum number of varyings */
  30433. maxVaryingVectors: number;
  30434. /** Maximum number of uniforms per vertex shader */
  30435. maxVertexUniformVectors: number;
  30436. /** Maximum number of uniforms per fragment shader */
  30437. maxFragmentUniformVectors: number;
  30438. /** Defines if standard derivates (dx/dy) are supported */
  30439. standardDerivatives: boolean;
  30440. /** Defines if s3tc texture compression is supported */
  30441. s3tc: Nullable<WEBGL_compressed_texture_s3tc>;
  30442. /** Defines if pvrtc texture compression is supported */
  30443. pvrtc: any;
  30444. /** Defines if etc1 texture compression is supported */
  30445. etc1: any;
  30446. /** Defines if etc2 texture compression is supported */
  30447. etc2: any;
  30448. /** Defines if astc texture compression is supported */
  30449. astc: any;
  30450. /** Defines if float textures are supported */
  30451. textureFloat: boolean;
  30452. /** Defines if vertex array objects are supported */
  30453. vertexArrayObject: boolean;
  30454. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  30455. textureAnisotropicFilterExtension: Nullable<EXT_texture_filter_anisotropic>;
  30456. /** Gets the maximum level of anisotropy supported */
  30457. maxAnisotropy: number;
  30458. /** Defines if instancing is supported */
  30459. instancedArrays: boolean;
  30460. /** Defines if 32 bits indices are supported */
  30461. uintIndices: boolean;
  30462. /** Defines if high precision shaders are supported */
  30463. highPrecisionShaderSupported: boolean;
  30464. /** Defines if depth reading in the fragment shader is supported */
  30465. fragmentDepthSupported: boolean;
  30466. /** Defines if float texture linear filtering is supported*/
  30467. textureFloatLinearFiltering: boolean;
  30468. /** Defines if rendering to float textures is supported */
  30469. textureFloatRender: boolean;
  30470. /** Defines if half float textures are supported*/
  30471. textureHalfFloat: boolean;
  30472. /** Defines if half float texture linear filtering is supported*/
  30473. textureHalfFloatLinearFiltering: boolean;
  30474. /** Defines if rendering to half float textures is supported */
  30475. textureHalfFloatRender: boolean;
  30476. /** Defines if textureLOD shader command is supported */
  30477. textureLOD: boolean;
  30478. /** Defines if draw buffers extension is supported */
  30479. drawBuffersExtension: boolean;
  30480. /** Defines if depth textures are supported */
  30481. depthTextureExtension: boolean;
  30482. /** Defines if float color buffer are supported */
  30483. colorBufferFloat: boolean;
  30484. /** Gets disjoint timer query extension (null if not supported) */
  30485. timerQuery: EXT_disjoint_timer_query;
  30486. /** Defines if timestamp can be used with timer query */
  30487. canUseTimestampForTimerQuery: boolean;
  30488. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  30489. multiview: any;
  30490. /** Function used to let the system compiles shaders in background */
  30491. parallelShaderCompile: {
  30492. COMPLETION_STATUS_KHR: number;
  30493. };
  30494. /** Max number of texture samples for MSAA */
  30495. maxMSAASamples: number;
  30496. }
  30497. /** Interface defining initialization parameters for Engine class */
  30498. export interface EngineOptions extends WebGLContextAttributes {
  30499. /**
  30500. * Defines if the engine should no exceed a specified device ratio
  30501. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  30502. */
  30503. limitDeviceRatio?: number;
  30504. /**
  30505. * Defines if webvr should be enabled automatically
  30506. * @see http://doc.babylonjs.com/how_to/webvr_camera
  30507. */
  30508. autoEnableWebVR?: boolean;
  30509. /**
  30510. * Defines if webgl2 should be turned off even if supported
  30511. * @see http://doc.babylonjs.com/features/webgl2
  30512. */
  30513. disableWebGL2Support?: boolean;
  30514. /**
  30515. * Defines if webaudio should be initialized as well
  30516. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  30517. */
  30518. audioEngine?: boolean;
  30519. /**
  30520. * Defines if animations should run using a deterministic lock step
  30521. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  30522. */
  30523. deterministicLockstep?: boolean;
  30524. /** Defines the maximum steps to use with deterministic lock step mode */
  30525. lockstepMaxSteps?: number;
  30526. /**
  30527. * Defines that engine should ignore context lost events
  30528. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  30529. */
  30530. doNotHandleContextLost?: boolean;
  30531. /**
  30532. * Defines that engine should ignore modifying touch action attribute and style
  30533. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  30534. */
  30535. doNotHandleTouchAction?: boolean;
  30536. /**
  30537. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  30538. */
  30539. useHighPrecisionFloats?: boolean;
  30540. }
  30541. /**
  30542. * Defines the interface used by display changed events
  30543. */
  30544. export interface IDisplayChangedEventArgs {
  30545. /** Gets the vrDisplay object (if any) */
  30546. vrDisplay: Nullable<any>;
  30547. /** Gets a boolean indicating if webVR is supported */
  30548. vrSupported: boolean;
  30549. }
  30550. /**
  30551. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  30552. */
  30553. export class Engine {
  30554. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  30555. static ExceptionList: ({
  30556. key: string;
  30557. capture: string;
  30558. captureConstraint: number;
  30559. targets: string[];
  30560. } | {
  30561. key: string;
  30562. capture: null;
  30563. captureConstraint: null;
  30564. targets: string[];
  30565. })[];
  30566. /** Gets the list of created engines */
  30567. static readonly Instances: Engine[];
  30568. /**
  30569. * Gets the latest created engine
  30570. */
  30571. static readonly LastCreatedEngine: Nullable<Engine>;
  30572. /**
  30573. * Gets the latest created scene
  30574. */
  30575. static readonly LastCreatedScene: Nullable<Scene>;
  30576. /**
  30577. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  30578. * @param flag defines which part of the materials must be marked as dirty
  30579. * @param predicate defines a predicate used to filter which materials should be affected
  30580. */
  30581. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  30582. /** @hidden */
  30583. static _TextureLoaders: IInternalTextureLoader[];
  30584. /** Defines that alpha blending is disabled */
  30585. static readonly ALPHA_DISABLE: number;
  30586. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  30587. static readonly ALPHA_ADD: number;
  30588. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  30589. static readonly ALPHA_COMBINE: number;
  30590. /** Defines that alpha blending to DEST - SRC * DEST */
  30591. static readonly ALPHA_SUBTRACT: number;
  30592. /** Defines that alpha blending to SRC * DEST */
  30593. static readonly ALPHA_MULTIPLY: number;
  30594. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  30595. static readonly ALPHA_MAXIMIZED: number;
  30596. /** Defines that alpha blending to SRC + DEST */
  30597. static readonly ALPHA_ONEONE: number;
  30598. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  30599. static readonly ALPHA_PREMULTIPLIED: number;
  30600. /**
  30601. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  30602. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  30603. */
  30604. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  30605. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  30606. static readonly ALPHA_INTERPOLATE: number;
  30607. /**
  30608. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  30609. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  30610. */
  30611. static readonly ALPHA_SCREENMODE: number;
  30612. /** Defines that the ressource is not delayed*/
  30613. static readonly DELAYLOADSTATE_NONE: number;
  30614. /** Defines that the ressource was successfully delay loaded */
  30615. static readonly DELAYLOADSTATE_LOADED: number;
  30616. /** Defines that the ressource is currently delay loading */
  30617. static readonly DELAYLOADSTATE_LOADING: number;
  30618. /** Defines that the ressource is delayed and has not started loading */
  30619. static readonly DELAYLOADSTATE_NOTLOADED: number;
  30620. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  30621. static readonly NEVER: number;
  30622. /** 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 */
  30623. static readonly ALWAYS: number;
  30624. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  30625. static readonly LESS: number;
  30626. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  30627. static readonly EQUAL: number;
  30628. /** 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 */
  30629. static readonly LEQUAL: number;
  30630. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  30631. static readonly GREATER: number;
  30632. /** 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 */
  30633. static readonly GEQUAL: number;
  30634. /** 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 */
  30635. static readonly NOTEQUAL: number;
  30636. /** Passed to stencilOperation to specify that stencil value must be kept */
  30637. static readonly KEEP: number;
  30638. /** Passed to stencilOperation to specify that stencil value must be replaced */
  30639. static readonly REPLACE: number;
  30640. /** Passed to stencilOperation to specify that stencil value must be incremented */
  30641. static readonly INCR: number;
  30642. /** Passed to stencilOperation to specify that stencil value must be decremented */
  30643. static readonly DECR: number;
  30644. /** Passed to stencilOperation to specify that stencil value must be inverted */
  30645. static readonly INVERT: number;
  30646. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  30647. static readonly INCR_WRAP: number;
  30648. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  30649. static readonly DECR_WRAP: number;
  30650. /** Texture is not repeating outside of 0..1 UVs */
  30651. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  30652. /** Texture is repeating outside of 0..1 UVs */
  30653. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  30654. /** Texture is repeating and mirrored */
  30655. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  30656. /** ALPHA */
  30657. static readonly TEXTUREFORMAT_ALPHA: number;
  30658. /** LUMINANCE */
  30659. static readonly TEXTUREFORMAT_LUMINANCE: number;
  30660. /** LUMINANCE_ALPHA */
  30661. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  30662. /** RGB */
  30663. static readonly TEXTUREFORMAT_RGB: number;
  30664. /** RGBA */
  30665. static readonly TEXTUREFORMAT_RGBA: number;
  30666. /** RED */
  30667. static readonly TEXTUREFORMAT_RED: number;
  30668. /** RED (2nd reference) */
  30669. static readonly TEXTUREFORMAT_R: number;
  30670. /** RG */
  30671. static readonly TEXTUREFORMAT_RG: number;
  30672. /** RED_INTEGER */
  30673. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  30674. /** RED_INTEGER (2nd reference) */
  30675. static readonly TEXTUREFORMAT_R_INTEGER: number;
  30676. /** RG_INTEGER */
  30677. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  30678. /** RGB_INTEGER */
  30679. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  30680. /** RGBA_INTEGER */
  30681. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  30682. /** UNSIGNED_BYTE */
  30683. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  30684. /** UNSIGNED_BYTE (2nd reference) */
  30685. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  30686. /** FLOAT */
  30687. static readonly TEXTURETYPE_FLOAT: number;
  30688. /** HALF_FLOAT */
  30689. static readonly TEXTURETYPE_HALF_FLOAT: number;
  30690. /** BYTE */
  30691. static readonly TEXTURETYPE_BYTE: number;
  30692. /** SHORT */
  30693. static readonly TEXTURETYPE_SHORT: number;
  30694. /** UNSIGNED_SHORT */
  30695. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  30696. /** INT */
  30697. static readonly TEXTURETYPE_INT: number;
  30698. /** UNSIGNED_INT */
  30699. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  30700. /** UNSIGNED_SHORT_4_4_4_4 */
  30701. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  30702. /** UNSIGNED_SHORT_5_5_5_1 */
  30703. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  30704. /** UNSIGNED_SHORT_5_6_5 */
  30705. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  30706. /** UNSIGNED_INT_2_10_10_10_REV */
  30707. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  30708. /** UNSIGNED_INT_24_8 */
  30709. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  30710. /** UNSIGNED_INT_10F_11F_11F_REV */
  30711. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  30712. /** UNSIGNED_INT_5_9_9_9_REV */
  30713. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  30714. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  30715. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  30716. /** nearest is mag = nearest and min = nearest and mip = linear */
  30717. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  30718. /** Bilinear is mag = linear and min = linear and mip = nearest */
  30719. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  30720. /** Trilinear is mag = linear and min = linear and mip = linear */
  30721. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  30722. /** nearest is mag = nearest and min = nearest and mip = linear */
  30723. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  30724. /** Bilinear is mag = linear and min = linear and mip = nearest */
  30725. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  30726. /** Trilinear is mag = linear and min = linear and mip = linear */
  30727. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  30728. /** mag = nearest and min = nearest and mip = nearest */
  30729. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  30730. /** mag = nearest and min = linear and mip = nearest */
  30731. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  30732. /** mag = nearest and min = linear and mip = linear */
  30733. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  30734. /** mag = nearest and min = linear and mip = none */
  30735. static readonly TEXTURE_NEAREST_LINEAR: number;
  30736. /** mag = nearest and min = nearest and mip = none */
  30737. static readonly TEXTURE_NEAREST_NEAREST: number;
  30738. /** mag = linear and min = nearest and mip = nearest */
  30739. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  30740. /** mag = linear and min = nearest and mip = linear */
  30741. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  30742. /** mag = linear and min = linear and mip = none */
  30743. static readonly TEXTURE_LINEAR_LINEAR: number;
  30744. /** mag = linear and min = nearest and mip = none */
  30745. static readonly TEXTURE_LINEAR_NEAREST: number;
  30746. /** Explicit coordinates mode */
  30747. static readonly TEXTURE_EXPLICIT_MODE: number;
  30748. /** Spherical coordinates mode */
  30749. static readonly TEXTURE_SPHERICAL_MODE: number;
  30750. /** Planar coordinates mode */
  30751. static readonly TEXTURE_PLANAR_MODE: number;
  30752. /** Cubic coordinates mode */
  30753. static readonly TEXTURE_CUBIC_MODE: number;
  30754. /** Projection coordinates mode */
  30755. static readonly TEXTURE_PROJECTION_MODE: number;
  30756. /** Skybox coordinates mode */
  30757. static readonly TEXTURE_SKYBOX_MODE: number;
  30758. /** Inverse Cubic coordinates mode */
  30759. static readonly TEXTURE_INVCUBIC_MODE: number;
  30760. /** Equirectangular coordinates mode */
  30761. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  30762. /** Equirectangular Fixed coordinates mode */
  30763. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  30764. /** Equirectangular Fixed Mirrored coordinates mode */
  30765. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  30766. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  30767. static readonly SCALEMODE_FLOOR: number;
  30768. /** Defines that texture rescaling will look for the nearest power of 2 size */
  30769. static readonly SCALEMODE_NEAREST: number;
  30770. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  30771. static readonly SCALEMODE_CEILING: number;
  30772. /**
  30773. * Returns the current npm package of the sdk
  30774. */
  30775. static readonly NpmPackage: string;
  30776. /**
  30777. * Returns the current version of the framework
  30778. */
  30779. static readonly Version: string;
  30780. /**
  30781. * Returns a string describing the current engine
  30782. */
  30783. readonly description: string;
  30784. /**
  30785. * Gets or sets the epsilon value used by collision engine
  30786. */
  30787. static CollisionsEpsilon: number;
  30788. /**
  30789. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30790. */
  30791. static ShadersRepository: string;
  30792. /**
  30793. * Method called to create the default loading screen.
  30794. * This can be overriden in your own app.
  30795. * @param canvas The rendering canvas element
  30796. * @returns The loading screen
  30797. */
  30798. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  30799. /**
  30800. * Method called to create the default rescale post process on each engine.
  30801. */
  30802. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  30803. /** @hidden */
  30804. _shaderProcessor: IShaderProcessor;
  30805. /**
  30806. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30807. */
  30808. forcePOTTextures: boolean;
  30809. /**
  30810. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30811. */
  30812. isFullscreen: boolean;
  30813. /**
  30814. * Gets a boolean indicating if the pointer is currently locked
  30815. */
  30816. isPointerLock: boolean;
  30817. /**
  30818. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30819. */
  30820. cullBackFaces: boolean;
  30821. /**
  30822. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30823. */
  30824. renderEvenInBackground: boolean;
  30825. /**
  30826. * Gets or sets a boolean indicating that cache can be kept between frames
  30827. */
  30828. preventCacheWipeBetweenFrames: boolean;
  30829. /**
  30830. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  30831. **/
  30832. enableOfflineSupport: boolean;
  30833. /**
  30834. * 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)
  30835. **/
  30836. disableManifestCheck: boolean;
  30837. /**
  30838. * Gets the list of created scenes
  30839. */
  30840. scenes: Scene[];
  30841. /**
  30842. * Event raised when a new scene is created
  30843. */
  30844. onNewSceneAddedObservable: Observable<Scene>;
  30845. /**
  30846. * Gets the list of created postprocesses
  30847. */
  30848. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  30849. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30850. validateShaderPrograms: boolean;
  30851. /**
  30852. * Observable event triggered each time the rendering canvas is resized
  30853. */
  30854. onResizeObservable: Observable<Engine>;
  30855. /**
  30856. * Observable event triggered each time the canvas loses focus
  30857. */
  30858. onCanvasBlurObservable: Observable<Engine>;
  30859. /**
  30860. * Observable event triggered each time the canvas gains focus
  30861. */
  30862. onCanvasFocusObservable: Observable<Engine>;
  30863. /**
  30864. * Observable event triggered each time the canvas receives pointerout event
  30865. */
  30866. onCanvasPointerOutObservable: Observable<PointerEvent>;
  30867. /**
  30868. * Observable event triggered before each texture is initialized
  30869. */
  30870. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30871. /**
  30872. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30873. */
  30874. disableUniformBuffers: boolean;
  30875. /** @hidden */
  30876. _uniformBuffers: UniformBuffer[];
  30877. /**
  30878. * Gets a boolean indicating that the engine supports uniform buffers
  30879. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30880. */
  30881. readonly supportsUniformBuffers: boolean;
  30882. /**
  30883. * Observable raised when the engine begins a new frame
  30884. */
  30885. onBeginFrameObservable: Observable<Engine>;
  30886. /**
  30887. * If set, will be used to request the next animation frame for the render loop
  30888. */
  30889. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  30890. /**
  30891. * Observable raised when the engine ends the current frame
  30892. */
  30893. onEndFrameObservable: Observable<Engine>;
  30894. /**
  30895. * Observable raised when the engine is about to compile a shader
  30896. */
  30897. onBeforeShaderCompilationObservable: Observable<Engine>;
  30898. /**
  30899. * Observable raised when the engine has jsut compiled a shader
  30900. */
  30901. onAfterShaderCompilationObservable: Observable<Engine>;
  30902. /** @hidden */
  30903. _gl: WebGLRenderingContext;
  30904. private _renderingCanvas;
  30905. private _windowIsBackground;
  30906. private _webGLVersion;
  30907. protected _highPrecisionShadersAllowed: boolean;
  30908. /** @hidden */
  30909. readonly _shouldUseHighPrecisionShader: boolean;
  30910. /**
  30911. * Gets a boolean indicating that only power of 2 textures are supported
  30912. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  30913. */
  30914. readonly needPOTTextures: boolean;
  30915. /** @hidden */
  30916. _badOS: boolean;
  30917. /** @hidden */
  30918. _badDesktopOS: boolean;
  30919. /**
  30920. * Gets the audio engine
  30921. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  30922. * @ignorenaming
  30923. */
  30924. static audioEngine: IAudioEngine;
  30925. /**
  30926. * Default AudioEngine factory responsible of creating the Audio Engine.
  30927. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  30928. */
  30929. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  30930. /**
  30931. * Default offline support factory responsible of creating a tool used to store data locally.
  30932. * By default, this will create a Database object if the workload has been embedded.
  30933. */
  30934. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  30935. private _onFocus;
  30936. private _onBlur;
  30937. private _onCanvasPointerOut;
  30938. private _onCanvasBlur;
  30939. private _onCanvasFocus;
  30940. private _onFullscreenChange;
  30941. private _onPointerLockChange;
  30942. private _hardwareScalingLevel;
  30943. /** @hidden */
  30944. _caps: EngineCapabilities;
  30945. private _pointerLockRequested;
  30946. private _isStencilEnable;
  30947. private _colorWrite;
  30948. private _loadingScreen;
  30949. /** @hidden */
  30950. _drawCalls: PerfCounter;
  30951. private _glVersion;
  30952. private _glRenderer;
  30953. private _glVendor;
  30954. private _videoTextureSupported;
  30955. private _renderingQueueLaunched;
  30956. private _activeRenderLoops;
  30957. private _deterministicLockstep;
  30958. private _lockstepMaxSteps;
  30959. /**
  30960. * Observable signaled when a context lost event is raised
  30961. */
  30962. onContextLostObservable: Observable<Engine>;
  30963. /**
  30964. * Observable signaled when a context restored event is raised
  30965. */
  30966. onContextRestoredObservable: Observable<Engine>;
  30967. private _onContextLost;
  30968. private _onContextRestored;
  30969. private _contextWasLost;
  30970. /** @hidden */
  30971. _doNotHandleContextLost: boolean;
  30972. /**
  30973. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  30974. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  30975. */
  30976. doNotHandleContextLost: boolean;
  30977. private _performanceMonitor;
  30978. private _fps;
  30979. private _deltaTime;
  30980. /**
  30981. * Turn this value on if you want to pause FPS computation when in background
  30982. */
  30983. disablePerformanceMonitorInBackground: boolean;
  30984. /**
  30985. * Gets the performance monitor attached to this engine
  30986. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  30987. */
  30988. readonly performanceMonitor: PerformanceMonitor;
  30989. /**
  30990. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  30991. */
  30992. disableVertexArrayObjects: boolean;
  30993. /** @hidden */
  30994. protected _depthCullingState: _DepthCullingState;
  30995. /** @hidden */
  30996. protected _stencilState: _StencilState;
  30997. /** @hidden */
  30998. protected _alphaState: _AlphaState;
  30999. /** @hidden */
  31000. protected _alphaMode: number;
  31001. /** @hidden */
  31002. _internalTexturesCache: InternalTexture[];
  31003. /** @hidden */
  31004. protected _activeChannel: number;
  31005. private _currentTextureChannel;
  31006. /** @hidden */
  31007. protected _boundTexturesCache: {
  31008. [key: string]: Nullable<InternalTexture>;
  31009. };
  31010. /** @hidden */
  31011. protected _currentEffect: Nullable<Effect>;
  31012. /** @hidden */
  31013. protected _currentProgram: Nullable<WebGLProgram>;
  31014. private _compiledEffects;
  31015. private _vertexAttribArraysEnabled;
  31016. /** @hidden */
  31017. protected _cachedViewport: Nullable<IViewportLike>;
  31018. private _cachedVertexArrayObject;
  31019. /** @hidden */
  31020. protected _cachedVertexBuffers: any;
  31021. /** @hidden */
  31022. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  31023. /** @hidden */
  31024. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  31025. /** @hidden */
  31026. _currentRenderTarget: Nullable<InternalTexture>;
  31027. private _uintIndicesCurrentlySet;
  31028. private _currentBoundBuffer;
  31029. /** @hidden */
  31030. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  31031. private _currentBufferPointers;
  31032. private _currentInstanceLocations;
  31033. private _currentInstanceBuffers;
  31034. private _textureUnits;
  31035. /** @hidden */
  31036. _workingCanvas: Nullable<HTMLCanvasElement>;
  31037. /** @hidden */
  31038. _workingContext: Nullable<CanvasRenderingContext2D>;
  31039. private _rescalePostProcess;
  31040. private _dummyFramebuffer;
  31041. private _externalData;
  31042. /** @hidden */
  31043. _bindedRenderFunction: any;
  31044. private _vaoRecordInProgress;
  31045. private _mustWipeVertexAttributes;
  31046. private _emptyTexture;
  31047. private _emptyCubeTexture;
  31048. private _emptyTexture3D;
  31049. /** @hidden */
  31050. _frameHandler: number;
  31051. private _nextFreeTextureSlots;
  31052. private _maxSimultaneousTextures;
  31053. private _activeRequests;
  31054. private _texturesSupported;
  31055. /** @hidden */
  31056. _textureFormatInUse: Nullable<string>;
  31057. /**
  31058. * Gets the list of texture formats supported
  31059. */
  31060. readonly texturesSupported: Array<string>;
  31061. /**
  31062. * Gets the list of texture formats in use
  31063. */
  31064. readonly textureFormatInUse: Nullable<string>;
  31065. /**
  31066. * Gets the current viewport
  31067. */
  31068. readonly currentViewport: Nullable<IViewportLike>;
  31069. /**
  31070. * Gets the default empty texture
  31071. */
  31072. readonly emptyTexture: InternalTexture;
  31073. /**
  31074. * Gets the default empty 3D texture
  31075. */
  31076. readonly emptyTexture3D: InternalTexture;
  31077. /**
  31078. * Gets the default empty cube texture
  31079. */
  31080. readonly emptyCubeTexture: InternalTexture;
  31081. /**
  31082. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  31083. */
  31084. readonly premultipliedAlpha: boolean;
  31085. /**
  31086. * Creates a new engine
  31087. * @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
  31088. * @param antialias defines enable antialiasing (default: false)
  31089. * @param options defines further options to be sent to the getContext() function
  31090. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  31091. */
  31092. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  31093. /**
  31094. * Initializes a webVR display and starts listening to display change events
  31095. * The onVRDisplayChangedObservable will be notified upon these changes
  31096. * @returns The onVRDisplayChangedObservable
  31097. */
  31098. initWebVR(): Observable<IDisplayChangedEventArgs>;
  31099. /** @hidden */
  31100. _prepareVRComponent(): void;
  31101. /** @hidden */
  31102. _connectVREvents(canvas: HTMLCanvasElement, document: any): void;
  31103. /** @hidden */
  31104. _submitVRFrame(): void;
  31105. /**
  31106. * Call this function to leave webVR mode
  31107. * Will do nothing if webVR is not supported or if there is no webVR device
  31108. * @see http://doc.babylonjs.com/how_to/webvr_camera
  31109. */
  31110. disableVR(): void;
  31111. /**
  31112. * Gets a boolean indicating that the system is in VR mode and is presenting
  31113. * @returns true if VR mode is engaged
  31114. */
  31115. isVRPresenting(): boolean;
  31116. /** @hidden */
  31117. _requestVRFrame(): void;
  31118. private _disableTouchAction;
  31119. private _rebuildInternalTextures;
  31120. private _rebuildEffects;
  31121. /**
  31122. * Gets a boolean indicating if all created effects are ready
  31123. * @returns true if all effects are ready
  31124. */
  31125. areAllEffectsReady(): boolean;
  31126. private _rebuildBuffers;
  31127. private _initGLContext;
  31128. /**
  31129. * Gets version of the current webGL context
  31130. */
  31131. readonly webGLVersion: number;
  31132. /**
  31133. * Gets a string idenfifying the name of the class
  31134. * @returns "Engine" string
  31135. */
  31136. getClassName(): string;
  31137. /**
  31138. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  31139. */
  31140. readonly isStencilEnable: boolean;
  31141. /** @hidden */
  31142. _prepareWorkingCanvas(): void;
  31143. /**
  31144. * Reset the texture cache to empty state
  31145. */
  31146. resetTextureCache(): void;
  31147. /**
  31148. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  31149. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  31150. * @returns true if engine is in deterministic lock step mode
  31151. */
  31152. isDeterministicLockStep(): boolean;
  31153. /**
  31154. * Gets the max steps when engine is running in deterministic lock step
  31155. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  31156. * @returns the max steps
  31157. */
  31158. getLockstepMaxSteps(): number;
  31159. /**
  31160. * Gets an object containing information about the current webGL context
  31161. * @returns an object containing the vender, the renderer and the version of the current webGL context
  31162. */
  31163. getGlInfo(): {
  31164. vendor: string;
  31165. renderer: string;
  31166. version: string;
  31167. };
  31168. /**
  31169. * Gets current aspect ratio
  31170. * @param viewportOwner defines the camera to use to get the aspect ratio
  31171. * @param useScreen defines if screen size must be used (or the current render target if any)
  31172. * @returns a number defining the aspect ratio
  31173. */
  31174. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  31175. /**
  31176. * Gets current screen aspect ratio
  31177. * @returns a number defining the aspect ratio
  31178. */
  31179. getScreenAspectRatio(): number;
  31180. /**
  31181. * Gets the current render width
  31182. * @param useScreen defines if screen size must be used (or the current render target if any)
  31183. * @returns a number defining the current render width
  31184. */
  31185. getRenderWidth(useScreen?: boolean): number;
  31186. /**
  31187. * Gets the current render height
  31188. * @param useScreen defines if screen size must be used (or the current render target if any)
  31189. * @returns a number defining the current render height
  31190. */
  31191. getRenderHeight(useScreen?: boolean): number;
  31192. /**
  31193. * Gets the HTML canvas attached with the current webGL context
  31194. * @returns a HTML canvas
  31195. */
  31196. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  31197. /**
  31198. * Gets host window
  31199. * @returns the host window object
  31200. */
  31201. getHostWindow(): Window;
  31202. /**
  31203. * Gets host document
  31204. * @returns the host document object
  31205. */
  31206. getHostDocument(): Document;
  31207. /**
  31208. * Gets the client rect of the HTML canvas attached with the current webGL context
  31209. * @returns a client rectanglee
  31210. */
  31211. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  31212. /**
  31213. * Defines the hardware scaling level.
  31214. * By default the hardware scaling level is computed from the window device ratio.
  31215. * 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.
  31216. * @param level defines the level to use
  31217. */
  31218. setHardwareScalingLevel(level: number): void;
  31219. /**
  31220. * Gets the current hardware scaling level.
  31221. * By default the hardware scaling level is computed from the window device ratio.
  31222. * 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.
  31223. * @returns a number indicating the current hardware scaling level
  31224. */
  31225. getHardwareScalingLevel(): number;
  31226. /**
  31227. * Gets the list of loaded textures
  31228. * @returns an array containing all loaded textures
  31229. */
  31230. getLoadedTexturesCache(): InternalTexture[];
  31231. /**
  31232. * Gets the object containing all engine capabilities
  31233. * @returns the EngineCapabilities object
  31234. */
  31235. getCaps(): EngineCapabilities;
  31236. /**
  31237. * Gets the current depth function
  31238. * @returns a number defining the depth function
  31239. */
  31240. getDepthFunction(): Nullable<number>;
  31241. /**
  31242. * Sets the current depth function
  31243. * @param depthFunc defines the function to use
  31244. */
  31245. setDepthFunction(depthFunc: number): void;
  31246. /**
  31247. * Sets the current depth function to GREATER
  31248. */
  31249. setDepthFunctionToGreater(): void;
  31250. /**
  31251. * Sets the current depth function to GEQUAL
  31252. */
  31253. setDepthFunctionToGreaterOrEqual(): void;
  31254. /**
  31255. * Sets the current depth function to LESS
  31256. */
  31257. setDepthFunctionToLess(): void;
  31258. private _cachedStencilBuffer;
  31259. private _cachedStencilFunction;
  31260. private _cachedStencilMask;
  31261. private _cachedStencilOperationPass;
  31262. private _cachedStencilOperationFail;
  31263. private _cachedStencilOperationDepthFail;
  31264. private _cachedStencilReference;
  31265. /**
  31266. * Caches the the state of the stencil buffer
  31267. */
  31268. cacheStencilState(): void;
  31269. /**
  31270. * Restores the state of the stencil buffer
  31271. */
  31272. restoreStencilState(): void;
  31273. /**
  31274. * Sets the current depth function to LEQUAL
  31275. */
  31276. setDepthFunctionToLessOrEqual(): void;
  31277. /**
  31278. * Gets a boolean indicating if stencil buffer is enabled
  31279. * @returns the current stencil buffer state
  31280. */
  31281. getStencilBuffer(): boolean;
  31282. /**
  31283. * Enable or disable the stencil buffer
  31284. * @param enable defines if the stencil buffer must be enabled or disabled
  31285. */
  31286. setStencilBuffer(enable: boolean): void;
  31287. /**
  31288. * Gets the current stencil mask
  31289. * @returns a number defining the new stencil mask to use
  31290. */
  31291. getStencilMask(): number;
  31292. /**
  31293. * Sets the current stencil mask
  31294. * @param mask defines the new stencil mask to use
  31295. */
  31296. setStencilMask(mask: number): void;
  31297. /**
  31298. * Gets the current stencil function
  31299. * @returns a number defining the stencil function to use
  31300. */
  31301. getStencilFunction(): number;
  31302. /**
  31303. * Gets the current stencil reference value
  31304. * @returns a number defining the stencil reference value to use
  31305. */
  31306. getStencilFunctionReference(): number;
  31307. /**
  31308. * Gets the current stencil mask
  31309. * @returns a number defining the stencil mask to use
  31310. */
  31311. getStencilFunctionMask(): number;
  31312. /**
  31313. * Sets the current stencil function
  31314. * @param stencilFunc defines the new stencil function to use
  31315. */
  31316. setStencilFunction(stencilFunc: number): void;
  31317. /**
  31318. * Sets the current stencil reference
  31319. * @param reference defines the new stencil reference to use
  31320. */
  31321. setStencilFunctionReference(reference: number): void;
  31322. /**
  31323. * Sets the current stencil mask
  31324. * @param mask defines the new stencil mask to use
  31325. */
  31326. setStencilFunctionMask(mask: number): void;
  31327. /**
  31328. * Gets the current stencil operation when stencil fails
  31329. * @returns a number defining stencil operation to use when stencil fails
  31330. */
  31331. getStencilOperationFail(): number;
  31332. /**
  31333. * Gets the current stencil operation when depth fails
  31334. * @returns a number defining stencil operation to use when depth fails
  31335. */
  31336. getStencilOperationDepthFail(): number;
  31337. /**
  31338. * Gets the current stencil operation when stencil passes
  31339. * @returns a number defining stencil operation to use when stencil passes
  31340. */
  31341. getStencilOperationPass(): number;
  31342. /**
  31343. * Sets the stencil operation to use when stencil fails
  31344. * @param operation defines the stencil operation to use when stencil fails
  31345. */
  31346. setStencilOperationFail(operation: number): void;
  31347. /**
  31348. * Sets the stencil operation to use when depth fails
  31349. * @param operation defines the stencil operation to use when depth fails
  31350. */
  31351. setStencilOperationDepthFail(operation: number): void;
  31352. /**
  31353. * Sets the stencil operation to use when stencil passes
  31354. * @param operation defines the stencil operation to use when stencil passes
  31355. */
  31356. setStencilOperationPass(operation: number): void;
  31357. /**
  31358. * Sets a boolean indicating if the dithering state is enabled or disabled
  31359. * @param value defines the dithering state
  31360. */
  31361. setDitheringState(value: boolean): void;
  31362. /**
  31363. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  31364. * @param value defines the rasterizer state
  31365. */
  31366. setRasterizerState(value: boolean): void;
  31367. /**
  31368. * stop executing a render loop function and remove it from the execution array
  31369. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  31370. */
  31371. stopRenderLoop(renderFunction?: () => void): void;
  31372. /** @hidden */
  31373. _renderLoop(): void;
  31374. /**
  31375. * Register and execute a render loop. The engine can have more than one render function
  31376. * @param renderFunction defines the function to continuously execute
  31377. */
  31378. runRenderLoop(renderFunction: () => void): void;
  31379. /**
  31380. * Toggle full screen mode
  31381. * @param requestPointerLock defines if a pointer lock should be requested from the user
  31382. */
  31383. switchFullscreen(requestPointerLock: boolean): void;
  31384. /**
  31385. * Enters full screen mode
  31386. * @param requestPointerLock defines if a pointer lock should be requested from the user
  31387. */
  31388. enterFullscreen(requestPointerLock: boolean): void;
  31389. /**
  31390. * Exits full screen mode
  31391. */
  31392. exitFullscreen(): void;
  31393. /**
  31394. * Enters Pointerlock mode
  31395. */
  31396. enterPointerlock(): void;
  31397. /**
  31398. * Exits Pointerlock mode
  31399. */
  31400. exitPointerlock(): void;
  31401. /**
  31402. * Clear the current render buffer or the current render target (if any is set up)
  31403. * @param color defines the color to use
  31404. * @param backBuffer defines if the back buffer must be cleared
  31405. * @param depth defines if the depth buffer must be cleared
  31406. * @param stencil defines if the stencil buffer must be cleared
  31407. */
  31408. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  31409. /**
  31410. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  31411. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  31412. * @param y defines the y-coordinate of the corner of the clear rectangle
  31413. * @param width defines the width of the clear rectangle
  31414. * @param height defines the height of the clear rectangle
  31415. * @param clearColor defines the clear color
  31416. */
  31417. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  31418. /**
  31419. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  31420. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  31421. * @param y defines the y-coordinate of the corner of the clear rectangle
  31422. * @param width defines the width of the clear rectangle
  31423. * @param height defines the height of the clear rectangle
  31424. */
  31425. enableScissor(x: number, y: number, width: number, height: number): void;
  31426. /**
  31427. * Disable previously set scissor test rectangle
  31428. */
  31429. disableScissor(): void;
  31430. private _viewportCached;
  31431. /** @hidden */
  31432. _viewport(x: number, y: number, width: number, height: number): void;
  31433. /**
  31434. * Set the WebGL's viewport
  31435. * @param viewport defines the viewport element to be used
  31436. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  31437. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  31438. */
  31439. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  31440. /**
  31441. * Directly set the WebGL Viewport
  31442. * @param x defines the x coordinate of the viewport (in screen space)
  31443. * @param y defines the y coordinate of the viewport (in screen space)
  31444. * @param width defines the width of the viewport (in screen space)
  31445. * @param height defines the height of the viewport (in screen space)
  31446. * @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
  31447. */
  31448. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  31449. /**
  31450. * Begin a new frame
  31451. */
  31452. beginFrame(): void;
  31453. /**
  31454. * Enf the current frame
  31455. */
  31456. endFrame(): void;
  31457. /**
  31458. * Resize the view according to the canvas' size
  31459. */
  31460. resize(): void;
  31461. /**
  31462. * Force a specific size of the canvas
  31463. * @param width defines the new canvas' width
  31464. * @param height defines the new canvas' height
  31465. */
  31466. setSize(width: number, height: number): void;
  31467. /**
  31468. * Binds the frame buffer to the specified texture.
  31469. * @param texture The texture to render to or null for the default canvas
  31470. * @param faceIndex The face of the texture to render to in case of cube texture
  31471. * @param requiredWidth The width of the target to render to
  31472. * @param requiredHeight The height of the target to render to
  31473. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  31474. * @param depthStencilTexture The depth stencil texture to use to render
  31475. * @param lodLevel defines le lod level to bind to the frame buffer
  31476. */
  31477. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  31478. /** @hidden */
  31479. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  31480. /**
  31481. * Unbind the current render target texture from the webGL context
  31482. * @param texture defines the render target texture to unbind
  31483. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  31484. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  31485. */
  31486. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  31487. /**
  31488. * Force the mipmap generation for the given render target texture
  31489. * @param texture defines the render target texture to use
  31490. */
  31491. generateMipMapsForCubemap(texture: InternalTexture): void;
  31492. /**
  31493. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  31494. */
  31495. flushFramebuffer(): void;
  31496. /**
  31497. * Unbind the current render target and bind the default framebuffer
  31498. */
  31499. restoreDefaultFramebuffer(): void;
  31500. /**
  31501. * Create an uniform buffer
  31502. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  31503. * @param elements defines the content of the uniform buffer
  31504. * @returns the webGL uniform buffer
  31505. */
  31506. createUniformBuffer(elements: FloatArray): DataBuffer;
  31507. /**
  31508. * Create a dynamic uniform buffer
  31509. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  31510. * @param elements defines the content of the uniform buffer
  31511. * @returns the webGL uniform buffer
  31512. */
  31513. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  31514. /**
  31515. * Update an existing uniform buffer
  31516. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  31517. * @param uniformBuffer defines the target uniform buffer
  31518. * @param elements defines the content to update
  31519. * @param offset defines the offset in the uniform buffer where update should start
  31520. * @param count defines the size of the data to update
  31521. */
  31522. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  31523. private _resetVertexBufferBinding;
  31524. /**
  31525. * Creates a vertex buffer
  31526. * @param data the data for the vertex buffer
  31527. * @returns the new WebGL static buffer
  31528. */
  31529. createVertexBuffer(data: DataArray): DataBuffer;
  31530. /**
  31531. * Creates a dynamic vertex buffer
  31532. * @param data the data for the dynamic vertex buffer
  31533. * @returns the new WebGL dynamic buffer
  31534. */
  31535. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  31536. /**
  31537. * Update a dynamic index buffer
  31538. * @param indexBuffer defines the target index buffer
  31539. * @param indices defines the data to update
  31540. * @param offset defines the offset in the target index buffer where update should start
  31541. */
  31542. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  31543. /**
  31544. * Updates a dynamic vertex buffer.
  31545. * @param vertexBuffer the vertex buffer to update
  31546. * @param data the data used to update the vertex buffer
  31547. * @param byteOffset the byte offset of the data
  31548. * @param byteLength the byte length of the data
  31549. */
  31550. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  31551. private _resetIndexBufferBinding;
  31552. /**
  31553. * Creates a new index buffer
  31554. * @param indices defines the content of the index buffer
  31555. * @param updatable defines if the index buffer must be updatable
  31556. * @returns a new webGL buffer
  31557. */
  31558. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  31559. /**
  31560. * Bind a webGL buffer to the webGL context
  31561. * @param buffer defines the buffer to bind
  31562. */
  31563. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  31564. /**
  31565. * Bind an uniform buffer to the current webGL context
  31566. * @param buffer defines the buffer to bind
  31567. */
  31568. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  31569. /**
  31570. * Bind a buffer to the current webGL context at a given location
  31571. * @param buffer defines the buffer to bind
  31572. * @param location defines the index where to bind the buffer
  31573. */
  31574. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  31575. /**
  31576. * Bind a specific block at a given index in a specific shader program
  31577. * @param pipelineContext defines the pipeline context to use
  31578. * @param blockName defines the block name
  31579. * @param index defines the index where to bind the block
  31580. */
  31581. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  31582. private bindIndexBuffer;
  31583. private bindBuffer;
  31584. /**
  31585. * update the bound buffer with the given data
  31586. * @param data defines the data to update
  31587. */
  31588. updateArrayBuffer(data: Float32Array): void;
  31589. private _vertexAttribPointer;
  31590. private _bindIndexBufferWithCache;
  31591. private _bindVertexBuffersAttributes;
  31592. /**
  31593. * Records a vertex array object
  31594. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  31595. * @param vertexBuffers defines the list of vertex buffers to store
  31596. * @param indexBuffer defines the index buffer to store
  31597. * @param effect defines the effect to store
  31598. * @returns the new vertex array object
  31599. */
  31600. recordVertexArrayObject(vertexBuffers: {
  31601. [key: string]: VertexBuffer;
  31602. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  31603. /**
  31604. * Bind a specific vertex array object
  31605. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  31606. * @param vertexArrayObject defines the vertex array object to bind
  31607. * @param indexBuffer defines the index buffer to bind
  31608. */
  31609. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  31610. /**
  31611. * Bind webGl buffers directly to the webGL context
  31612. * @param vertexBuffer defines the vertex buffer to bind
  31613. * @param indexBuffer defines the index buffer to bind
  31614. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  31615. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  31616. * @param effect defines the effect associated with the vertex buffer
  31617. */
  31618. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  31619. private _unbindVertexArrayObject;
  31620. /**
  31621. * Bind a list of vertex buffers to the webGL context
  31622. * @param vertexBuffers defines the list of vertex buffers to bind
  31623. * @param indexBuffer defines the index buffer to bind
  31624. * @param effect defines the effect associated with the vertex buffers
  31625. */
  31626. bindBuffers(vertexBuffers: {
  31627. [key: string]: Nullable<VertexBuffer>;
  31628. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  31629. /**
  31630. * Unbind all instance attributes
  31631. */
  31632. unbindInstanceAttributes(): void;
  31633. /**
  31634. * Release and free the memory of a vertex array object
  31635. * @param vao defines the vertex array object to delete
  31636. */
  31637. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  31638. /** @hidden */
  31639. _releaseBuffer(buffer: DataBuffer): boolean;
  31640. /**
  31641. * Creates a webGL buffer to use with instanciation
  31642. * @param capacity defines the size of the buffer
  31643. * @returns the webGL buffer
  31644. */
  31645. createInstancesBuffer(capacity: number): DataBuffer;
  31646. /**
  31647. * Delete a webGL buffer used with instanciation
  31648. * @param buffer defines the webGL buffer to delete
  31649. */
  31650. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  31651. /**
  31652. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  31653. * @param instancesBuffer defines the webGL buffer to update and bind
  31654. * @param data defines the data to store in the buffer
  31655. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  31656. */
  31657. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  31658. /**
  31659. * Apply all cached states (depth, culling, stencil and alpha)
  31660. */
  31661. applyStates(): void;
  31662. /**
  31663. * Send a draw order
  31664. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  31665. * @param indexStart defines the starting index
  31666. * @param indexCount defines the number of index to draw
  31667. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31668. */
  31669. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  31670. /**
  31671. * Draw a list of points
  31672. * @param verticesStart defines the index of first vertex to draw
  31673. * @param verticesCount defines the count of vertices to draw
  31674. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31675. */
  31676. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  31677. /**
  31678. * Draw a list of unindexed primitives
  31679. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  31680. * @param verticesStart defines the index of first vertex to draw
  31681. * @param verticesCount defines the count of vertices to draw
  31682. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31683. */
  31684. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  31685. /**
  31686. * Draw a list of indexed primitives
  31687. * @param fillMode defines the primitive to use
  31688. * @param indexStart defines the starting index
  31689. * @param indexCount defines the number of index to draw
  31690. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31691. */
  31692. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  31693. /**
  31694. * Draw a list of unindexed primitives
  31695. * @param fillMode defines the primitive to use
  31696. * @param verticesStart defines the index of first vertex to draw
  31697. * @param verticesCount defines the count of vertices to draw
  31698. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  31699. */
  31700. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  31701. private _drawMode;
  31702. /** @hidden */
  31703. _releaseEffect(effect: Effect): void;
  31704. /** @hidden */
  31705. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  31706. /**
  31707. * Create a new effect (used to store vertex/fragment shaders)
  31708. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  31709. * @param attributesNamesOrOptions defines either a list of attribute names or an EffectCreationOptions object
  31710. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  31711. * @param samplers defines an array of string used to represent textures
  31712. * @param defines defines the string containing the defines to use to compile the shaders
  31713. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  31714. * @param onCompiled defines a function to call when the effect creation is successful
  31715. * @param onError defines a function to call when the effect creation has failed
  31716. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  31717. * @returns the new Effect
  31718. */
  31719. createEffect(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: string[], defines?: string, fallbacks?: EffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  31720. private _compileShader;
  31721. private _compileRawShader;
  31722. /**
  31723. * Directly creates a webGL program
  31724. * @param pipelineContext defines the pipeline context to attach to
  31725. * @param vertexCode defines the vertex shader code to use
  31726. * @param fragmentCode defines the fragment shader code to use
  31727. * @param context defines the webGL context to use (if not set, the current one will be used)
  31728. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  31729. * @returns the new webGL program
  31730. */
  31731. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  31732. /**
  31733. * Creates a webGL program
  31734. * @param pipelineContext defines the pipeline context to attach to
  31735. * @param vertexCode defines the vertex shader code to use
  31736. * @param fragmentCode defines the fragment shader code to use
  31737. * @param defines defines the string containing the defines to use to compile the shaders
  31738. * @param context defines the webGL context to use (if not set, the current one will be used)
  31739. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  31740. * @returns the new webGL program
  31741. */
  31742. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  31743. /**
  31744. * Creates a new pipeline context
  31745. * @returns the new pipeline
  31746. */
  31747. createPipelineContext(): WebGLPipelineContext;
  31748. private _createShaderProgram;
  31749. private _finalizePipelineContext;
  31750. /** @hidden */
  31751. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  31752. /** @hidden */
  31753. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  31754. /** @hidden */
  31755. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  31756. /**
  31757. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  31758. * @param pipelineContext defines the pipeline context to use
  31759. * @param uniformsNames defines the list of uniform names
  31760. * @returns an array of webGL uniform locations
  31761. */
  31762. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  31763. /**
  31764. * Gets the lsit of active attributes for a given webGL program
  31765. * @param pipelineContext defines the pipeline context to use
  31766. * @param attributesNames defines the list of attribute names to get
  31767. * @returns an array of indices indicating the offset of each attribute
  31768. */
  31769. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  31770. /**
  31771. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  31772. * @param effect defines the effect to activate
  31773. */
  31774. enableEffect(effect: Nullable<Effect>): void;
  31775. /**
  31776. * Set the value of an uniform to an array of int32
  31777. * @param uniform defines the webGL uniform location where to store the value
  31778. * @param array defines the array of int32 to store
  31779. */
  31780. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31781. /**
  31782. * Set the value of an uniform to an array of int32 (stored as vec2)
  31783. * @param uniform defines the webGL uniform location where to store the value
  31784. * @param array defines the array of int32 to store
  31785. */
  31786. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31787. /**
  31788. * Set the value of an uniform to an array of int32 (stored as vec3)
  31789. * @param uniform defines the webGL uniform location where to store the value
  31790. * @param array defines the array of int32 to store
  31791. */
  31792. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31793. /**
  31794. * Set the value of an uniform to an array of int32 (stored as vec4)
  31795. * @param uniform defines the webGL uniform location where to store the value
  31796. * @param array defines the array of int32 to store
  31797. */
  31798. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  31799. /**
  31800. * Set the value of an uniform to an array of float32
  31801. * @param uniform defines the webGL uniform location where to store the value
  31802. * @param array defines the array of float32 to store
  31803. */
  31804. setFloatArray(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31805. /**
  31806. * Set the value of an uniform to an array of float32 (stored as vec2)
  31807. * @param uniform defines the webGL uniform location where to store the value
  31808. * @param array defines the array of float32 to store
  31809. */
  31810. setFloatArray2(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31811. /**
  31812. * Set the value of an uniform to an array of float32 (stored as vec3)
  31813. * @param uniform defines the webGL uniform location where to store the value
  31814. * @param array defines the array of float32 to store
  31815. */
  31816. setFloatArray3(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31817. /**
  31818. * Set the value of an uniform to an array of float32 (stored as vec4)
  31819. * @param uniform defines the webGL uniform location where to store the value
  31820. * @param array defines the array of float32 to store
  31821. */
  31822. setFloatArray4(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  31823. /**
  31824. * Set the value of an uniform to an array of number
  31825. * @param uniform defines the webGL uniform location where to store the value
  31826. * @param array defines the array of number to store
  31827. */
  31828. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31829. /**
  31830. * Set the value of an uniform to an array of number (stored as vec2)
  31831. * @param uniform defines the webGL uniform location where to store the value
  31832. * @param array defines the array of number to store
  31833. */
  31834. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31835. /**
  31836. * Set the value of an uniform to an array of number (stored as vec3)
  31837. * @param uniform defines the webGL uniform location where to store the value
  31838. * @param array defines the array of number to store
  31839. */
  31840. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31841. /**
  31842. * Set the value of an uniform to an array of number (stored as vec4)
  31843. * @param uniform defines the webGL uniform location where to store the value
  31844. * @param array defines the array of number to store
  31845. */
  31846. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  31847. /**
  31848. * Set the value of an uniform to an array of float32 (stored as matrices)
  31849. * @param uniform defines the webGL uniform location where to store the value
  31850. * @param matrices defines the array of float32 to store
  31851. */
  31852. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  31853. /**
  31854. * Set the value of an uniform to a matrix (3x3)
  31855. * @param uniform defines the webGL uniform location where to store the value
  31856. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  31857. */
  31858. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  31859. /**
  31860. * Set the value of an uniform to a matrix (2x2)
  31861. * @param uniform defines the webGL uniform location where to store the value
  31862. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  31863. */
  31864. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  31865. /**
  31866. * Set the value of an uniform to a number (int)
  31867. * @param uniform defines the webGL uniform location where to store the value
  31868. * @param value defines the int number to store
  31869. */
  31870. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  31871. /**
  31872. * Set the value of an uniform to a number (float)
  31873. * @param uniform defines the webGL uniform location where to store the value
  31874. * @param value defines the float number to store
  31875. */
  31876. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  31877. /**
  31878. * Set the value of an uniform to a vec2
  31879. * @param uniform defines the webGL uniform location where to store the value
  31880. * @param x defines the 1st component of the value
  31881. * @param y defines the 2nd component of the value
  31882. */
  31883. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  31884. /**
  31885. * Set the value of an uniform to a vec3
  31886. * @param uniform defines the webGL uniform location where to store the value
  31887. * @param x defines the 1st component of the value
  31888. * @param y defines the 2nd component of the value
  31889. * @param z defines the 3rd component of the value
  31890. */
  31891. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  31892. /**
  31893. * Set the value of an uniform to a boolean
  31894. * @param uniform defines the webGL uniform location where to store the value
  31895. * @param bool defines the boolean to store
  31896. */
  31897. setBool(uniform: Nullable<WebGLUniformLocation>, bool: number): void;
  31898. /**
  31899. * Set the value of an uniform to a vec4
  31900. * @param uniform defines the webGL uniform location where to store the value
  31901. * @param x defines the 1st component of the value
  31902. * @param y defines the 2nd component of the value
  31903. * @param z defines the 3rd component of the value
  31904. * @param w defines the 4th component of the value
  31905. */
  31906. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  31907. /**
  31908. * Sets a Color4 on a uniform variable
  31909. * @param uniform defines the uniform location
  31910. * @param color4 defines the value to be set
  31911. */
  31912. setDirectColor4(uniform: Nullable<WebGLUniformLocation>, color4: IColor4Like): void;
  31913. /**
  31914. * Set various states to the webGL context
  31915. * @param culling defines backface culling state
  31916. * @param zOffset defines the value to apply to zOffset (0 by default)
  31917. * @param force defines if states must be applied even if cache is up to date
  31918. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  31919. */
  31920. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  31921. /**
  31922. * Set the z offset to apply to current rendering
  31923. * @param value defines the offset to apply
  31924. */
  31925. setZOffset(value: number): void;
  31926. /**
  31927. * Gets the current value of the zOffset
  31928. * @returns the current zOffset state
  31929. */
  31930. getZOffset(): number;
  31931. /**
  31932. * Enable or disable depth buffering
  31933. * @param enable defines the state to set
  31934. */
  31935. setDepthBuffer(enable: boolean): void;
  31936. /**
  31937. * Gets a boolean indicating if depth writing is enabled
  31938. * @returns the current depth writing state
  31939. */
  31940. getDepthWrite(): boolean;
  31941. /**
  31942. * Enable or disable depth writing
  31943. * @param enable defines the state to set
  31944. */
  31945. setDepthWrite(enable: boolean): void;
  31946. /**
  31947. * Enable or disable color writing
  31948. * @param enable defines the state to set
  31949. */
  31950. setColorWrite(enable: boolean): void;
  31951. /**
  31952. * Gets a boolean indicating if color writing is enabled
  31953. * @returns the current color writing state
  31954. */
  31955. getColorWrite(): boolean;
  31956. /**
  31957. * Sets alpha constants used by some alpha blending modes
  31958. * @param r defines the red component
  31959. * @param g defines the green component
  31960. * @param b defines the blue component
  31961. * @param a defines the alpha component
  31962. */
  31963. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  31964. /**
  31965. * Sets the current alpha mode
  31966. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  31967. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  31968. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  31969. */
  31970. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  31971. /**
  31972. * Gets the current alpha mode
  31973. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  31974. * @returns the current alpha mode
  31975. */
  31976. getAlphaMode(): number;
  31977. /**
  31978. * Clears the list of texture accessible through engine.
  31979. * This can help preventing texture load conflict due to name collision.
  31980. */
  31981. clearInternalTexturesCache(): void;
  31982. /**
  31983. * Force the entire cache to be cleared
  31984. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  31985. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  31986. */
  31987. wipeCaches(bruteForce?: boolean): void;
  31988. /**
  31989. * Set the compressed texture format to use, based on the formats you have, and the formats
  31990. * supported by the hardware / browser.
  31991. *
  31992. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  31993. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  31994. * to API arguments needed to compressed textures. This puts the burden on the container
  31995. * generator to house the arcane code for determining these for current & future formats.
  31996. *
  31997. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  31998. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  31999. *
  32000. * Note: The result of this call is not taken into account when a texture is base64.
  32001. *
  32002. * @param formatsAvailable defines the list of those format families you have created
  32003. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  32004. *
  32005. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  32006. * @returns The extension selected.
  32007. */
  32008. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  32009. /** @hidden */
  32010. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  32011. min: number;
  32012. mag: number;
  32013. };
  32014. /** @hidden */
  32015. _createTexture(): WebGLTexture;
  32016. /**
  32017. * Usually called from Texture.ts.
  32018. * Passed information to create a WebGLTexture
  32019. * @param urlArg defines a value which contains one of the following:
  32020. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  32021. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  32022. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  32023. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  32024. * @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)
  32025. * @param scene needed for loading to the correct scene
  32026. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  32027. * @param onLoad optional callback to be called upon successful completion
  32028. * @param onError optional callback to be called upon failure
  32029. * @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
  32030. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  32031. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  32032. * @param forcedExtension defines the extension to use to pick the right loader
  32033. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  32034. * @returns a InternalTexture for assignment back into BABYLON.Texture
  32035. */
  32036. 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 | HTMLImageElement | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>): InternalTexture;
  32037. /**
  32038. * @hidden
  32039. * Rescales a texture
  32040. * @param source input texutre
  32041. * @param destination destination texture
  32042. * @param scene scene to use to render the resize
  32043. * @param internalFormat format to use when resizing
  32044. * @param onComplete callback to be called when resize has completed
  32045. */
  32046. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<Scene>, internalFormat: number, onComplete: () => void): void;
  32047. private _unpackFlipYCached;
  32048. /**
  32049. * In case you are sharing the context with other applications, it might
  32050. * be interested to not cache the unpack flip y state to ensure a consistent
  32051. * value would be set.
  32052. */
  32053. enableUnpackFlipYCached: boolean;
  32054. /** @hidden */
  32055. _unpackFlipY(value: boolean): void;
  32056. /** @hidden */
  32057. _getUnpackAlignement(): number;
  32058. /**
  32059. * Creates a dynamic texture
  32060. * @param width defines the width of the texture
  32061. * @param height defines the height of the texture
  32062. * @param generateMipMaps defines if the engine should generate the mip levels
  32063. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  32064. * @returns the dynamic texture inside an InternalTexture
  32065. */
  32066. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  32067. /**
  32068. * Update the sampling mode of a given texture
  32069. * @param samplingMode defines the required sampling mode
  32070. * @param texture defines the texture to update
  32071. */
  32072. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  32073. /**
  32074. * Update the content of a dynamic texture
  32075. * @param texture defines the texture to update
  32076. * @param canvas defines the canvas containing the source
  32077. * @param invertY defines if data must be stored with Y axis inverted
  32078. * @param premulAlpha defines if alpha is stored as premultiplied
  32079. * @param format defines the format of the data
  32080. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  32081. */
  32082. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  32083. /**
  32084. * Update a video texture
  32085. * @param texture defines the texture to update
  32086. * @param video defines the video element to use
  32087. * @param invertY defines if data must be stored with Y axis inverted
  32088. */
  32089. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  32090. /**
  32091. * Updates a depth texture Comparison Mode and Function.
  32092. * If the comparison Function is equal to 0, the mode will be set to none.
  32093. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  32094. * @param texture The texture to set the comparison function for
  32095. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  32096. */
  32097. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  32098. /** @hidden */
  32099. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  32100. width: number;
  32101. height: number;
  32102. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  32103. /**
  32104. * Creates a depth stencil texture.
  32105. * This is only available in WebGL 2 or with the depth texture extension available.
  32106. * @param size The size of face edge in the texture.
  32107. * @param options The options defining the texture.
  32108. * @returns The texture
  32109. */
  32110. createDepthStencilTexture(size: number | {
  32111. width: number;
  32112. height: number;
  32113. }, options: DepthTextureCreationOptions): InternalTexture;
  32114. /**
  32115. * Creates a depth stencil texture.
  32116. * This is only available in WebGL 2 or with the depth texture extension available.
  32117. * @param size The size of face edge in the texture.
  32118. * @param options The options defining the texture.
  32119. * @returns The texture
  32120. */
  32121. private _createDepthStencilTexture;
  32122. /**
  32123. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  32124. * @param renderTarget The render target to set the frame buffer for
  32125. */
  32126. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  32127. /**
  32128. * Creates a new render target texture
  32129. * @param size defines the size of the texture
  32130. * @param options defines the options used to create the texture
  32131. * @returns a new render target texture stored in an InternalTexture
  32132. */
  32133. createRenderTargetTexture(size: number | {
  32134. width: number;
  32135. height: number;
  32136. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  32137. /** @hidden */
  32138. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  32139. /**
  32140. * Updates the sample count of a render target texture
  32141. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  32142. * @param texture defines the texture to update
  32143. * @param samples defines the sample count to set
  32144. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  32145. */
  32146. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  32147. /** @hidden */
  32148. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  32149. /** @hidden */
  32150. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  32151. /** @hidden */
  32152. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  32153. /** @hidden */
  32154. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  32155. /**
  32156. * @hidden
  32157. */
  32158. _setCubeMapTextureParams(loadMipmap: boolean): void;
  32159. private _prepareWebGLTextureContinuation;
  32160. private _prepareWebGLTexture;
  32161. /** @hidden */
  32162. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32163. /** @hidden */
  32164. _releaseFramebufferObjects(texture: InternalTexture): void;
  32165. /** @hidden */
  32166. _releaseTexture(texture: InternalTexture): void;
  32167. private setProgram;
  32168. private _boundUniforms;
  32169. /**
  32170. * Binds an effect to the webGL context
  32171. * @param effect defines the effect to bind
  32172. */
  32173. bindSamplers(effect: Effect): void;
  32174. private _activateCurrentTexture;
  32175. /** @hidden */
  32176. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  32177. /** @hidden */
  32178. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  32179. /**
  32180. * Sets a texture to the webGL context from a postprocess
  32181. * @param channel defines the channel to use
  32182. * @param postProcess defines the source postprocess
  32183. */
  32184. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32185. /**
  32186. * Binds the output of the passed in post process to the texture channel specified
  32187. * @param channel The channel the texture should be bound to
  32188. * @param postProcess The post process which's output should be bound
  32189. */
  32190. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32191. /**
  32192. * Unbind all textures from the webGL context
  32193. */
  32194. unbindAllTextures(): void;
  32195. /**
  32196. * Sets a texture to the according uniform.
  32197. * @param channel The texture channel
  32198. * @param uniform The uniform to set
  32199. * @param texture The texture to apply
  32200. */
  32201. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  32202. /**
  32203. * Sets a depth stencil texture from a render target to the according uniform.
  32204. * @param channel The texture channel
  32205. * @param uniform The uniform to set
  32206. * @param texture The render target texture containing the depth stencil texture to apply
  32207. */
  32208. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32209. private _bindSamplerUniformToChannel;
  32210. private _getTextureWrapMode;
  32211. private _setTexture;
  32212. /**
  32213. * Sets an array of texture to the webGL context
  32214. * @param channel defines the channel where the texture array must be set
  32215. * @param uniform defines the associated uniform location
  32216. * @param textures defines the array of textures to bind
  32217. */
  32218. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  32219. /** @hidden */
  32220. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  32221. private _setTextureParameterFloat;
  32222. private _setTextureParameterInteger;
  32223. /**
  32224. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32225. * @param x defines the x coordinate of the rectangle where pixels must be read
  32226. * @param y defines the y coordinate of the rectangle where pixels must be read
  32227. * @param width defines the width of the rectangle where pixels must be read
  32228. * @param height defines the height of the rectangle where pixels must be read
  32229. * @returns a Uint8Array containing RGBA colors
  32230. */
  32231. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32232. /**
  32233. * Add an externaly attached data from its key.
  32234. * This method call will fail and return false, if such key already exists.
  32235. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  32236. * @param key the unique key that identifies the data
  32237. * @param data the data object to associate to the key for this Engine instance
  32238. * @return true if no such key were already present and the data was added successfully, false otherwise
  32239. */
  32240. addExternalData<T>(key: string, data: T): boolean;
  32241. /**
  32242. * Get an externaly attached data from its key
  32243. * @param key the unique key that identifies the data
  32244. * @return the associated data, if present (can be null), or undefined if not present
  32245. */
  32246. getExternalData<T>(key: string): T;
  32247. /**
  32248. * Get an externaly attached data from its key, create it using a factory if it's not already present
  32249. * @param key the unique key that identifies the data
  32250. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  32251. * @return the associated data, can be null if the factory returned null.
  32252. */
  32253. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  32254. /**
  32255. * Remove an externaly attached data from the Engine instance
  32256. * @param key the unique key that identifies the data
  32257. * @return true if the data was successfully removed, false if it doesn't exist
  32258. */
  32259. removeExternalData(key: string): boolean;
  32260. /**
  32261. * Unbind all vertex attributes from the webGL context
  32262. */
  32263. unbindAllAttributes(): void;
  32264. /**
  32265. * 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
  32266. */
  32267. releaseEffects(): void;
  32268. /**
  32269. * Dispose and release all associated resources
  32270. */
  32271. dispose(): void;
  32272. /**
  32273. * Display the loading screen
  32274. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32275. */
  32276. displayLoadingUI(): void;
  32277. /**
  32278. * Hide the loading screen
  32279. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32280. */
  32281. hideLoadingUI(): void;
  32282. /**
  32283. * Gets the current loading screen object
  32284. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32285. */
  32286. /**
  32287. * Sets the current loading screen object
  32288. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32289. */
  32290. loadingScreen: ILoadingScreen;
  32291. /**
  32292. * Sets the current loading screen text
  32293. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32294. */
  32295. loadingUIText: string;
  32296. /**
  32297. * Sets the current loading screen background color
  32298. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32299. */
  32300. loadingUIBackgroundColor: string;
  32301. /**
  32302. * Attach a new callback raised when context lost event is fired
  32303. * @param callback defines the callback to call
  32304. */
  32305. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  32306. /**
  32307. * Attach a new callback raised when context restored event is fired
  32308. * @param callback defines the callback to call
  32309. */
  32310. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  32311. /**
  32312. * Gets the source code of the vertex shader associated with a specific webGL program
  32313. * @param program defines the program to use
  32314. * @returns a string containing the source code of the vertex shader associated with the program
  32315. */
  32316. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32317. /**
  32318. * Gets the source code of the fragment shader associated with a specific webGL program
  32319. * @param program defines the program to use
  32320. * @returns a string containing the source code of the fragment shader associated with the program
  32321. */
  32322. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32323. /**
  32324. * Get the current error code of the webGL context
  32325. * @returns the error code
  32326. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  32327. */
  32328. getError(): number;
  32329. /**
  32330. * Gets the current framerate
  32331. * @returns a number representing the framerate
  32332. */
  32333. getFps(): number;
  32334. /**
  32335. * Gets the time spent between current and previous frame
  32336. * @returns a number representing the delta time in ms
  32337. */
  32338. getDeltaTime(): number;
  32339. private _measureFps;
  32340. /** @hidden */
  32341. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  32342. private _canRenderToFloatFramebuffer;
  32343. private _canRenderToHalfFloatFramebuffer;
  32344. private _canRenderToFramebuffer;
  32345. /** @hidden */
  32346. _getWebGLTextureType(type: number): number;
  32347. /** @hidden */
  32348. _getInternalFormat(format: number): number;
  32349. /** @hidden */
  32350. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  32351. /** @hidden */
  32352. _getRGBAMultiSampleBufferFormat(type: number): number;
  32353. /** @hidden */
  32354. _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;
  32355. /** @hidden */
  32356. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32357. /**
  32358. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  32359. * @returns true if the engine can be created
  32360. * @ignorenaming
  32361. */
  32362. static isSupported(): boolean;
  32363. /**
  32364. * Find the next highest power of two.
  32365. * @param x Number to start search from.
  32366. * @return Next highest power of two.
  32367. */
  32368. static CeilingPOT(x: number): number;
  32369. /**
  32370. * Find the next lowest power of two.
  32371. * @param x Number to start search from.
  32372. * @return Next lowest power of two.
  32373. */
  32374. static FloorPOT(x: number): number;
  32375. /**
  32376. * Find the nearest power of two.
  32377. * @param x Number to start search from.
  32378. * @return Next nearest power of two.
  32379. */
  32380. static NearestPOT(x: number): number;
  32381. /**
  32382. * Get the closest exponent of two
  32383. * @param value defines the value to approximate
  32384. * @param max defines the maximum value to return
  32385. * @param mode defines how to define the closest value
  32386. * @returns closest exponent of two of the given value
  32387. */
  32388. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  32389. /**
  32390. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  32391. * @param func - the function to be called
  32392. * @param requester - the object that will request the next frame. Falls back to window.
  32393. * @returns frame number
  32394. */
  32395. static QueueNewFrame(func: () => void, requester?: any): number;
  32396. /**
  32397. * Ask the browser to promote the current element to pointerlock mode
  32398. * @param element defines the DOM element to promote
  32399. */
  32400. static _RequestPointerlock(element: HTMLElement): void;
  32401. /**
  32402. * Asks the browser to exit pointerlock mode
  32403. */
  32404. static _ExitPointerlock(): void;
  32405. /**
  32406. * Ask the browser to promote the current element to fullscreen rendering mode
  32407. * @param element defines the DOM element to promote
  32408. */
  32409. static _RequestFullscreen(element: HTMLElement): void;
  32410. /**
  32411. * Asks the browser to exit fullscreen mode
  32412. */
  32413. static _ExitFullscreen(): void;
  32414. }
  32415. }
  32416. declare module "babylonjs/Engines/engineStore" {
  32417. import { Nullable } from "babylonjs/types";
  32418. import { Engine } from "babylonjs/Engines/engine";
  32419. import { Scene } from "babylonjs/scene";
  32420. /**
  32421. * The engine store class is responsible to hold all the instances of Engine and Scene created
  32422. * during the life time of the application.
  32423. */
  32424. export class EngineStore {
  32425. /** Gets the list of created engines */
  32426. static Instances: import("babylonjs/Engines/engine").Engine[];
  32427. /** @hidden */
  32428. static _LastCreatedScene: Nullable<Scene>;
  32429. /**
  32430. * Gets the latest created engine
  32431. */
  32432. static readonly LastCreatedEngine: Nullable<Engine>;
  32433. /**
  32434. * Gets the latest created scene
  32435. */
  32436. static readonly LastCreatedScene: Nullable<Scene>;
  32437. /**
  32438. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32439. * @ignorenaming
  32440. */
  32441. static UseFallbackTexture: boolean;
  32442. /**
  32443. * Texture content used if a texture cannot loaded
  32444. * @ignorenaming
  32445. */
  32446. static FallbackTexture: string;
  32447. }
  32448. }
  32449. declare module "babylonjs/Misc/promise" {
  32450. /**
  32451. * Helper class that provides a small promise polyfill
  32452. */
  32453. export class PromisePolyfill {
  32454. /**
  32455. * Static function used to check if the polyfill is required
  32456. * If this is the case then the function will inject the polyfill to window.Promise
  32457. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  32458. */
  32459. static Apply(force?: boolean): void;
  32460. }
  32461. }
  32462. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  32463. /**
  32464. * Interface for screenshot methods with describe argument called `size` as object with options
  32465. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  32466. */
  32467. export interface IScreenshotSize {
  32468. /**
  32469. * number in pixels for canvas height
  32470. */
  32471. height?: number;
  32472. /**
  32473. * multiplier allowing render at a higher or lower resolution
  32474. * If value is defined then height and width will be ignored and taken from camera
  32475. */
  32476. precision?: number;
  32477. /**
  32478. * number in pixels for canvas width
  32479. */
  32480. width?: number;
  32481. }
  32482. }
  32483. declare module "babylonjs/Misc/tools" {
  32484. import { Nullable, float } from "babylonjs/types";
  32485. import { DomManagement } from "babylonjs/Misc/domManagement";
  32486. import { WebRequest } from "babylonjs/Misc/webRequest";
  32487. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  32488. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32489. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  32490. import { Camera } from "babylonjs/Cameras/camera";
  32491. import { Engine } from "babylonjs/Engines/engine";
  32492. interface IColor4Like {
  32493. r: float;
  32494. g: float;
  32495. b: float;
  32496. a: float;
  32497. }
  32498. /**
  32499. * Class containing a set of static utilities functions
  32500. */
  32501. export class Tools {
  32502. /**
  32503. * Gets or sets the base URL to use to load assets
  32504. */
  32505. static BaseUrl: string;
  32506. /**
  32507. * Enable/Disable Custom HTTP Request Headers globally.
  32508. * default = false
  32509. * @see CustomRequestHeaders
  32510. */
  32511. static UseCustomRequestHeaders: boolean;
  32512. /**
  32513. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  32514. * i.e. when loading files, where the server/service expects an Authorization header
  32515. */
  32516. static CustomRequestHeaders: {
  32517. [key: string]: string;
  32518. };
  32519. /**
  32520. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  32521. */
  32522. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  32523. /**
  32524. * Default behaviour for cors in the application.
  32525. * It can be a string if the expected behavior is identical in the entire app.
  32526. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  32527. */
  32528. static CorsBehavior: string | ((url: string | string[]) => string);
  32529. /**
  32530. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32531. * @ignorenaming
  32532. */
  32533. static UseFallbackTexture: boolean;
  32534. /**
  32535. * Use this object to register external classes like custom textures or material
  32536. * to allow the laoders to instantiate them
  32537. */
  32538. static RegisteredExternalClasses: {
  32539. [key: string]: Object;
  32540. };
  32541. /**
  32542. * Texture content used if a texture cannot loaded
  32543. * @ignorenaming
  32544. */
  32545. static fallbackTexture: string;
  32546. /**
  32547. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  32548. * @param u defines the coordinate on X axis
  32549. * @param v defines the coordinate on Y axis
  32550. * @param width defines the width of the source data
  32551. * @param height defines the height of the source data
  32552. * @param pixels defines the source byte array
  32553. * @param color defines the output color
  32554. */
  32555. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  32556. /**
  32557. * Interpolates between a and b via alpha
  32558. * @param a The lower value (returned when alpha = 0)
  32559. * @param b The upper value (returned when alpha = 1)
  32560. * @param alpha The interpolation-factor
  32561. * @return The mixed value
  32562. */
  32563. static Mix(a: number, b: number, alpha: number): number;
  32564. /**
  32565. * Tries to instantiate a new object from a given class name
  32566. * @param className defines the class name to instantiate
  32567. * @returns the new object or null if the system was not able to do the instantiation
  32568. */
  32569. static Instantiate(className: string): any;
  32570. /**
  32571. * Provides a slice function that will work even on IE
  32572. * @param data defines the array to slice
  32573. * @param start defines the start of the data (optional)
  32574. * @param end defines the end of the data (optional)
  32575. * @returns the new sliced array
  32576. */
  32577. static Slice<T>(data: T, start?: number, end?: number): T;
  32578. /**
  32579. * Polyfill for setImmediate
  32580. * @param action defines the action to execute after the current execution block
  32581. */
  32582. static SetImmediate(action: () => void): void;
  32583. /**
  32584. * Function indicating if a number is an exponent of 2
  32585. * @param value defines the value to test
  32586. * @returns true if the value is an exponent of 2
  32587. */
  32588. static IsExponentOfTwo(value: number): boolean;
  32589. private static _tmpFloatArray;
  32590. /**
  32591. * Returns the nearest 32-bit single precision float representation of a Number
  32592. * @param value A Number. If the parameter is of a different type, it will get converted
  32593. * to a number or to NaN if it cannot be converted
  32594. * @returns number
  32595. */
  32596. static FloatRound(value: number): number;
  32597. /**
  32598. * Extracts the filename from a path
  32599. * @param path defines the path to use
  32600. * @returns the filename
  32601. */
  32602. static GetFilename(path: string): string;
  32603. /**
  32604. * Extracts the "folder" part of a path (everything before the filename).
  32605. * @param uri The URI to extract the info from
  32606. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  32607. * @returns The "folder" part of the path
  32608. */
  32609. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  32610. /**
  32611. * Extracts text content from a DOM element hierarchy
  32612. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  32613. */
  32614. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  32615. /**
  32616. * Convert an angle in radians to degrees
  32617. * @param angle defines the angle to convert
  32618. * @returns the angle in degrees
  32619. */
  32620. static ToDegrees(angle: number): number;
  32621. /**
  32622. * Convert an angle in degrees to radians
  32623. * @param angle defines the angle to convert
  32624. * @returns the angle in radians
  32625. */
  32626. static ToRadians(angle: number): number;
  32627. /**
  32628. * Encode a buffer to a base64 string
  32629. * @param buffer defines the buffer to encode
  32630. * @returns the encoded string
  32631. */
  32632. static EncodeArrayBufferTobase64(buffer: ArrayBuffer): string;
  32633. /**
  32634. * Returns an array if obj is not an array
  32635. * @param obj defines the object to evaluate as an array
  32636. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  32637. * @returns either obj directly if obj is an array or a new array containing obj
  32638. */
  32639. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  32640. /**
  32641. * Gets the pointer prefix to use
  32642. * @returns "pointer" if touch is enabled. Else returns "mouse"
  32643. */
  32644. static GetPointerPrefix(): string;
  32645. /**
  32646. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  32647. * @param url define the url we are trying
  32648. * @param element define the dom element where to configure the cors policy
  32649. */
  32650. static SetCorsBehavior(url: string | string[], element: {
  32651. crossOrigin: string | null;
  32652. }): void;
  32653. /**
  32654. * Removes unwanted characters from an url
  32655. * @param url defines the url to clean
  32656. * @returns the cleaned url
  32657. */
  32658. static CleanUrl(url: string): string;
  32659. /**
  32660. * Gets or sets a function used to pre-process url before using them to load assets
  32661. */
  32662. static PreprocessUrl: (url: string) => string;
  32663. /**
  32664. * Loads an image as an HTMLImageElement.
  32665. * @param input url string, ArrayBuffer, or Blob to load
  32666. * @param onLoad callback called when the image successfully loads
  32667. * @param onError callback called when the image fails to load
  32668. * @param offlineProvider offline provider for caching
  32669. * @returns the HTMLImageElement of the loaded image
  32670. */
  32671. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  32672. /**
  32673. * Loads a file
  32674. * @param url url string, ArrayBuffer, or Blob to load
  32675. * @param onSuccess callback called when the file successfully loads
  32676. * @param onProgress callback called while file is loading (if the server supports this mode)
  32677. * @param offlineProvider defines the offline provider for caching
  32678. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  32679. * @param onError callback called when the file fails to load
  32680. * @returns a file request object
  32681. */
  32682. 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;
  32683. /**
  32684. * Loads a file from a url
  32685. * @param url the file url to load
  32686. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  32687. */
  32688. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  32689. /**
  32690. * Load a script (identified by an url). When the url returns, the
  32691. * content of this file is added into a new script element, attached to the DOM (body element)
  32692. * @param scriptUrl defines the url of the script to laod
  32693. * @param onSuccess defines the callback called when the script is loaded
  32694. * @param onError defines the callback to call if an error occurs
  32695. * @param scriptId defines the id of the script element
  32696. */
  32697. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  32698. /**
  32699. * Load an asynchronous script (identified by an url). When the url returns, the
  32700. * content of this file is added into a new script element, attached to the DOM (body element)
  32701. * @param scriptUrl defines the url of the script to laod
  32702. * @param scriptId defines the id of the script element
  32703. * @returns a promise request object
  32704. */
  32705. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  32706. /**
  32707. * Loads a file from a blob
  32708. * @param fileToLoad defines the blob to use
  32709. * @param callback defines the callback to call when data is loaded
  32710. * @param progressCallback defines the callback to call during loading process
  32711. * @returns a file request object
  32712. */
  32713. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  32714. /**
  32715. * Loads a file
  32716. * @param fileToLoad defines the file to load
  32717. * @param callback defines the callback to call when data is loaded
  32718. * @param progressCallBack defines the callback to call during loading process
  32719. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  32720. * @returns a file request object
  32721. */
  32722. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  32723. /**
  32724. * Creates a data url from a given string content
  32725. * @param content defines the content to convert
  32726. * @returns the new data url link
  32727. */
  32728. static FileAsURL(content: string): string;
  32729. /**
  32730. * Format the given number to a specific decimal format
  32731. * @param value defines the number to format
  32732. * @param decimals defines the number of decimals to use
  32733. * @returns the formatted string
  32734. */
  32735. static Format(value: number, decimals?: number): string;
  32736. /**
  32737. * Tries to copy an object by duplicating every property
  32738. * @param source defines the source object
  32739. * @param destination defines the target object
  32740. * @param doNotCopyList defines a list of properties to avoid
  32741. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  32742. */
  32743. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  32744. /**
  32745. * Gets a boolean indicating if the given object has no own property
  32746. * @param obj defines the object to test
  32747. * @returns true if object has no own property
  32748. */
  32749. static IsEmpty(obj: any): boolean;
  32750. /**
  32751. * Function used to register events at window level
  32752. * @param windowElement defines the Window object to use
  32753. * @param events defines the events to register
  32754. */
  32755. static RegisterTopRootEvents(windowElement: Window, events: {
  32756. name: string;
  32757. handler: Nullable<(e: FocusEvent) => any>;
  32758. }[]): void;
  32759. /**
  32760. * Function used to unregister events from window level
  32761. * @param windowElement defines the Window object to use
  32762. * @param events defines the events to unregister
  32763. */
  32764. static UnregisterTopRootEvents(windowElement: Window, events: {
  32765. name: string;
  32766. handler: Nullable<(e: FocusEvent) => any>;
  32767. }[]): void;
  32768. /**
  32769. * @ignore
  32770. */
  32771. static _ScreenshotCanvas: HTMLCanvasElement;
  32772. /**
  32773. * Dumps the current bound framebuffer
  32774. * @param width defines the rendering width
  32775. * @param height defines the rendering height
  32776. * @param engine defines the hosting engine
  32777. * @param successCallback defines the callback triggered once the data are available
  32778. * @param mimeType defines the mime type of the result
  32779. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  32780. */
  32781. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  32782. /**
  32783. * Converts the canvas data to blob.
  32784. * This acts as a polyfill for browsers not supporting the to blob function.
  32785. * @param canvas Defines the canvas to extract the data from
  32786. * @param successCallback Defines the callback triggered once the data are available
  32787. * @param mimeType Defines the mime type of the result
  32788. */
  32789. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  32790. /**
  32791. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  32792. * @param successCallback defines the callback triggered once the data are available
  32793. * @param mimeType defines the mime type of the result
  32794. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  32795. */
  32796. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  32797. /**
  32798. * Downloads a blob in the browser
  32799. * @param blob defines the blob to download
  32800. * @param fileName defines the name of the downloaded file
  32801. */
  32802. static Download(blob: Blob, fileName: string): void;
  32803. /**
  32804. * Captures a screenshot of the current rendering
  32805. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32806. * @param engine defines the rendering engine
  32807. * @param camera defines the source camera
  32808. * @param size This parameter can be set to a single number or to an object with the
  32809. * following (optional) properties: precision, width, height. If a single number is passed,
  32810. * it will be used for both width and height. If an object is passed, the screenshot size
  32811. * will be derived from the parameters. The precision property is a multiplier allowing
  32812. * rendering at a higher or lower resolution
  32813. * @param successCallback defines the callback receives a single parameter which contains the
  32814. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  32815. * src parameter of an <img> to display it
  32816. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  32817. * Check your browser for supported MIME types
  32818. */
  32819. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  32820. /**
  32821. * Captures a screenshot of the current rendering
  32822. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32823. * @param engine defines the rendering engine
  32824. * @param camera defines the source camera
  32825. * @param size This parameter can be set to a single number or to an object with the
  32826. * following (optional) properties: precision, width, height. If a single number is passed,
  32827. * it will be used for both width and height. If an object is passed, the screenshot size
  32828. * will be derived from the parameters. The precision property is a multiplier allowing
  32829. * rendering at a higher or lower resolution
  32830. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  32831. * Check your browser for supported MIME types
  32832. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  32833. * to the src parameter of an <img> to display it
  32834. */
  32835. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  32836. /**
  32837. * Generates an image screenshot from the specified camera.
  32838. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32839. * @param engine The engine to use for rendering
  32840. * @param camera The camera to use for rendering
  32841. * @param size This parameter can be set to a single number or to an object with the
  32842. * following (optional) properties: precision, width, height. If a single number is passed,
  32843. * it will be used for both width and height. If an object is passed, the screenshot size
  32844. * will be derived from the parameters. The precision property is a multiplier allowing
  32845. * rendering at a higher or lower resolution
  32846. * @param successCallback The callback receives a single parameter which contains the
  32847. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  32848. * src parameter of an <img> to display it
  32849. * @param mimeType The MIME type of the screenshot image (default: image/png).
  32850. * Check your browser for supported MIME types
  32851. * @param samples Texture samples (default: 1)
  32852. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  32853. * @param fileName A name for for the downloaded file.
  32854. */
  32855. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  32856. /**
  32857. * Generates an image screenshot from the specified camera.
  32858. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  32859. * @param engine The engine to use for rendering
  32860. * @param camera The camera to use for rendering
  32861. * @param size This parameter can be set to a single number or to an object with the
  32862. * following (optional) properties: precision, width, height. If a single number is passed,
  32863. * it will be used for both width and height. If an object is passed, the screenshot size
  32864. * will be derived from the parameters. The precision property is a multiplier allowing
  32865. * rendering at a higher or lower resolution
  32866. * @param mimeType The MIME type of the screenshot image (default: image/png).
  32867. * Check your browser for supported MIME types
  32868. * @param samples Texture samples (default: 1)
  32869. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  32870. * @param fileName A name for for the downloaded file.
  32871. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  32872. * to the src parameter of an <img> to display it
  32873. */
  32874. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  32875. /**
  32876. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  32877. * Be aware Math.random() could cause collisions, but:
  32878. * "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"
  32879. * @returns a pseudo random id
  32880. */
  32881. static RandomId(): string;
  32882. /**
  32883. * Test if the given uri is a base64 string
  32884. * @param uri The uri to test
  32885. * @return True if the uri is a base64 string or false otherwise
  32886. */
  32887. static IsBase64(uri: string): boolean;
  32888. /**
  32889. * Decode the given base64 uri.
  32890. * @param uri The uri to decode
  32891. * @return The decoded base64 data.
  32892. */
  32893. static DecodeBase64(uri: string): ArrayBuffer;
  32894. /**
  32895. * Gets the absolute url.
  32896. * @param url the input url
  32897. * @return the absolute url
  32898. */
  32899. static GetAbsoluteUrl(url: string): string;
  32900. /**
  32901. * No log
  32902. */
  32903. static readonly NoneLogLevel: number;
  32904. /**
  32905. * Only message logs
  32906. */
  32907. static readonly MessageLogLevel: number;
  32908. /**
  32909. * Only warning logs
  32910. */
  32911. static readonly WarningLogLevel: number;
  32912. /**
  32913. * Only error logs
  32914. */
  32915. static readonly ErrorLogLevel: number;
  32916. /**
  32917. * All logs
  32918. */
  32919. static readonly AllLogLevel: number;
  32920. /**
  32921. * Gets a value indicating the number of loading errors
  32922. * @ignorenaming
  32923. */
  32924. static readonly errorsCount: number;
  32925. /**
  32926. * Callback called when a new log is added
  32927. */
  32928. static OnNewCacheEntry: (entry: string) => void;
  32929. /**
  32930. * Log a message to the console
  32931. * @param message defines the message to log
  32932. */
  32933. static Log(message: string): void;
  32934. /**
  32935. * Write a warning message to the console
  32936. * @param message defines the message to log
  32937. */
  32938. static Warn(message: string): void;
  32939. /**
  32940. * Write an error message to the console
  32941. * @param message defines the message to log
  32942. */
  32943. static Error(message: string): void;
  32944. /**
  32945. * Gets current log cache (list of logs)
  32946. */
  32947. static readonly LogCache: string;
  32948. /**
  32949. * Clears the log cache
  32950. */
  32951. static ClearLogCache(): void;
  32952. /**
  32953. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  32954. */
  32955. static LogLevels: number;
  32956. /**
  32957. * Checks if the window object exists
  32958. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  32959. */
  32960. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  32961. /**
  32962. * No performance log
  32963. */
  32964. static readonly PerformanceNoneLogLevel: number;
  32965. /**
  32966. * Use user marks to log performance
  32967. */
  32968. static readonly PerformanceUserMarkLogLevel: number;
  32969. /**
  32970. * Log performance to the console
  32971. */
  32972. static readonly PerformanceConsoleLogLevel: number;
  32973. private static _performance;
  32974. /**
  32975. * Sets the current performance log level
  32976. */
  32977. static PerformanceLogLevel: number;
  32978. private static _StartPerformanceCounterDisabled;
  32979. private static _EndPerformanceCounterDisabled;
  32980. private static _StartUserMark;
  32981. private static _EndUserMark;
  32982. private static _StartPerformanceConsole;
  32983. private static _EndPerformanceConsole;
  32984. /**
  32985. * Starts a performance counter
  32986. */
  32987. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  32988. /**
  32989. * Ends a specific performance coutner
  32990. */
  32991. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  32992. /**
  32993. * Gets either window.performance.now() if supported or Date.now() else
  32994. */
  32995. static readonly Now: number;
  32996. /**
  32997. * This method will return the name of the class used to create the instance of the given object.
  32998. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  32999. * @param object the object to get the class name from
  33000. * @param isType defines if the object is actually a type
  33001. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33002. */
  33003. static GetClassName(object: any, isType?: boolean): string;
  33004. /**
  33005. * Gets the first element of an array satisfying a given predicate
  33006. * @param array defines the array to browse
  33007. * @param predicate defines the predicate to use
  33008. * @returns null if not found or the element
  33009. */
  33010. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33011. /**
  33012. * This method will return the name of the full name of the class, including its owning module (if any).
  33013. * 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).
  33014. * @param object the object to get the class name from
  33015. * @param isType defines if the object is actually a type
  33016. * @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.
  33017. * @ignorenaming
  33018. */
  33019. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33020. /**
  33021. * Returns a promise that resolves after the given amount of time.
  33022. * @param delay Number of milliseconds to delay
  33023. * @returns Promise that resolves after the given amount of time
  33024. */
  33025. static DelayAsync(delay: number): Promise<void>;
  33026. }
  33027. /**
  33028. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33029. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33030. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33031. * @param name The name of the class, case should be preserved
  33032. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33033. */
  33034. export function className(name: string, module?: string): (target: Object) => void;
  33035. /**
  33036. * An implementation of a loop for asynchronous functions.
  33037. */
  33038. export class AsyncLoop {
  33039. /**
  33040. * Defines the number of iterations for the loop
  33041. */
  33042. iterations: number;
  33043. /**
  33044. * Defines the current index of the loop.
  33045. */
  33046. index: number;
  33047. private _done;
  33048. private _fn;
  33049. private _successCallback;
  33050. /**
  33051. * Constructor.
  33052. * @param iterations the number of iterations.
  33053. * @param func the function to run each iteration
  33054. * @param successCallback the callback that will be called upon succesful execution
  33055. * @param offset starting offset.
  33056. */
  33057. constructor(
  33058. /**
  33059. * Defines the number of iterations for the loop
  33060. */
  33061. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33062. /**
  33063. * Execute the next iteration. Must be called after the last iteration was finished.
  33064. */
  33065. executeNext(): void;
  33066. /**
  33067. * Break the loop and run the success callback.
  33068. */
  33069. breakLoop(): void;
  33070. /**
  33071. * Create and run an async loop.
  33072. * @param iterations the number of iterations.
  33073. * @param fn the function to run each iteration
  33074. * @param successCallback the callback that will be called upon succesful execution
  33075. * @param offset starting offset.
  33076. * @returns the created async loop object
  33077. */
  33078. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33079. /**
  33080. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33081. * @param iterations total number of iterations
  33082. * @param syncedIterations number of synchronous iterations in each async iteration.
  33083. * @param fn the function to call each iteration.
  33084. * @param callback a success call back that will be called when iterating stops.
  33085. * @param breakFunction a break condition (optional)
  33086. * @param timeout timeout settings for the setTimeout function. default - 0.
  33087. * @returns the created async loop object
  33088. */
  33089. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33090. }
  33091. }
  33092. declare module "babylonjs/Collisions/collisionCoordinator" {
  33093. import { Nullable } from "babylonjs/types";
  33094. import { Scene } from "babylonjs/scene";
  33095. import { Vector3 } from "babylonjs/Maths/math.vector";
  33096. import { Collider } from "babylonjs/Collisions/collider";
  33097. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33098. /** @hidden */
  33099. export interface ICollisionCoordinator {
  33100. createCollider(): Collider;
  33101. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33102. init(scene: Scene): void;
  33103. }
  33104. /** @hidden */
  33105. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33106. private _scene;
  33107. private _scaledPosition;
  33108. private _scaledVelocity;
  33109. private _finalPosition;
  33110. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33111. createCollider(): Collider;
  33112. init(scene: Scene): void;
  33113. private _collideWithWorld;
  33114. }
  33115. }
  33116. declare module "babylonjs/Inputs/scene.inputManager" {
  33117. import { Nullable } from "babylonjs/types";
  33118. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33119. import { Vector2 } from "babylonjs/Maths/math.vector";
  33120. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33121. import { Scene } from "babylonjs/scene";
  33122. /**
  33123. * Class used to manage all inputs for the scene.
  33124. */
  33125. export class InputManager {
  33126. /** The distance in pixel that you have to move to prevent some events */
  33127. static DragMovementThreshold: number;
  33128. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33129. static LongPressDelay: number;
  33130. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33131. static DoubleClickDelay: number;
  33132. /** If you need to check double click without raising a single click at first click, enable this flag */
  33133. static ExclusiveDoubleClickMode: boolean;
  33134. private _wheelEventName;
  33135. private _onPointerMove;
  33136. private _onPointerDown;
  33137. private _onPointerUp;
  33138. private _initClickEvent;
  33139. private _initActionManager;
  33140. private _delayedSimpleClick;
  33141. private _delayedSimpleClickTimeout;
  33142. private _previousDelayedSimpleClickTimeout;
  33143. private _meshPickProceed;
  33144. private _previousButtonPressed;
  33145. private _currentPickResult;
  33146. private _previousPickResult;
  33147. private _totalPointersPressed;
  33148. private _doubleClickOccured;
  33149. private _pointerOverMesh;
  33150. private _pickedDownMesh;
  33151. private _pickedUpMesh;
  33152. private _pointerX;
  33153. private _pointerY;
  33154. private _unTranslatedPointerX;
  33155. private _unTranslatedPointerY;
  33156. private _startingPointerPosition;
  33157. private _previousStartingPointerPosition;
  33158. private _startingPointerTime;
  33159. private _previousStartingPointerTime;
  33160. private _pointerCaptures;
  33161. private _onKeyDown;
  33162. private _onKeyUp;
  33163. private _onCanvasFocusObserver;
  33164. private _onCanvasBlurObserver;
  33165. private _scene;
  33166. /**
  33167. * Creates a new InputManager
  33168. * @param scene defines the hosting scene
  33169. */
  33170. constructor(scene: Scene);
  33171. /**
  33172. * Gets the mesh that is currently under the pointer
  33173. */
  33174. readonly meshUnderPointer: Nullable<AbstractMesh>;
  33175. /**
  33176. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  33177. */
  33178. readonly unTranslatedPointer: Vector2;
  33179. /**
  33180. * Gets or sets the current on-screen X position of the pointer
  33181. */
  33182. pointerX: number;
  33183. /**
  33184. * Gets or sets the current on-screen Y position of the pointer
  33185. */
  33186. pointerY: number;
  33187. private _updatePointerPosition;
  33188. private _processPointerMove;
  33189. private _setRayOnPointerInfo;
  33190. private _checkPrePointerObservable;
  33191. /**
  33192. * Use this method to simulate a pointer move on a mesh
  33193. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33194. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33195. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33196. */
  33197. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33198. /**
  33199. * Use this method to simulate a pointer down on a mesh
  33200. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33201. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33202. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33203. */
  33204. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33205. private _processPointerDown;
  33206. /** @hidden */
  33207. _isPointerSwiping(): boolean;
  33208. /**
  33209. * Use this method to simulate a pointer up on a mesh
  33210. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33211. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33212. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33213. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  33214. */
  33215. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  33216. private _processPointerUp;
  33217. /**
  33218. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  33219. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  33220. * @returns true if the pointer was captured
  33221. */
  33222. isPointerCaptured(pointerId?: number): boolean;
  33223. /**
  33224. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  33225. * @param attachUp defines if you want to attach events to pointerup
  33226. * @param attachDown defines if you want to attach events to pointerdown
  33227. * @param attachMove defines if you want to attach events to pointermove
  33228. */
  33229. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  33230. /**
  33231. * Detaches all event handlers
  33232. */
  33233. detachControl(): void;
  33234. /**
  33235. * Force the value of meshUnderPointer
  33236. * @param mesh defines the mesh to use
  33237. */
  33238. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  33239. /**
  33240. * Gets the mesh under the pointer
  33241. * @returns a Mesh or null if no mesh is under the pointer
  33242. */
  33243. getPointerOverMesh(): Nullable<AbstractMesh>;
  33244. }
  33245. }
  33246. declare module "babylonjs/Misc/uniqueIdGenerator" {
  33247. /**
  33248. * Helper class used to generate session unique ID
  33249. */
  33250. export class UniqueIdGenerator {
  33251. private static _UniqueIdCounter;
  33252. /**
  33253. * Gets an unique (relatively to the current scene) Id
  33254. */
  33255. static readonly UniqueId: number;
  33256. }
  33257. }
  33258. declare module "babylonjs/Animations/animationGroup" {
  33259. import { Animatable } from "babylonjs/Animations/animatable";
  33260. import { Animation } from "babylonjs/Animations/animation";
  33261. import { Scene, IDisposable } from "babylonjs/scene";
  33262. import { Observable } from "babylonjs/Misc/observable";
  33263. import { Nullable } from "babylonjs/types";
  33264. import "babylonjs/Animations/animatable";
  33265. /**
  33266. * This class defines the direct association between an animation and a target
  33267. */
  33268. export class TargetedAnimation {
  33269. /**
  33270. * Animation to perform
  33271. */
  33272. animation: Animation;
  33273. /**
  33274. * Target to animate
  33275. */
  33276. target: any;
  33277. /**
  33278. * Serialize the object
  33279. * @returns the JSON object representing the current entity
  33280. */
  33281. serialize(): any;
  33282. }
  33283. /**
  33284. * Use this class to create coordinated animations on multiple targets
  33285. */
  33286. export class AnimationGroup implements IDisposable {
  33287. /** The name of the animation group */
  33288. name: string;
  33289. private _scene;
  33290. private _targetedAnimations;
  33291. private _animatables;
  33292. private _from;
  33293. private _to;
  33294. private _isStarted;
  33295. private _isPaused;
  33296. private _speedRatio;
  33297. private _loopAnimation;
  33298. /**
  33299. * Gets or sets the unique id of the node
  33300. */
  33301. uniqueId: number;
  33302. /**
  33303. * This observable will notify when one animation have ended
  33304. */
  33305. onAnimationEndObservable: Observable<TargetedAnimation>;
  33306. /**
  33307. * Observer raised when one animation loops
  33308. */
  33309. onAnimationLoopObservable: Observable<TargetedAnimation>;
  33310. /**
  33311. * This observable will notify when all animations have ended.
  33312. */
  33313. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  33314. /**
  33315. * This observable will notify when all animations have paused.
  33316. */
  33317. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  33318. /**
  33319. * This observable will notify when all animations are playing.
  33320. */
  33321. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  33322. /**
  33323. * Gets the first frame
  33324. */
  33325. readonly from: number;
  33326. /**
  33327. * Gets the last frame
  33328. */
  33329. readonly to: number;
  33330. /**
  33331. * Define if the animations are started
  33332. */
  33333. readonly isStarted: boolean;
  33334. /**
  33335. * Gets a value indicating that the current group is playing
  33336. */
  33337. readonly isPlaying: boolean;
  33338. /**
  33339. * Gets or sets the speed ratio to use for all animations
  33340. */
  33341. /**
  33342. * Gets or sets the speed ratio to use for all animations
  33343. */
  33344. speedRatio: number;
  33345. /**
  33346. * Gets or sets if all animations should loop or not
  33347. */
  33348. loopAnimation: boolean;
  33349. /**
  33350. * Gets the targeted animations for this animation group
  33351. */
  33352. readonly targetedAnimations: Array<TargetedAnimation>;
  33353. /**
  33354. * returning the list of animatables controlled by this animation group.
  33355. */
  33356. readonly animatables: Array<Animatable>;
  33357. /**
  33358. * Instantiates a new Animation Group.
  33359. * This helps managing several animations at once.
  33360. * @see http://doc.babylonjs.com/how_to/group
  33361. * @param name Defines the name of the group
  33362. * @param scene Defines the scene the group belongs to
  33363. */
  33364. constructor(
  33365. /** The name of the animation group */
  33366. name: string, scene?: Nullable<Scene>);
  33367. /**
  33368. * Add an animation (with its target) in the group
  33369. * @param animation defines the animation we want to add
  33370. * @param target defines the target of the animation
  33371. * @returns the TargetedAnimation object
  33372. */
  33373. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  33374. /**
  33375. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  33376. * It can add constant keys at begin or end
  33377. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  33378. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  33379. * @returns the animation group
  33380. */
  33381. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  33382. /**
  33383. * Start all animations on given targets
  33384. * @param loop defines if animations must loop
  33385. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  33386. * @param from defines the from key (optional)
  33387. * @param to defines the to key (optional)
  33388. * @returns the current animation group
  33389. */
  33390. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  33391. /**
  33392. * Pause all animations
  33393. * @returns the animation group
  33394. */
  33395. pause(): AnimationGroup;
  33396. /**
  33397. * Play all animations to initial state
  33398. * This function will start() the animations if they were not started or will restart() them if they were paused
  33399. * @param loop defines if animations must loop
  33400. * @returns the animation group
  33401. */
  33402. play(loop?: boolean): AnimationGroup;
  33403. /**
  33404. * Reset all animations to initial state
  33405. * @returns the animation group
  33406. */
  33407. reset(): AnimationGroup;
  33408. /**
  33409. * Restart animations from key 0
  33410. * @returns the animation group
  33411. */
  33412. restart(): AnimationGroup;
  33413. /**
  33414. * Stop all animations
  33415. * @returns the animation group
  33416. */
  33417. stop(): AnimationGroup;
  33418. /**
  33419. * Set animation weight for all animatables
  33420. * @param weight defines the weight to use
  33421. * @return the animationGroup
  33422. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33423. */
  33424. setWeightForAllAnimatables(weight: number): AnimationGroup;
  33425. /**
  33426. * Synchronize and normalize all animatables with a source animatable
  33427. * @param root defines the root animatable to synchronize with
  33428. * @return the animationGroup
  33429. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33430. */
  33431. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  33432. /**
  33433. * Goes to a specific frame in this animation group
  33434. * @param frame the frame number to go to
  33435. * @return the animationGroup
  33436. */
  33437. goToFrame(frame: number): AnimationGroup;
  33438. /**
  33439. * Dispose all associated resources
  33440. */
  33441. dispose(): void;
  33442. private _checkAnimationGroupEnded;
  33443. /**
  33444. * Clone the current animation group and returns a copy
  33445. * @param newName defines the name of the new group
  33446. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  33447. * @returns the new aniamtion group
  33448. */
  33449. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  33450. /**
  33451. * Serializes the animationGroup to an object
  33452. * @returns Serialized object
  33453. */
  33454. serialize(): any;
  33455. /**
  33456. * Returns a new AnimationGroup object parsed from the source provided.
  33457. * @param parsedAnimationGroup defines the source
  33458. * @param scene defines the scene that will receive the animationGroup
  33459. * @returns a new AnimationGroup
  33460. */
  33461. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  33462. /**
  33463. * Returns the string "AnimationGroup"
  33464. * @returns "AnimationGroup"
  33465. */
  33466. getClassName(): string;
  33467. /**
  33468. * Creates a detailled string about the object
  33469. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  33470. * @returns a string representing the object
  33471. */
  33472. toString(fullDetails?: boolean): string;
  33473. }
  33474. }
  33475. declare module "babylonjs/scene" {
  33476. import { Nullable } from "babylonjs/types";
  33477. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33478. import { Observable } from "babylonjs/Misc/observable";
  33479. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  33480. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  33481. import { Geometry } from "babylonjs/Meshes/geometry";
  33482. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33483. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33484. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33485. import { Mesh } from "babylonjs/Meshes/mesh";
  33486. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33487. import { Bone } from "babylonjs/Bones/bone";
  33488. import { Skeleton } from "babylonjs/Bones/skeleton";
  33489. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  33490. import { Camera } from "babylonjs/Cameras/camera";
  33491. import { AbstractScene } from "babylonjs/abstractScene";
  33492. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  33493. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  33494. import { Material } from "babylonjs/Materials/material";
  33495. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  33496. import { Effect } from "babylonjs/Materials/effect";
  33497. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  33498. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  33499. import { Light } from "babylonjs/Lights/light";
  33500. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33501. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  33502. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  33503. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  33504. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  33505. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  33506. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  33507. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  33508. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  33509. import { Engine } from "babylonjs/Engines/engine";
  33510. import { Node } from "babylonjs/node";
  33511. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  33512. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33513. import { WebRequest } from "babylonjs/Misc/webRequest";
  33514. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  33515. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  33516. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  33517. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  33518. import { Plane } from "babylonjs/Maths/math.plane";
  33519. import { Ray } from "babylonjs/Culling/ray";
  33520. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33521. import { Animation } from "babylonjs/Animations/animation";
  33522. import { Animatable } from "babylonjs/Animations/animatable";
  33523. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  33524. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  33525. import { Collider } from "babylonjs/Collisions/collider";
  33526. /**
  33527. * Define an interface for all classes that will hold resources
  33528. */
  33529. export interface IDisposable {
  33530. /**
  33531. * Releases all held resources
  33532. */
  33533. dispose(): void;
  33534. }
  33535. /** Interface defining initialization parameters for Scene class */
  33536. export interface SceneOptions {
  33537. /**
  33538. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  33539. * It will improve performance when the number of geometries becomes important.
  33540. */
  33541. useGeometryUniqueIdsMap?: boolean;
  33542. /**
  33543. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  33544. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  33545. */
  33546. useMaterialMeshMap?: boolean;
  33547. /**
  33548. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  33549. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  33550. */
  33551. useClonedMeshhMap?: boolean;
  33552. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  33553. virtual?: boolean;
  33554. }
  33555. /**
  33556. * Represents a scene to be rendered by the engine.
  33557. * @see http://doc.babylonjs.com/features/scene
  33558. */
  33559. export class Scene extends AbstractScene implements IAnimatable {
  33560. /** The fog is deactivated */
  33561. static readonly FOGMODE_NONE: number;
  33562. /** The fog density is following an exponential function */
  33563. static readonly FOGMODE_EXP: number;
  33564. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  33565. static readonly FOGMODE_EXP2: number;
  33566. /** The fog density is following a linear function. */
  33567. static readonly FOGMODE_LINEAR: number;
  33568. /**
  33569. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  33570. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  33571. */
  33572. static MinDeltaTime: number;
  33573. /**
  33574. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  33575. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  33576. */
  33577. static MaxDeltaTime: number;
  33578. /**
  33579. * Factory used to create the default material.
  33580. * @param name The name of the material to create
  33581. * @param scene The scene to create the material for
  33582. * @returns The default material
  33583. */
  33584. static DefaultMaterialFactory(scene: Scene): Material;
  33585. /**
  33586. * Factory used to create the a collision coordinator.
  33587. * @returns The collision coordinator
  33588. */
  33589. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  33590. /** @hidden */
  33591. _inputManager: InputManager;
  33592. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  33593. cameraToUseForPointers: Nullable<Camera>;
  33594. /** @hidden */
  33595. readonly _isScene: boolean;
  33596. /**
  33597. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  33598. */
  33599. autoClear: boolean;
  33600. /**
  33601. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  33602. */
  33603. autoClearDepthAndStencil: boolean;
  33604. /**
  33605. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  33606. */
  33607. clearColor: Color4;
  33608. /**
  33609. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  33610. */
  33611. ambientColor: Color3;
  33612. /**
  33613. * This is use to store the default BRDF lookup for PBR materials in your scene.
  33614. * It should only be one of the following (if not the default embedded one):
  33615. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  33616. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  33617. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  33618. * The material properties need to be setup according to the type of texture in use.
  33619. */
  33620. environmentBRDFTexture: BaseTexture;
  33621. /** @hidden */
  33622. protected _environmentTexture: Nullable<BaseTexture>;
  33623. /**
  33624. * Texture used in all pbr material as the reflection texture.
  33625. * As in the majority of the scene they are the same (exception for multi room and so on),
  33626. * this is easier to reference from here than from all the materials.
  33627. */
  33628. /**
  33629. * Texture used in all pbr material as the reflection texture.
  33630. * As in the majority of the scene they are the same (exception for multi room and so on),
  33631. * this is easier to set here than in all the materials.
  33632. */
  33633. environmentTexture: Nullable<BaseTexture>;
  33634. /** @hidden */
  33635. protected _environmentIntensity: number;
  33636. /**
  33637. * Intensity of the environment in all pbr material.
  33638. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  33639. * As in the majority of the scene they are the same (exception for multi room and so on),
  33640. * this is easier to reference from here than from all the materials.
  33641. */
  33642. /**
  33643. * Intensity of the environment in all pbr material.
  33644. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  33645. * As in the majority of the scene they are the same (exception for multi room and so on),
  33646. * this is easier to set here than in all the materials.
  33647. */
  33648. environmentIntensity: number;
  33649. /** @hidden */
  33650. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  33651. /**
  33652. * Default image processing configuration used either in the rendering
  33653. * Forward main pass or through the imageProcessingPostProcess if present.
  33654. * As in the majority of the scene they are the same (exception for multi camera),
  33655. * this is easier to reference from here than from all the materials and post process.
  33656. *
  33657. * No setter as we it is a shared configuration, you can set the values instead.
  33658. */
  33659. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  33660. private _forceWireframe;
  33661. /**
  33662. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  33663. */
  33664. forceWireframe: boolean;
  33665. private _forcePointsCloud;
  33666. /**
  33667. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  33668. */
  33669. forcePointsCloud: boolean;
  33670. /**
  33671. * Gets or sets the active clipplane 1
  33672. */
  33673. clipPlane: Nullable<Plane>;
  33674. /**
  33675. * Gets or sets the active clipplane 2
  33676. */
  33677. clipPlane2: Nullable<Plane>;
  33678. /**
  33679. * Gets or sets the active clipplane 3
  33680. */
  33681. clipPlane3: Nullable<Plane>;
  33682. /**
  33683. * Gets or sets the active clipplane 4
  33684. */
  33685. clipPlane4: Nullable<Plane>;
  33686. /**
  33687. * Gets or sets a boolean indicating if animations are enabled
  33688. */
  33689. animationsEnabled: boolean;
  33690. private _animationPropertiesOverride;
  33691. /**
  33692. * Gets or sets the animation properties override
  33693. */
  33694. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  33695. /**
  33696. * Gets or sets a boolean indicating if a constant deltatime has to be used
  33697. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  33698. */
  33699. useConstantAnimationDeltaTime: boolean;
  33700. /**
  33701. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  33702. * Please note that it requires to run a ray cast through the scene on every frame
  33703. */
  33704. constantlyUpdateMeshUnderPointer: boolean;
  33705. /**
  33706. * Defines the HTML cursor to use when hovering over interactive elements
  33707. */
  33708. hoverCursor: string;
  33709. /**
  33710. * Defines the HTML default cursor to use (empty by default)
  33711. */
  33712. defaultCursor: string;
  33713. /**
  33714. * This is used to call preventDefault() on pointer down
  33715. * in order to block unwanted artifacts like system double clicks
  33716. */
  33717. preventDefaultOnPointerDown: boolean;
  33718. /**
  33719. * This is used to call preventDefault() on pointer up
  33720. * in order to block unwanted artifacts like system double clicks
  33721. */
  33722. preventDefaultOnPointerUp: boolean;
  33723. /**
  33724. * Gets or sets user defined metadata
  33725. */
  33726. metadata: any;
  33727. /**
  33728. * For internal use only. Please do not use.
  33729. */
  33730. reservedDataStore: any;
  33731. /**
  33732. * Gets the name of the plugin used to load this scene (null by default)
  33733. */
  33734. loadingPluginName: string;
  33735. /**
  33736. * Use this array to add regular expressions used to disable offline support for specific urls
  33737. */
  33738. disableOfflineSupportExceptionRules: RegExp[];
  33739. /**
  33740. * An event triggered when the scene is disposed.
  33741. */
  33742. onDisposeObservable: Observable<Scene>;
  33743. private _onDisposeObserver;
  33744. /** Sets a function to be executed when this scene is disposed. */
  33745. onDispose: () => void;
  33746. /**
  33747. * An event triggered before rendering the scene (right after animations and physics)
  33748. */
  33749. onBeforeRenderObservable: Observable<Scene>;
  33750. private _onBeforeRenderObserver;
  33751. /** Sets a function to be executed before rendering this scene */
  33752. beforeRender: Nullable<() => void>;
  33753. /**
  33754. * An event triggered after rendering the scene
  33755. */
  33756. onAfterRenderObservable: Observable<Scene>;
  33757. /**
  33758. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  33759. */
  33760. onAfterRenderCameraObservable: Observable<Camera>;
  33761. private _onAfterRenderObserver;
  33762. /** Sets a function to be executed after rendering this scene */
  33763. afterRender: Nullable<() => void>;
  33764. /**
  33765. * An event triggered before animating the scene
  33766. */
  33767. onBeforeAnimationsObservable: Observable<Scene>;
  33768. /**
  33769. * An event triggered after animations processing
  33770. */
  33771. onAfterAnimationsObservable: Observable<Scene>;
  33772. /**
  33773. * An event triggered before draw calls are ready to be sent
  33774. */
  33775. onBeforeDrawPhaseObservable: Observable<Scene>;
  33776. /**
  33777. * An event triggered after draw calls have been sent
  33778. */
  33779. onAfterDrawPhaseObservable: Observable<Scene>;
  33780. /**
  33781. * An event triggered when the scene is ready
  33782. */
  33783. onReadyObservable: Observable<Scene>;
  33784. /**
  33785. * An event triggered before rendering a camera
  33786. */
  33787. onBeforeCameraRenderObservable: Observable<Camera>;
  33788. private _onBeforeCameraRenderObserver;
  33789. /** Sets a function to be executed before rendering a camera*/
  33790. beforeCameraRender: () => void;
  33791. /**
  33792. * An event triggered after rendering a camera
  33793. */
  33794. onAfterCameraRenderObservable: Observable<Camera>;
  33795. private _onAfterCameraRenderObserver;
  33796. /** Sets a function to be executed after rendering a camera*/
  33797. afterCameraRender: () => void;
  33798. /**
  33799. * An event triggered when active meshes evaluation is about to start
  33800. */
  33801. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  33802. /**
  33803. * An event triggered when active meshes evaluation is done
  33804. */
  33805. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  33806. /**
  33807. * An event triggered when particles rendering is about to start
  33808. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  33809. */
  33810. onBeforeParticlesRenderingObservable: Observable<Scene>;
  33811. /**
  33812. * An event triggered when particles rendering is done
  33813. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  33814. */
  33815. onAfterParticlesRenderingObservable: Observable<Scene>;
  33816. /**
  33817. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  33818. */
  33819. onDataLoadedObservable: Observable<Scene>;
  33820. /**
  33821. * An event triggered when a camera is created
  33822. */
  33823. onNewCameraAddedObservable: Observable<Camera>;
  33824. /**
  33825. * An event triggered when a camera is removed
  33826. */
  33827. onCameraRemovedObservable: Observable<Camera>;
  33828. /**
  33829. * An event triggered when a light is created
  33830. */
  33831. onNewLightAddedObservable: Observable<Light>;
  33832. /**
  33833. * An event triggered when a light is removed
  33834. */
  33835. onLightRemovedObservable: Observable<Light>;
  33836. /**
  33837. * An event triggered when a geometry is created
  33838. */
  33839. onNewGeometryAddedObservable: Observable<Geometry>;
  33840. /**
  33841. * An event triggered when a geometry is removed
  33842. */
  33843. onGeometryRemovedObservable: Observable<Geometry>;
  33844. /**
  33845. * An event triggered when a transform node is created
  33846. */
  33847. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  33848. /**
  33849. * An event triggered when a transform node is removed
  33850. */
  33851. onTransformNodeRemovedObservable: Observable<TransformNode>;
  33852. /**
  33853. * An event triggered when a mesh is created
  33854. */
  33855. onNewMeshAddedObservable: Observable<AbstractMesh>;
  33856. /**
  33857. * An event triggered when a mesh is removed
  33858. */
  33859. onMeshRemovedObservable: Observable<AbstractMesh>;
  33860. /**
  33861. * An event triggered when a skeleton is created
  33862. */
  33863. onNewSkeletonAddedObservable: Observable<Skeleton>;
  33864. /**
  33865. * An event triggered when a skeleton is removed
  33866. */
  33867. onSkeletonRemovedObservable: Observable<Skeleton>;
  33868. /**
  33869. * An event triggered when a material is created
  33870. */
  33871. onNewMaterialAddedObservable: Observable<Material>;
  33872. /**
  33873. * An event triggered when a material is removed
  33874. */
  33875. onMaterialRemovedObservable: Observable<Material>;
  33876. /**
  33877. * An event triggered when a texture is created
  33878. */
  33879. onNewTextureAddedObservable: Observable<BaseTexture>;
  33880. /**
  33881. * An event triggered when a texture is removed
  33882. */
  33883. onTextureRemovedObservable: Observable<BaseTexture>;
  33884. /**
  33885. * An event triggered when render targets are about to be rendered
  33886. * Can happen multiple times per frame.
  33887. */
  33888. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  33889. /**
  33890. * An event triggered when render targets were rendered.
  33891. * Can happen multiple times per frame.
  33892. */
  33893. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  33894. /**
  33895. * An event triggered before calculating deterministic simulation step
  33896. */
  33897. onBeforeStepObservable: Observable<Scene>;
  33898. /**
  33899. * An event triggered after calculating deterministic simulation step
  33900. */
  33901. onAfterStepObservable: Observable<Scene>;
  33902. /**
  33903. * An event triggered when the activeCamera property is updated
  33904. */
  33905. onActiveCameraChanged: Observable<Scene>;
  33906. /**
  33907. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  33908. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  33909. * 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)
  33910. */
  33911. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  33912. /**
  33913. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  33914. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  33915. * 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)
  33916. */
  33917. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  33918. /**
  33919. * This Observable will when a mesh has been imported into the scene.
  33920. */
  33921. onMeshImportedObservable: Observable<AbstractMesh>;
  33922. /**
  33923. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  33924. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  33925. */
  33926. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  33927. /** @hidden */
  33928. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  33929. /**
  33930. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  33931. */
  33932. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  33933. /**
  33934. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  33935. */
  33936. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  33937. /**
  33938. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  33939. */
  33940. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  33941. /** Callback called when a pointer move is detected */
  33942. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  33943. /** Callback called when a pointer down is detected */
  33944. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  33945. /** Callback called when a pointer up is detected */
  33946. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  33947. /** Callback called when a pointer pick is detected */
  33948. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  33949. /**
  33950. * 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).
  33951. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  33952. */
  33953. onPrePointerObservable: Observable<PointerInfoPre>;
  33954. /**
  33955. * Observable event triggered each time an input event is received from the rendering canvas
  33956. */
  33957. onPointerObservable: Observable<PointerInfo>;
  33958. /**
  33959. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  33960. */
  33961. readonly unTranslatedPointer: Vector2;
  33962. /**
  33963. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  33964. */
  33965. static DragMovementThreshold: number;
  33966. /**
  33967. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  33968. */
  33969. static LongPressDelay: number;
  33970. /**
  33971. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  33972. */
  33973. static DoubleClickDelay: number;
  33974. /** If you need to check double click without raising a single click at first click, enable this flag */
  33975. static ExclusiveDoubleClickMode: boolean;
  33976. /** @hidden */
  33977. _mirroredCameraPosition: Nullable<Vector3>;
  33978. /**
  33979. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  33980. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  33981. */
  33982. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  33983. /**
  33984. * Observable event triggered each time an keyboard event is received from the hosting window
  33985. */
  33986. onKeyboardObservable: Observable<KeyboardInfo>;
  33987. private _useRightHandedSystem;
  33988. /**
  33989. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  33990. */
  33991. useRightHandedSystem: boolean;
  33992. private _timeAccumulator;
  33993. private _currentStepId;
  33994. private _currentInternalStep;
  33995. /**
  33996. * Sets the step Id used by deterministic lock step
  33997. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  33998. * @param newStepId defines the step Id
  33999. */
  34000. setStepId(newStepId: number): void;
  34001. /**
  34002. * Gets the step Id used by deterministic lock step
  34003. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34004. * @returns the step Id
  34005. */
  34006. getStepId(): number;
  34007. /**
  34008. * Gets the internal step used by deterministic lock step
  34009. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34010. * @returns the internal step
  34011. */
  34012. getInternalStep(): number;
  34013. private _fogEnabled;
  34014. /**
  34015. * Gets or sets a boolean indicating if fog is enabled on this scene
  34016. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34017. * (Default is true)
  34018. */
  34019. fogEnabled: boolean;
  34020. private _fogMode;
  34021. /**
  34022. * Gets or sets the fog mode to use
  34023. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34024. * | mode | value |
  34025. * | --- | --- |
  34026. * | FOGMODE_NONE | 0 |
  34027. * | FOGMODE_EXP | 1 |
  34028. * | FOGMODE_EXP2 | 2 |
  34029. * | FOGMODE_LINEAR | 3 |
  34030. */
  34031. fogMode: number;
  34032. /**
  34033. * Gets or sets the fog color to use
  34034. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34035. * (Default is Color3(0.2, 0.2, 0.3))
  34036. */
  34037. fogColor: Color3;
  34038. /**
  34039. * Gets or sets the fog density to use
  34040. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34041. * (Default is 0.1)
  34042. */
  34043. fogDensity: number;
  34044. /**
  34045. * Gets or sets the fog start distance to use
  34046. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34047. * (Default is 0)
  34048. */
  34049. fogStart: number;
  34050. /**
  34051. * Gets or sets the fog end distance to use
  34052. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34053. * (Default is 1000)
  34054. */
  34055. fogEnd: number;
  34056. private _shadowsEnabled;
  34057. /**
  34058. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34059. */
  34060. shadowsEnabled: boolean;
  34061. private _lightsEnabled;
  34062. /**
  34063. * Gets or sets a boolean indicating if lights are enabled on this scene
  34064. */
  34065. lightsEnabled: boolean;
  34066. /** All of the active cameras added to this scene. */
  34067. activeCameras: Camera[];
  34068. /** @hidden */
  34069. _activeCamera: Nullable<Camera>;
  34070. /** Gets or sets the current active camera */
  34071. activeCamera: Nullable<Camera>;
  34072. private _defaultMaterial;
  34073. /** The default material used on meshes when no material is affected */
  34074. /** The default material used on meshes when no material is affected */
  34075. defaultMaterial: Material;
  34076. private _texturesEnabled;
  34077. /**
  34078. * Gets or sets a boolean indicating if textures are enabled on this scene
  34079. */
  34080. texturesEnabled: boolean;
  34081. /**
  34082. * Gets or sets a boolean indicating if particles are enabled on this scene
  34083. */
  34084. particlesEnabled: boolean;
  34085. /**
  34086. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34087. */
  34088. spritesEnabled: boolean;
  34089. private _skeletonsEnabled;
  34090. /**
  34091. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34092. */
  34093. skeletonsEnabled: boolean;
  34094. /**
  34095. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34096. */
  34097. lensFlaresEnabled: boolean;
  34098. /**
  34099. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34100. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34101. */
  34102. collisionsEnabled: boolean;
  34103. private _collisionCoordinator;
  34104. /** @hidden */
  34105. readonly collisionCoordinator: ICollisionCoordinator;
  34106. /**
  34107. * Defines the gravity applied to this scene (used only for collisions)
  34108. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34109. */
  34110. gravity: Vector3;
  34111. /**
  34112. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34113. */
  34114. postProcessesEnabled: boolean;
  34115. /**
  34116. * The list of postprocesses added to the scene
  34117. */
  34118. postProcesses: PostProcess[];
  34119. /**
  34120. * Gets the current postprocess manager
  34121. */
  34122. postProcessManager: PostProcessManager;
  34123. /**
  34124. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34125. */
  34126. renderTargetsEnabled: boolean;
  34127. /**
  34128. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34129. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34130. */
  34131. dumpNextRenderTargets: boolean;
  34132. /**
  34133. * The list of user defined render targets added to the scene
  34134. */
  34135. customRenderTargets: RenderTargetTexture[];
  34136. /**
  34137. * Defines if texture loading must be delayed
  34138. * If true, textures will only be loaded when they need to be rendered
  34139. */
  34140. useDelayedTextureLoading: boolean;
  34141. /**
  34142. * Gets the list of meshes imported to the scene through SceneLoader
  34143. */
  34144. importedMeshesFiles: String[];
  34145. /**
  34146. * Gets or sets a boolean indicating if probes are enabled on this scene
  34147. */
  34148. probesEnabled: boolean;
  34149. /**
  34150. * Gets or sets the current offline provider to use to store scene data
  34151. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  34152. */
  34153. offlineProvider: IOfflineProvider;
  34154. /**
  34155. * Gets or sets the action manager associated with the scene
  34156. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  34157. */
  34158. actionManager: AbstractActionManager;
  34159. private _meshesForIntersections;
  34160. /**
  34161. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  34162. */
  34163. proceduralTexturesEnabled: boolean;
  34164. private _engine;
  34165. private _totalVertices;
  34166. /** @hidden */
  34167. _activeIndices: PerfCounter;
  34168. /** @hidden */
  34169. _activeParticles: PerfCounter;
  34170. /** @hidden */
  34171. _activeBones: PerfCounter;
  34172. private _animationRatio;
  34173. /** @hidden */
  34174. _animationTimeLast: number;
  34175. /** @hidden */
  34176. _animationTime: number;
  34177. /**
  34178. * Gets or sets a general scale for animation speed
  34179. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  34180. */
  34181. animationTimeScale: number;
  34182. /** @hidden */
  34183. _cachedMaterial: Nullable<Material>;
  34184. /** @hidden */
  34185. _cachedEffect: Nullable<Effect>;
  34186. /** @hidden */
  34187. _cachedVisibility: Nullable<number>;
  34188. private _renderId;
  34189. private _frameId;
  34190. private _executeWhenReadyTimeoutId;
  34191. private _intermediateRendering;
  34192. private _viewUpdateFlag;
  34193. private _projectionUpdateFlag;
  34194. /** @hidden */
  34195. _toBeDisposed: Nullable<IDisposable>[];
  34196. private _activeRequests;
  34197. /** @hidden */
  34198. _pendingData: any[];
  34199. private _isDisposed;
  34200. /**
  34201. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  34202. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  34203. */
  34204. dispatchAllSubMeshesOfActiveMeshes: boolean;
  34205. private _activeMeshes;
  34206. private _processedMaterials;
  34207. private _renderTargets;
  34208. /** @hidden */
  34209. _activeParticleSystems: SmartArray<IParticleSystem>;
  34210. private _activeSkeletons;
  34211. private _softwareSkinnedMeshes;
  34212. private _renderingManager;
  34213. /** @hidden */
  34214. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  34215. private _transformMatrix;
  34216. private _sceneUbo;
  34217. /** @hidden */
  34218. _viewMatrix: Matrix;
  34219. private _projectionMatrix;
  34220. /** @hidden */
  34221. _forcedViewPosition: Nullable<Vector3>;
  34222. /** @hidden */
  34223. _frustumPlanes: Plane[];
  34224. /**
  34225. * Gets the list of frustum planes (built from the active camera)
  34226. */
  34227. readonly frustumPlanes: Plane[];
  34228. /**
  34229. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  34230. * This is useful if there are more lights that the maximum simulteanous authorized
  34231. */
  34232. requireLightSorting: boolean;
  34233. /** @hidden */
  34234. readonly useMaterialMeshMap: boolean;
  34235. /** @hidden */
  34236. readonly useClonedMeshhMap: boolean;
  34237. private _externalData;
  34238. private _uid;
  34239. /**
  34240. * @hidden
  34241. * Backing store of defined scene components.
  34242. */
  34243. _components: ISceneComponent[];
  34244. /**
  34245. * @hidden
  34246. * Backing store of defined scene components.
  34247. */
  34248. _serializableComponents: ISceneSerializableComponent[];
  34249. /**
  34250. * List of components to register on the next registration step.
  34251. */
  34252. private _transientComponents;
  34253. /**
  34254. * Registers the transient components if needed.
  34255. */
  34256. private _registerTransientComponents;
  34257. /**
  34258. * @hidden
  34259. * Add a component to the scene.
  34260. * Note that the ccomponent could be registered on th next frame if this is called after
  34261. * the register component stage.
  34262. * @param component Defines the component to add to the scene
  34263. */
  34264. _addComponent(component: ISceneComponent): void;
  34265. /**
  34266. * @hidden
  34267. * Gets a component from the scene.
  34268. * @param name defines the name of the component to retrieve
  34269. * @returns the component or null if not present
  34270. */
  34271. _getComponent(name: string): Nullable<ISceneComponent>;
  34272. /**
  34273. * @hidden
  34274. * Defines the actions happening before camera updates.
  34275. */
  34276. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  34277. /**
  34278. * @hidden
  34279. * Defines the actions happening before clear the canvas.
  34280. */
  34281. _beforeClearStage: Stage<SimpleStageAction>;
  34282. /**
  34283. * @hidden
  34284. * Defines the actions when collecting render targets for the frame.
  34285. */
  34286. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34287. /**
  34288. * @hidden
  34289. * Defines the actions happening for one camera in the frame.
  34290. */
  34291. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34292. /**
  34293. * @hidden
  34294. * Defines the actions happening during the per mesh ready checks.
  34295. */
  34296. _isReadyForMeshStage: Stage<MeshStageAction>;
  34297. /**
  34298. * @hidden
  34299. * Defines the actions happening before evaluate active mesh checks.
  34300. */
  34301. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  34302. /**
  34303. * @hidden
  34304. * Defines the actions happening during the evaluate sub mesh checks.
  34305. */
  34306. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  34307. /**
  34308. * @hidden
  34309. * Defines the actions happening during the active mesh stage.
  34310. */
  34311. _activeMeshStage: Stage<ActiveMeshStageAction>;
  34312. /**
  34313. * @hidden
  34314. * Defines the actions happening during the per camera render target step.
  34315. */
  34316. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  34317. /**
  34318. * @hidden
  34319. * Defines the actions happening just before the active camera is drawing.
  34320. */
  34321. _beforeCameraDrawStage: Stage<CameraStageAction>;
  34322. /**
  34323. * @hidden
  34324. * Defines the actions happening just before a render target is drawing.
  34325. */
  34326. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34327. /**
  34328. * @hidden
  34329. * Defines the actions happening just before a rendering group is drawing.
  34330. */
  34331. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34332. /**
  34333. * @hidden
  34334. * Defines the actions happening just before a mesh is drawing.
  34335. */
  34336. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34337. /**
  34338. * @hidden
  34339. * Defines the actions happening just after a mesh has been drawn.
  34340. */
  34341. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34342. /**
  34343. * @hidden
  34344. * Defines the actions happening just after a rendering group has been drawn.
  34345. */
  34346. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34347. /**
  34348. * @hidden
  34349. * Defines the actions happening just after the active camera has been drawn.
  34350. */
  34351. _afterCameraDrawStage: Stage<CameraStageAction>;
  34352. /**
  34353. * @hidden
  34354. * Defines the actions happening just after a render target has been drawn.
  34355. */
  34356. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34357. /**
  34358. * @hidden
  34359. * Defines the actions happening just after rendering all cameras and computing intersections.
  34360. */
  34361. _afterRenderStage: Stage<SimpleStageAction>;
  34362. /**
  34363. * @hidden
  34364. * Defines the actions happening when a pointer move event happens.
  34365. */
  34366. _pointerMoveStage: Stage<PointerMoveStageAction>;
  34367. /**
  34368. * @hidden
  34369. * Defines the actions happening when a pointer down event happens.
  34370. */
  34371. _pointerDownStage: Stage<PointerUpDownStageAction>;
  34372. /**
  34373. * @hidden
  34374. * Defines the actions happening when a pointer up event happens.
  34375. */
  34376. _pointerUpStage: Stage<PointerUpDownStageAction>;
  34377. /**
  34378. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  34379. */
  34380. private geometriesByUniqueId;
  34381. /**
  34382. * Creates a new Scene
  34383. * @param engine defines the engine to use to render this scene
  34384. * @param options defines the scene options
  34385. */
  34386. constructor(engine: Engine, options?: SceneOptions);
  34387. /**
  34388. * Gets a string idenfifying the name of the class
  34389. * @returns "Scene" string
  34390. */
  34391. getClassName(): string;
  34392. private _defaultMeshCandidates;
  34393. /**
  34394. * @hidden
  34395. */
  34396. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  34397. private _defaultSubMeshCandidates;
  34398. /**
  34399. * @hidden
  34400. */
  34401. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  34402. /**
  34403. * Sets the default candidate providers for the scene.
  34404. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  34405. * and getCollidingSubMeshCandidates to their default function
  34406. */
  34407. setDefaultCandidateProviders(): void;
  34408. /**
  34409. * Gets the mesh that is currently under the pointer
  34410. */
  34411. readonly meshUnderPointer: Nullable<AbstractMesh>;
  34412. /**
  34413. * Gets or sets the current on-screen X position of the pointer
  34414. */
  34415. pointerX: number;
  34416. /**
  34417. * Gets or sets the current on-screen Y position of the pointer
  34418. */
  34419. pointerY: number;
  34420. /**
  34421. * Gets the cached material (ie. the latest rendered one)
  34422. * @returns the cached material
  34423. */
  34424. getCachedMaterial(): Nullable<Material>;
  34425. /**
  34426. * Gets the cached effect (ie. the latest rendered one)
  34427. * @returns the cached effect
  34428. */
  34429. getCachedEffect(): Nullable<Effect>;
  34430. /**
  34431. * Gets the cached visibility state (ie. the latest rendered one)
  34432. * @returns the cached visibility state
  34433. */
  34434. getCachedVisibility(): Nullable<number>;
  34435. /**
  34436. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  34437. * @param material defines the current material
  34438. * @param effect defines the current effect
  34439. * @param visibility defines the current visibility state
  34440. * @returns true if one parameter is not cached
  34441. */
  34442. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  34443. /**
  34444. * Gets the engine associated with the scene
  34445. * @returns an Engine
  34446. */
  34447. getEngine(): Engine;
  34448. /**
  34449. * Gets the total number of vertices rendered per frame
  34450. * @returns the total number of vertices rendered per frame
  34451. */
  34452. getTotalVertices(): number;
  34453. /**
  34454. * Gets the performance counter for total vertices
  34455. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34456. */
  34457. readonly totalVerticesPerfCounter: PerfCounter;
  34458. /**
  34459. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  34460. * @returns the total number of active indices rendered per frame
  34461. */
  34462. getActiveIndices(): number;
  34463. /**
  34464. * Gets the performance counter for active indices
  34465. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34466. */
  34467. readonly totalActiveIndicesPerfCounter: PerfCounter;
  34468. /**
  34469. * Gets the total number of active particles rendered per frame
  34470. * @returns the total number of active particles rendered per frame
  34471. */
  34472. getActiveParticles(): number;
  34473. /**
  34474. * Gets the performance counter for active particles
  34475. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34476. */
  34477. readonly activeParticlesPerfCounter: PerfCounter;
  34478. /**
  34479. * Gets the total number of active bones rendered per frame
  34480. * @returns the total number of active bones rendered per frame
  34481. */
  34482. getActiveBones(): number;
  34483. /**
  34484. * Gets the performance counter for active bones
  34485. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34486. */
  34487. readonly activeBonesPerfCounter: PerfCounter;
  34488. /**
  34489. * Gets the array of active meshes
  34490. * @returns an array of AbstractMesh
  34491. */
  34492. getActiveMeshes(): SmartArray<AbstractMesh>;
  34493. /**
  34494. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  34495. * @returns a number
  34496. */
  34497. getAnimationRatio(): number;
  34498. /**
  34499. * Gets an unique Id for the current render phase
  34500. * @returns a number
  34501. */
  34502. getRenderId(): number;
  34503. /**
  34504. * Gets an unique Id for the current frame
  34505. * @returns a number
  34506. */
  34507. getFrameId(): number;
  34508. /** Call this function if you want to manually increment the render Id*/
  34509. incrementRenderId(): void;
  34510. private _createUbo;
  34511. /**
  34512. * Use this method to simulate a pointer move on a mesh
  34513. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34514. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34515. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34516. * @returns the current scene
  34517. */
  34518. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  34519. /**
  34520. * Use this method to simulate a pointer down on a mesh
  34521. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34522. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34523. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34524. * @returns the current scene
  34525. */
  34526. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  34527. /**
  34528. * Use this method to simulate a pointer up on a mesh
  34529. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34530. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34531. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34532. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  34533. * @returns the current scene
  34534. */
  34535. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  34536. /**
  34537. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  34538. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  34539. * @returns true if the pointer was captured
  34540. */
  34541. isPointerCaptured(pointerId?: number): boolean;
  34542. /**
  34543. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  34544. * @param attachUp defines if you want to attach events to pointerup
  34545. * @param attachDown defines if you want to attach events to pointerdown
  34546. * @param attachMove defines if you want to attach events to pointermove
  34547. */
  34548. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  34549. /** Detaches all event handlers*/
  34550. detachControl(): void;
  34551. /**
  34552. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  34553. * Delay loaded resources are not taking in account
  34554. * @return true if all required resources are ready
  34555. */
  34556. isReady(): boolean;
  34557. /** Resets all cached information relative to material (including effect and visibility) */
  34558. resetCachedMaterial(): void;
  34559. /**
  34560. * Registers a function to be called before every frame render
  34561. * @param func defines the function to register
  34562. */
  34563. registerBeforeRender(func: () => void): void;
  34564. /**
  34565. * Unregisters a function called before every frame render
  34566. * @param func defines the function to unregister
  34567. */
  34568. unregisterBeforeRender(func: () => void): void;
  34569. /**
  34570. * Registers a function to be called after every frame render
  34571. * @param func defines the function to register
  34572. */
  34573. registerAfterRender(func: () => void): void;
  34574. /**
  34575. * Unregisters a function called after every frame render
  34576. * @param func defines the function to unregister
  34577. */
  34578. unregisterAfterRender(func: () => void): void;
  34579. private _executeOnceBeforeRender;
  34580. /**
  34581. * The provided function will run before render once and will be disposed afterwards.
  34582. * A timeout delay can be provided so that the function will be executed in N ms.
  34583. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  34584. * @param func The function to be executed.
  34585. * @param timeout optional delay in ms
  34586. */
  34587. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  34588. /** @hidden */
  34589. _addPendingData(data: any): void;
  34590. /** @hidden */
  34591. _removePendingData(data: any): void;
  34592. /**
  34593. * Returns the number of items waiting to be loaded
  34594. * @returns the number of items waiting to be loaded
  34595. */
  34596. getWaitingItemsCount(): number;
  34597. /**
  34598. * Returns a boolean indicating if the scene is still loading data
  34599. */
  34600. readonly isLoading: boolean;
  34601. /**
  34602. * Registers a function to be executed when the scene is ready
  34603. * @param {Function} func - the function to be executed
  34604. */
  34605. executeWhenReady(func: () => void): void;
  34606. /**
  34607. * Returns a promise that resolves when the scene is ready
  34608. * @returns A promise that resolves when the scene is ready
  34609. */
  34610. whenReadyAsync(): Promise<void>;
  34611. /** @hidden */
  34612. _checkIsReady(): void;
  34613. /**
  34614. * Gets all animatable attached to the scene
  34615. */
  34616. readonly animatables: Animatable[];
  34617. /**
  34618. * Resets the last animation time frame.
  34619. * Useful to override when animations start running when loading a scene for the first time.
  34620. */
  34621. resetLastAnimationTimeFrame(): void;
  34622. /**
  34623. * Gets the current view matrix
  34624. * @returns a Matrix
  34625. */
  34626. getViewMatrix(): Matrix;
  34627. /**
  34628. * Gets the current projection matrix
  34629. * @returns a Matrix
  34630. */
  34631. getProjectionMatrix(): Matrix;
  34632. /**
  34633. * Gets the current transform matrix
  34634. * @returns a Matrix made of View * Projection
  34635. */
  34636. getTransformMatrix(): Matrix;
  34637. /**
  34638. * Sets the current transform matrix
  34639. * @param viewL defines the View matrix to use
  34640. * @param projectionL defines the Projection matrix to use
  34641. * @param viewR defines the right View matrix to use (if provided)
  34642. * @param projectionR defines the right Projection matrix to use (if provided)
  34643. */
  34644. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  34645. /**
  34646. * Gets the uniform buffer used to store scene data
  34647. * @returns a UniformBuffer
  34648. */
  34649. getSceneUniformBuffer(): UniformBuffer;
  34650. /**
  34651. * Gets an unique (relatively to the current scene) Id
  34652. * @returns an unique number for the scene
  34653. */
  34654. getUniqueId(): number;
  34655. /**
  34656. * Add a mesh to the list of scene's meshes
  34657. * @param newMesh defines the mesh to add
  34658. * @param recursive if all child meshes should also be added to the scene
  34659. */
  34660. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  34661. /**
  34662. * Remove a mesh for the list of scene's meshes
  34663. * @param toRemove defines the mesh to remove
  34664. * @param recursive if all child meshes should also be removed from the scene
  34665. * @returns the index where the mesh was in the mesh list
  34666. */
  34667. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  34668. /**
  34669. * Add a transform node to the list of scene's transform nodes
  34670. * @param newTransformNode defines the transform node to add
  34671. */
  34672. addTransformNode(newTransformNode: TransformNode): void;
  34673. /**
  34674. * Remove a transform node for the list of scene's transform nodes
  34675. * @param toRemove defines the transform node to remove
  34676. * @returns the index where the transform node was in the transform node list
  34677. */
  34678. removeTransformNode(toRemove: TransformNode): number;
  34679. /**
  34680. * Remove a skeleton for the list of scene's skeletons
  34681. * @param toRemove defines the skeleton to remove
  34682. * @returns the index where the skeleton was in the skeleton list
  34683. */
  34684. removeSkeleton(toRemove: Skeleton): number;
  34685. /**
  34686. * Remove a morph target for the list of scene's morph targets
  34687. * @param toRemove defines the morph target to remove
  34688. * @returns the index where the morph target was in the morph target list
  34689. */
  34690. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  34691. /**
  34692. * Remove a light for the list of scene's lights
  34693. * @param toRemove defines the light to remove
  34694. * @returns the index where the light was in the light list
  34695. */
  34696. removeLight(toRemove: Light): number;
  34697. /**
  34698. * Remove a camera for the list of scene's cameras
  34699. * @param toRemove defines the camera to remove
  34700. * @returns the index where the camera was in the camera list
  34701. */
  34702. removeCamera(toRemove: Camera): number;
  34703. /**
  34704. * Remove a particle system for the list of scene's particle systems
  34705. * @param toRemove defines the particle system to remove
  34706. * @returns the index where the particle system was in the particle system list
  34707. */
  34708. removeParticleSystem(toRemove: IParticleSystem): number;
  34709. /**
  34710. * Remove a animation for the list of scene's animations
  34711. * @param toRemove defines the animation to remove
  34712. * @returns the index where the animation was in the animation list
  34713. */
  34714. removeAnimation(toRemove: Animation): number;
  34715. /**
  34716. * Will stop the animation of the given target
  34717. * @param target - the target
  34718. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  34719. * @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)
  34720. */
  34721. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  34722. /**
  34723. * Removes the given animation group from this scene.
  34724. * @param toRemove The animation group to remove
  34725. * @returns The index of the removed animation group
  34726. */
  34727. removeAnimationGroup(toRemove: AnimationGroup): number;
  34728. /**
  34729. * Removes the given multi-material from this scene.
  34730. * @param toRemove The multi-material to remove
  34731. * @returns The index of the removed multi-material
  34732. */
  34733. removeMultiMaterial(toRemove: MultiMaterial): number;
  34734. /**
  34735. * Removes the given material from this scene.
  34736. * @param toRemove The material to remove
  34737. * @returns The index of the removed material
  34738. */
  34739. removeMaterial(toRemove: Material): number;
  34740. /**
  34741. * Removes the given action manager from this scene.
  34742. * @param toRemove The action manager to remove
  34743. * @returns The index of the removed action manager
  34744. */
  34745. removeActionManager(toRemove: AbstractActionManager): number;
  34746. /**
  34747. * Removes the given texture from this scene.
  34748. * @param toRemove The texture to remove
  34749. * @returns The index of the removed texture
  34750. */
  34751. removeTexture(toRemove: BaseTexture): number;
  34752. /**
  34753. * Adds the given light to this scene
  34754. * @param newLight The light to add
  34755. */
  34756. addLight(newLight: Light): void;
  34757. /**
  34758. * Sorts the list list based on light priorities
  34759. */
  34760. sortLightsByPriority(): void;
  34761. /**
  34762. * Adds the given camera to this scene
  34763. * @param newCamera The camera to add
  34764. */
  34765. addCamera(newCamera: Camera): void;
  34766. /**
  34767. * Adds the given skeleton to this scene
  34768. * @param newSkeleton The skeleton to add
  34769. */
  34770. addSkeleton(newSkeleton: Skeleton): void;
  34771. /**
  34772. * Adds the given particle system to this scene
  34773. * @param newParticleSystem The particle system to add
  34774. */
  34775. addParticleSystem(newParticleSystem: IParticleSystem): void;
  34776. /**
  34777. * Adds the given animation to this scene
  34778. * @param newAnimation The animation to add
  34779. */
  34780. addAnimation(newAnimation: Animation): void;
  34781. /**
  34782. * Adds the given animation group to this scene.
  34783. * @param newAnimationGroup The animation group to add
  34784. */
  34785. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  34786. /**
  34787. * Adds the given multi-material to this scene
  34788. * @param newMultiMaterial The multi-material to add
  34789. */
  34790. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  34791. /**
  34792. * Adds the given material to this scene
  34793. * @param newMaterial The material to add
  34794. */
  34795. addMaterial(newMaterial: Material): void;
  34796. /**
  34797. * Adds the given morph target to this scene
  34798. * @param newMorphTargetManager The morph target to add
  34799. */
  34800. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  34801. /**
  34802. * Adds the given geometry to this scene
  34803. * @param newGeometry The geometry to add
  34804. */
  34805. addGeometry(newGeometry: Geometry): void;
  34806. /**
  34807. * Adds the given action manager to this scene
  34808. * @param newActionManager The action manager to add
  34809. */
  34810. addActionManager(newActionManager: AbstractActionManager): void;
  34811. /**
  34812. * Adds the given texture to this scene.
  34813. * @param newTexture The texture to add
  34814. */
  34815. addTexture(newTexture: BaseTexture): void;
  34816. /**
  34817. * Switch active camera
  34818. * @param newCamera defines the new active camera
  34819. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  34820. */
  34821. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  34822. /**
  34823. * sets the active camera of the scene using its ID
  34824. * @param id defines the camera's ID
  34825. * @return the new active camera or null if none found.
  34826. */
  34827. setActiveCameraByID(id: string): Nullable<Camera>;
  34828. /**
  34829. * sets the active camera of the scene using its name
  34830. * @param name defines the camera's name
  34831. * @returns the new active camera or null if none found.
  34832. */
  34833. setActiveCameraByName(name: string): Nullable<Camera>;
  34834. /**
  34835. * get an animation group using its name
  34836. * @param name defines the material's name
  34837. * @return the animation group or null if none found.
  34838. */
  34839. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  34840. /**
  34841. * Get a material using its unique id
  34842. * @param uniqueId defines the material's unique id
  34843. * @return the material or null if none found.
  34844. */
  34845. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  34846. /**
  34847. * get a material using its id
  34848. * @param id defines the material's ID
  34849. * @return the material or null if none found.
  34850. */
  34851. getMaterialByID(id: string): Nullable<Material>;
  34852. /**
  34853. * Gets a the last added material using a given id
  34854. * @param id defines the material's ID
  34855. * @return the last material with the given id or null if none found.
  34856. */
  34857. getLastMaterialByID(id: string): Nullable<Material>;
  34858. /**
  34859. * Gets a material using its name
  34860. * @param name defines the material's name
  34861. * @return the material or null if none found.
  34862. */
  34863. getMaterialByName(name: string): Nullable<Material>;
  34864. /**
  34865. * Get a texture using its unique id
  34866. * @param uniqueId defines the texture's unique id
  34867. * @return the texture or null if none found.
  34868. */
  34869. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  34870. /**
  34871. * Gets a camera using its id
  34872. * @param id defines the id to look for
  34873. * @returns the camera or null if not found
  34874. */
  34875. getCameraByID(id: string): Nullable<Camera>;
  34876. /**
  34877. * Gets a camera using its unique id
  34878. * @param uniqueId defines the unique id to look for
  34879. * @returns the camera or null if not found
  34880. */
  34881. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  34882. /**
  34883. * Gets a camera using its name
  34884. * @param name defines the camera's name
  34885. * @return the camera or null if none found.
  34886. */
  34887. getCameraByName(name: string): Nullable<Camera>;
  34888. /**
  34889. * Gets a bone using its id
  34890. * @param id defines the bone's id
  34891. * @return the bone or null if not found
  34892. */
  34893. getBoneByID(id: string): Nullable<Bone>;
  34894. /**
  34895. * Gets a bone using its id
  34896. * @param name defines the bone's name
  34897. * @return the bone or null if not found
  34898. */
  34899. getBoneByName(name: string): Nullable<Bone>;
  34900. /**
  34901. * Gets a light node using its name
  34902. * @param name defines the the light's name
  34903. * @return the light or null if none found.
  34904. */
  34905. getLightByName(name: string): Nullable<Light>;
  34906. /**
  34907. * Gets a light node using its id
  34908. * @param id defines the light's id
  34909. * @return the light or null if none found.
  34910. */
  34911. getLightByID(id: string): Nullable<Light>;
  34912. /**
  34913. * Gets a light node using its scene-generated unique ID
  34914. * @param uniqueId defines the light's unique id
  34915. * @return the light or null if none found.
  34916. */
  34917. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  34918. /**
  34919. * Gets a particle system by id
  34920. * @param id defines the particle system id
  34921. * @return the corresponding system or null if none found
  34922. */
  34923. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  34924. /**
  34925. * Gets a geometry using its ID
  34926. * @param id defines the geometry's id
  34927. * @return the geometry or null if none found.
  34928. */
  34929. getGeometryByID(id: string): Nullable<Geometry>;
  34930. private _getGeometryByUniqueID;
  34931. /**
  34932. * Add a new geometry to this scene
  34933. * @param geometry defines the geometry to be added to the scene.
  34934. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  34935. * @return a boolean defining if the geometry was added or not
  34936. */
  34937. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  34938. /**
  34939. * Removes an existing geometry
  34940. * @param geometry defines the geometry to be removed from the scene
  34941. * @return a boolean defining if the geometry was removed or not
  34942. */
  34943. removeGeometry(geometry: Geometry): boolean;
  34944. /**
  34945. * Gets the list of geometries attached to the scene
  34946. * @returns an array of Geometry
  34947. */
  34948. getGeometries(): Geometry[];
  34949. /**
  34950. * Gets the first added mesh found of a given ID
  34951. * @param id defines the id to search for
  34952. * @return the mesh found or null if not found at all
  34953. */
  34954. getMeshByID(id: string): Nullable<AbstractMesh>;
  34955. /**
  34956. * Gets a list of meshes using their id
  34957. * @param id defines the id to search for
  34958. * @returns a list of meshes
  34959. */
  34960. getMeshesByID(id: string): Array<AbstractMesh>;
  34961. /**
  34962. * Gets the first added transform node found of a given ID
  34963. * @param id defines the id to search for
  34964. * @return the found transform node or null if not found at all.
  34965. */
  34966. getTransformNodeByID(id: string): Nullable<TransformNode>;
  34967. /**
  34968. * Gets a transform node with its auto-generated unique id
  34969. * @param uniqueId efines the unique id to search for
  34970. * @return the found transform node or null if not found at all.
  34971. */
  34972. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  34973. /**
  34974. * Gets a list of transform nodes using their id
  34975. * @param id defines the id to search for
  34976. * @returns a list of transform nodes
  34977. */
  34978. getTransformNodesByID(id: string): Array<TransformNode>;
  34979. /**
  34980. * Gets a mesh with its auto-generated unique id
  34981. * @param uniqueId defines the unique id to search for
  34982. * @return the found mesh or null if not found at all.
  34983. */
  34984. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  34985. /**
  34986. * Gets a the last added mesh using a given id
  34987. * @param id defines the id to search for
  34988. * @return the found mesh or null if not found at all.
  34989. */
  34990. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  34991. /**
  34992. * Gets a the last added node (Mesh, Camera, Light) using a given id
  34993. * @param id defines the id to search for
  34994. * @return the found node or null if not found at all
  34995. */
  34996. getLastEntryByID(id: string): Nullable<Node>;
  34997. /**
  34998. * Gets a node (Mesh, Camera, Light) using a given id
  34999. * @param id defines the id to search for
  35000. * @return the found node or null if not found at all
  35001. */
  35002. getNodeByID(id: string): Nullable<Node>;
  35003. /**
  35004. * Gets a node (Mesh, Camera, Light) using a given name
  35005. * @param name defines the name to search for
  35006. * @return the found node or null if not found at all.
  35007. */
  35008. getNodeByName(name: string): Nullable<Node>;
  35009. /**
  35010. * Gets a mesh using a given name
  35011. * @param name defines the name to search for
  35012. * @return the found mesh or null if not found at all.
  35013. */
  35014. getMeshByName(name: string): Nullable<AbstractMesh>;
  35015. /**
  35016. * Gets a transform node using a given name
  35017. * @param name defines the name to search for
  35018. * @return the found transform node or null if not found at all.
  35019. */
  35020. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35021. /**
  35022. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35023. * @param id defines the id to search for
  35024. * @return the found skeleton or null if not found at all.
  35025. */
  35026. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35027. /**
  35028. * Gets a skeleton using a given auto generated unique id
  35029. * @param uniqueId defines the unique id to search for
  35030. * @return the found skeleton or null if not found at all.
  35031. */
  35032. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35033. /**
  35034. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35035. * @param id defines the id to search for
  35036. * @return the found skeleton or null if not found at all.
  35037. */
  35038. getSkeletonById(id: string): Nullable<Skeleton>;
  35039. /**
  35040. * Gets a skeleton using a given name
  35041. * @param name defines the name to search for
  35042. * @return the found skeleton or null if not found at all.
  35043. */
  35044. getSkeletonByName(name: string): Nullable<Skeleton>;
  35045. /**
  35046. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35047. * @param id defines the id to search for
  35048. * @return the found morph target manager or null if not found at all.
  35049. */
  35050. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35051. /**
  35052. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35053. * @param id defines the id to search for
  35054. * @return the found morph target or null if not found at all.
  35055. */
  35056. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35057. /**
  35058. * Gets a boolean indicating if the given mesh is active
  35059. * @param mesh defines the mesh to look for
  35060. * @returns true if the mesh is in the active list
  35061. */
  35062. isActiveMesh(mesh: AbstractMesh): boolean;
  35063. /**
  35064. * Return a unique id as a string which can serve as an identifier for the scene
  35065. */
  35066. readonly uid: string;
  35067. /**
  35068. * Add an externaly attached data from its key.
  35069. * This method call will fail and return false, if such key already exists.
  35070. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35071. * @param key the unique key that identifies the data
  35072. * @param data the data object to associate to the key for this Engine instance
  35073. * @return true if no such key were already present and the data was added successfully, false otherwise
  35074. */
  35075. addExternalData<T>(key: string, data: T): boolean;
  35076. /**
  35077. * Get an externaly attached data from its key
  35078. * @param key the unique key that identifies the data
  35079. * @return the associated data, if present (can be null), or undefined if not present
  35080. */
  35081. getExternalData<T>(key: string): Nullable<T>;
  35082. /**
  35083. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35084. * @param key the unique key that identifies the data
  35085. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35086. * @return the associated data, can be null if the factory returned null.
  35087. */
  35088. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35089. /**
  35090. * Remove an externaly attached data from the Engine instance
  35091. * @param key the unique key that identifies the data
  35092. * @return true if the data was successfully removed, false if it doesn't exist
  35093. */
  35094. removeExternalData(key: string): boolean;
  35095. private _evaluateSubMesh;
  35096. /**
  35097. * Clear the processed materials smart array preventing retention point in material dispose.
  35098. */
  35099. freeProcessedMaterials(): void;
  35100. private _preventFreeActiveMeshesAndRenderingGroups;
  35101. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35102. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35103. * when disposing several meshes in a row or a hierarchy of meshes.
  35104. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35105. */
  35106. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35107. /**
  35108. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35109. */
  35110. freeActiveMeshes(): void;
  35111. /**
  35112. * Clear the info related to rendering groups preventing retention points during dispose.
  35113. */
  35114. freeRenderingGroups(): void;
  35115. /** @hidden */
  35116. _isInIntermediateRendering(): boolean;
  35117. /**
  35118. * Lambda returning the list of potentially active meshes.
  35119. */
  35120. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35121. /**
  35122. * Lambda returning the list of potentially active sub meshes.
  35123. */
  35124. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35125. /**
  35126. * Lambda returning the list of potentially intersecting sub meshes.
  35127. */
  35128. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35129. /**
  35130. * Lambda returning the list of potentially colliding sub meshes.
  35131. */
  35132. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35133. private _activeMeshesFrozen;
  35134. /**
  35135. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35136. * @returns the current scene
  35137. */
  35138. freezeActiveMeshes(): Scene;
  35139. /**
  35140. * Use this function to restart evaluating active meshes on every frame
  35141. * @returns the current scene
  35142. */
  35143. unfreezeActiveMeshes(): Scene;
  35144. private _evaluateActiveMeshes;
  35145. private _activeMesh;
  35146. /**
  35147. * Update the transform matrix to update from the current active camera
  35148. * @param force defines a boolean used to force the update even if cache is up to date
  35149. */
  35150. updateTransformMatrix(force?: boolean): void;
  35151. private _bindFrameBuffer;
  35152. /** @hidden */
  35153. _allowPostProcessClearColor: boolean;
  35154. /** @hidden */
  35155. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  35156. private _processSubCameras;
  35157. private _checkIntersections;
  35158. /** @hidden */
  35159. _advancePhysicsEngineStep(step: number): void;
  35160. /**
  35161. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  35162. */
  35163. getDeterministicFrameTime: () => number;
  35164. /** @hidden */
  35165. _animate(): void;
  35166. /** Execute all animations (for a frame) */
  35167. animate(): void;
  35168. /**
  35169. * Render the scene
  35170. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  35171. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  35172. */
  35173. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  35174. /**
  35175. * Freeze all materials
  35176. * A frozen material will not be updatable but should be faster to render
  35177. */
  35178. freezeMaterials(): void;
  35179. /**
  35180. * Unfreeze all materials
  35181. * A frozen material will not be updatable but should be faster to render
  35182. */
  35183. unfreezeMaterials(): void;
  35184. /**
  35185. * Releases all held ressources
  35186. */
  35187. dispose(): void;
  35188. /**
  35189. * Gets if the scene is already disposed
  35190. */
  35191. readonly isDisposed: boolean;
  35192. /**
  35193. * Call this function to reduce memory footprint of the scene.
  35194. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  35195. */
  35196. clearCachedVertexData(): void;
  35197. /**
  35198. * This function will remove the local cached buffer data from texture.
  35199. * It will save memory but will prevent the texture from being rebuilt
  35200. */
  35201. cleanCachedTextureBuffer(): void;
  35202. /**
  35203. * Get the world extend vectors with an optional filter
  35204. *
  35205. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  35206. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  35207. */
  35208. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  35209. min: Vector3;
  35210. max: Vector3;
  35211. };
  35212. /**
  35213. * Creates a ray that can be used to pick in the scene
  35214. * @param x defines the x coordinate of the origin (on-screen)
  35215. * @param y defines the y coordinate of the origin (on-screen)
  35216. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35217. * @param camera defines the camera to use for the picking
  35218. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35219. * @returns a Ray
  35220. */
  35221. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  35222. /**
  35223. * Creates a ray that can be used to pick in the scene
  35224. * @param x defines the x coordinate of the origin (on-screen)
  35225. * @param y defines the y coordinate of the origin (on-screen)
  35226. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35227. * @param result defines the ray where to store the picking ray
  35228. * @param camera defines the camera to use for the picking
  35229. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35230. * @returns the current scene
  35231. */
  35232. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  35233. /**
  35234. * Creates a ray that can be used to pick in the scene
  35235. * @param x defines the x coordinate of the origin (on-screen)
  35236. * @param y defines the y coordinate of the origin (on-screen)
  35237. * @param camera defines the camera to use for the picking
  35238. * @returns a Ray
  35239. */
  35240. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  35241. /**
  35242. * Creates a ray that can be used to pick in the scene
  35243. * @param x defines the x coordinate of the origin (on-screen)
  35244. * @param y defines the y coordinate of the origin (on-screen)
  35245. * @param result defines the ray where to store the picking ray
  35246. * @param camera defines the camera to use for the picking
  35247. * @returns the current scene
  35248. */
  35249. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  35250. /** Launch a ray to try to pick a mesh in the scene
  35251. * @param x position on screen
  35252. * @param y position on screen
  35253. * @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
  35254. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  35255. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35256. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35257. * @returns a PickingInfo
  35258. */
  35259. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35260. /** Use the given ray to pick a mesh in the scene
  35261. * @param ray The ray to use to pick meshes
  35262. * @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
  35263. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  35264. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35265. * @returns a PickingInfo
  35266. */
  35267. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35268. /**
  35269. * Launch a ray to try to pick a mesh in the scene
  35270. * @param x X position on screen
  35271. * @param y Y position on screen
  35272. * @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
  35273. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35274. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35275. * @returns an array of PickingInfo
  35276. */
  35277. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35278. /**
  35279. * Launch a ray to try to pick a mesh in the scene
  35280. * @param ray Ray to use
  35281. * @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
  35282. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35283. * @returns an array of PickingInfo
  35284. */
  35285. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35286. /**
  35287. * Force the value of meshUnderPointer
  35288. * @param mesh defines the mesh to use
  35289. */
  35290. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  35291. /**
  35292. * Gets the mesh under the pointer
  35293. * @returns a Mesh or null if no mesh is under the pointer
  35294. */
  35295. getPointerOverMesh(): Nullable<AbstractMesh>;
  35296. /** @hidden */
  35297. _rebuildGeometries(): void;
  35298. /** @hidden */
  35299. _rebuildTextures(): void;
  35300. private _getByTags;
  35301. /**
  35302. * Get a list of meshes by tags
  35303. * @param tagsQuery defines the tags query to use
  35304. * @param forEach defines a predicate used to filter results
  35305. * @returns an array of Mesh
  35306. */
  35307. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  35308. /**
  35309. * Get a list of cameras by tags
  35310. * @param tagsQuery defines the tags query to use
  35311. * @param forEach defines a predicate used to filter results
  35312. * @returns an array of Camera
  35313. */
  35314. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  35315. /**
  35316. * Get a list of lights by tags
  35317. * @param tagsQuery defines the tags query to use
  35318. * @param forEach defines a predicate used to filter results
  35319. * @returns an array of Light
  35320. */
  35321. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  35322. /**
  35323. * Get a list of materials by tags
  35324. * @param tagsQuery defines the tags query to use
  35325. * @param forEach defines a predicate used to filter results
  35326. * @returns an array of Material
  35327. */
  35328. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  35329. /**
  35330. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  35331. * This allowed control for front to back rendering or reversly depending of the special needs.
  35332. *
  35333. * @param renderingGroupId The rendering group id corresponding to its index
  35334. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  35335. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  35336. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  35337. */
  35338. 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;
  35339. /**
  35340. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  35341. *
  35342. * @param renderingGroupId The rendering group id corresponding to its index
  35343. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  35344. * @param depth Automatically clears depth between groups if true and autoClear is true.
  35345. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  35346. */
  35347. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  35348. /**
  35349. * Gets the current auto clear configuration for one rendering group of the rendering
  35350. * manager.
  35351. * @param index the rendering group index to get the information for
  35352. * @returns The auto clear setup for the requested rendering group
  35353. */
  35354. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  35355. private _blockMaterialDirtyMechanism;
  35356. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  35357. blockMaterialDirtyMechanism: boolean;
  35358. /**
  35359. * Will flag all materials as dirty to trigger new shader compilation
  35360. * @param flag defines the flag used to specify which material part must be marked as dirty
  35361. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  35362. */
  35363. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  35364. /** @hidden */
  35365. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  35366. /** @hidden */
  35367. _loadFileAsync(url: string, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  35368. }
  35369. }
  35370. declare module "babylonjs/assetContainer" {
  35371. import { AbstractScene } from "babylonjs/abstractScene";
  35372. import { Scene } from "babylonjs/scene";
  35373. import { Mesh } from "babylonjs/Meshes/mesh";
  35374. /**
  35375. * Set of assets to keep when moving a scene into an asset container.
  35376. */
  35377. export class KeepAssets extends AbstractScene {
  35378. }
  35379. /**
  35380. * Container with a set of assets that can be added or removed from a scene.
  35381. */
  35382. export class AssetContainer extends AbstractScene {
  35383. /**
  35384. * The scene the AssetContainer belongs to.
  35385. */
  35386. scene: Scene;
  35387. /**
  35388. * Instantiates an AssetContainer.
  35389. * @param scene The scene the AssetContainer belongs to.
  35390. */
  35391. constructor(scene: Scene);
  35392. /**
  35393. * Adds all the assets from the container to the scene.
  35394. */
  35395. addAllToScene(): void;
  35396. /**
  35397. * Removes all the assets in the container from the scene
  35398. */
  35399. removeAllFromScene(): void;
  35400. /**
  35401. * Disposes all the assets in the container
  35402. */
  35403. dispose(): void;
  35404. private _moveAssets;
  35405. /**
  35406. * Removes all the assets contained in the scene and adds them to the container.
  35407. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  35408. */
  35409. moveAllFromScene(keepAssets?: KeepAssets): void;
  35410. /**
  35411. * 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.
  35412. * @returns the root mesh
  35413. */
  35414. createRootMesh(): Mesh;
  35415. }
  35416. }
  35417. declare module "babylonjs/abstractScene" {
  35418. import { Scene } from "babylonjs/scene";
  35419. import { Nullable } from "babylonjs/types";
  35420. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  35421. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35422. import { Geometry } from "babylonjs/Meshes/geometry";
  35423. import { Skeleton } from "babylonjs/Bones/skeleton";
  35424. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  35425. import { AssetContainer } from "babylonjs/assetContainer";
  35426. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  35427. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  35428. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35429. import { Material } from "babylonjs/Materials/material";
  35430. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  35431. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  35432. import { Camera } from "babylonjs/Cameras/camera";
  35433. import { Light } from "babylonjs/Lights/light";
  35434. import { Node } from "babylonjs/node";
  35435. import { Animation } from "babylonjs/Animations/animation";
  35436. /**
  35437. * Defines how the parser contract is defined.
  35438. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  35439. */
  35440. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  35441. /**
  35442. * Defines how the individual parser contract is defined.
  35443. * These parser can parse an individual asset
  35444. */
  35445. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  35446. /**
  35447. * Base class of the scene acting as a container for the different elements composing a scene.
  35448. * This class is dynamically extended by the different components of the scene increasing
  35449. * flexibility and reducing coupling
  35450. */
  35451. export abstract class AbstractScene {
  35452. /**
  35453. * Stores the list of available parsers in the application.
  35454. */
  35455. private static _BabylonFileParsers;
  35456. /**
  35457. * Stores the list of available individual parsers in the application.
  35458. */
  35459. private static _IndividualBabylonFileParsers;
  35460. /**
  35461. * Adds a parser in the list of available ones
  35462. * @param name Defines the name of the parser
  35463. * @param parser Defines the parser to add
  35464. */
  35465. static AddParser(name: string, parser: BabylonFileParser): void;
  35466. /**
  35467. * Gets a general parser from the list of avaialble ones
  35468. * @param name Defines the name of the parser
  35469. * @returns the requested parser or null
  35470. */
  35471. static GetParser(name: string): Nullable<BabylonFileParser>;
  35472. /**
  35473. * Adds n individual parser in the list of available ones
  35474. * @param name Defines the name of the parser
  35475. * @param parser Defines the parser to add
  35476. */
  35477. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  35478. /**
  35479. * Gets an individual parser from the list of avaialble ones
  35480. * @param name Defines the name of the parser
  35481. * @returns the requested parser or null
  35482. */
  35483. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  35484. /**
  35485. * Parser json data and populate both a scene and its associated container object
  35486. * @param jsonData Defines the data to parse
  35487. * @param scene Defines the scene to parse the data for
  35488. * @param container Defines the container attached to the parsing sequence
  35489. * @param rootUrl Defines the root url of the data
  35490. */
  35491. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  35492. /**
  35493. * Gets the list of root nodes (ie. nodes with no parent)
  35494. */
  35495. rootNodes: Node[];
  35496. /** All of the cameras added to this scene
  35497. * @see http://doc.babylonjs.com/babylon101/cameras
  35498. */
  35499. cameras: Camera[];
  35500. /**
  35501. * All of the lights added to this scene
  35502. * @see http://doc.babylonjs.com/babylon101/lights
  35503. */
  35504. lights: Light[];
  35505. /**
  35506. * All of the (abstract) meshes added to this scene
  35507. */
  35508. meshes: AbstractMesh[];
  35509. /**
  35510. * The list of skeletons added to the scene
  35511. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  35512. */
  35513. skeletons: Skeleton[];
  35514. /**
  35515. * All of the particle systems added to this scene
  35516. * @see http://doc.babylonjs.com/babylon101/particles
  35517. */
  35518. particleSystems: IParticleSystem[];
  35519. /**
  35520. * Gets a list of Animations associated with the scene
  35521. */
  35522. animations: Animation[];
  35523. /**
  35524. * All of the animation groups added to this scene
  35525. * @see http://doc.babylonjs.com/how_to/group
  35526. */
  35527. animationGroups: AnimationGroup[];
  35528. /**
  35529. * All of the multi-materials added to this scene
  35530. * @see http://doc.babylonjs.com/how_to/multi_materials
  35531. */
  35532. multiMaterials: MultiMaterial[];
  35533. /**
  35534. * All of the materials added to this scene
  35535. * In the context of a Scene, it is not supposed to be modified manually.
  35536. * Any addition or removal should be done using the addMaterial and removeMAterial Scene methods.
  35537. * Note also that the order of the Material wihin the array is not significant and might change.
  35538. * @see http://doc.babylonjs.com/babylon101/materials
  35539. */
  35540. materials: Material[];
  35541. /**
  35542. * The list of morph target managers added to the scene
  35543. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  35544. */
  35545. morphTargetManagers: MorphTargetManager[];
  35546. /**
  35547. * The list of geometries used in the scene.
  35548. */
  35549. geometries: Geometry[];
  35550. /**
  35551. * All of the tranform nodes added to this scene
  35552. * In the context of a Scene, it is not supposed to be modified manually.
  35553. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  35554. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  35555. * @see http://doc.babylonjs.com/how_to/transformnode
  35556. */
  35557. transformNodes: TransformNode[];
  35558. /**
  35559. * ActionManagers available on the scene.
  35560. */
  35561. actionManagers: AbstractActionManager[];
  35562. /**
  35563. * Textures to keep.
  35564. */
  35565. textures: BaseTexture[];
  35566. /**
  35567. * Environment texture for the scene
  35568. */
  35569. environmentTexture: Nullable<BaseTexture>;
  35570. }
  35571. }
  35572. declare module "babylonjs/Audio/sound" {
  35573. import { Observable } from "babylonjs/Misc/observable";
  35574. import { Vector3 } from "babylonjs/Maths/math.vector";
  35575. import { Nullable } from "babylonjs/types";
  35576. import { Scene } from "babylonjs/scene";
  35577. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35578. /**
  35579. * Interface used to define options for Sound class
  35580. */
  35581. export interface ISoundOptions {
  35582. /**
  35583. * Does the sound autoplay once loaded.
  35584. */
  35585. autoplay?: boolean;
  35586. /**
  35587. * Does the sound loop after it finishes playing once.
  35588. */
  35589. loop?: boolean;
  35590. /**
  35591. * Sound's volume
  35592. */
  35593. volume?: number;
  35594. /**
  35595. * Is it a spatial sound?
  35596. */
  35597. spatialSound?: boolean;
  35598. /**
  35599. * Maximum distance to hear that sound
  35600. */
  35601. maxDistance?: number;
  35602. /**
  35603. * Uses user defined attenuation function
  35604. */
  35605. useCustomAttenuation?: boolean;
  35606. /**
  35607. * Define the roll off factor of spatial sounds.
  35608. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35609. */
  35610. rolloffFactor?: number;
  35611. /**
  35612. * Define the reference distance the sound should be heard perfectly.
  35613. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35614. */
  35615. refDistance?: number;
  35616. /**
  35617. * Define the distance attenuation model the sound will follow.
  35618. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35619. */
  35620. distanceModel?: string;
  35621. /**
  35622. * Defines the playback speed (1 by default)
  35623. */
  35624. playbackRate?: number;
  35625. /**
  35626. * Defines if the sound is from a streaming source
  35627. */
  35628. streaming?: boolean;
  35629. /**
  35630. * Defines an optional length (in seconds) inside the sound file
  35631. */
  35632. length?: number;
  35633. /**
  35634. * Defines an optional offset (in seconds) inside the sound file
  35635. */
  35636. offset?: number;
  35637. /**
  35638. * If true, URLs will not be required to state the audio file codec to use.
  35639. */
  35640. skipCodecCheck?: boolean;
  35641. }
  35642. /**
  35643. * Defines a sound that can be played in the application.
  35644. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  35645. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  35646. */
  35647. export class Sound {
  35648. /**
  35649. * The name of the sound in the scene.
  35650. */
  35651. name: string;
  35652. /**
  35653. * Does the sound autoplay once loaded.
  35654. */
  35655. autoplay: boolean;
  35656. /**
  35657. * Does the sound loop after it finishes playing once.
  35658. */
  35659. loop: boolean;
  35660. /**
  35661. * Does the sound use a custom attenuation curve to simulate the falloff
  35662. * happening when the source gets further away from the camera.
  35663. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  35664. */
  35665. useCustomAttenuation: boolean;
  35666. /**
  35667. * The sound track id this sound belongs to.
  35668. */
  35669. soundTrackId: number;
  35670. /**
  35671. * Is this sound currently played.
  35672. */
  35673. isPlaying: boolean;
  35674. /**
  35675. * Is this sound currently paused.
  35676. */
  35677. isPaused: boolean;
  35678. /**
  35679. * Does this sound enables spatial sound.
  35680. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35681. */
  35682. spatialSound: boolean;
  35683. /**
  35684. * Define the reference distance the sound should be heard perfectly.
  35685. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35686. */
  35687. refDistance: number;
  35688. /**
  35689. * Define the roll off factor of spatial sounds.
  35690. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35691. */
  35692. rolloffFactor: number;
  35693. /**
  35694. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  35695. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35696. */
  35697. maxDistance: number;
  35698. /**
  35699. * Define the distance attenuation model the sound will follow.
  35700. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35701. */
  35702. distanceModel: string;
  35703. /**
  35704. * @hidden
  35705. * Back Compat
  35706. **/
  35707. onended: () => any;
  35708. /**
  35709. * Observable event when the current playing sound finishes.
  35710. */
  35711. onEndedObservable: Observable<Sound>;
  35712. private _panningModel;
  35713. private _playbackRate;
  35714. private _streaming;
  35715. private _startTime;
  35716. private _startOffset;
  35717. private _position;
  35718. /** @hidden */
  35719. _positionInEmitterSpace: boolean;
  35720. private _localDirection;
  35721. private _volume;
  35722. private _isReadyToPlay;
  35723. private _isDirectional;
  35724. private _readyToPlayCallback;
  35725. private _audioBuffer;
  35726. private _soundSource;
  35727. private _streamingSource;
  35728. private _soundPanner;
  35729. private _soundGain;
  35730. private _inputAudioNode;
  35731. private _outputAudioNode;
  35732. private _coneInnerAngle;
  35733. private _coneOuterAngle;
  35734. private _coneOuterGain;
  35735. private _scene;
  35736. private _connectedTransformNode;
  35737. private _customAttenuationFunction;
  35738. private _registerFunc;
  35739. private _isOutputConnected;
  35740. private _htmlAudioElement;
  35741. private _urlType;
  35742. private _length?;
  35743. private _offset?;
  35744. /** @hidden */
  35745. static _SceneComponentInitialization: (scene: Scene) => void;
  35746. /**
  35747. * Create a sound and attach it to a scene
  35748. * @param name Name of your sound
  35749. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  35750. * @param scene defines the scene the sound belongs to
  35751. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  35752. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  35753. */
  35754. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  35755. /**
  35756. * Release the sound and its associated resources
  35757. */
  35758. dispose(): void;
  35759. /**
  35760. * Gets if the sounds is ready to be played or not.
  35761. * @returns true if ready, otherwise false
  35762. */
  35763. isReady(): boolean;
  35764. private _soundLoaded;
  35765. /**
  35766. * Sets the data of the sound from an audiobuffer
  35767. * @param audioBuffer The audioBuffer containing the data
  35768. */
  35769. setAudioBuffer(audioBuffer: AudioBuffer): void;
  35770. /**
  35771. * Updates the current sounds options such as maxdistance, loop...
  35772. * @param options A JSON object containing values named as the object properties
  35773. */
  35774. updateOptions(options: ISoundOptions): void;
  35775. private _createSpatialParameters;
  35776. private _updateSpatialParameters;
  35777. /**
  35778. * Switch the panning model to HRTF:
  35779. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  35780. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35781. */
  35782. switchPanningModelToHRTF(): void;
  35783. /**
  35784. * Switch the panning model to Equal Power:
  35785. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  35786. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  35787. */
  35788. switchPanningModelToEqualPower(): void;
  35789. private _switchPanningModel;
  35790. /**
  35791. * Connect this sound to a sound track audio node like gain...
  35792. * @param soundTrackAudioNode the sound track audio node to connect to
  35793. */
  35794. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  35795. /**
  35796. * Transform this sound into a directional source
  35797. * @param coneInnerAngle Size of the inner cone in degree
  35798. * @param coneOuterAngle Size of the outer cone in degree
  35799. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  35800. */
  35801. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  35802. /**
  35803. * Gets or sets the inner angle for the directional cone.
  35804. */
  35805. /**
  35806. * Gets or sets the inner angle for the directional cone.
  35807. */
  35808. directionalConeInnerAngle: number;
  35809. /**
  35810. * Gets or sets the outer angle for the directional cone.
  35811. */
  35812. /**
  35813. * Gets or sets the outer angle for the directional cone.
  35814. */
  35815. directionalConeOuterAngle: number;
  35816. /**
  35817. * Sets the position of the emitter if spatial sound is enabled
  35818. * @param newPosition Defines the new posisiton
  35819. */
  35820. setPosition(newPosition: Vector3): void;
  35821. /**
  35822. * Sets the local direction of the emitter if spatial sound is enabled
  35823. * @param newLocalDirection Defines the new local direction
  35824. */
  35825. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  35826. private _updateDirection;
  35827. /** @hidden */
  35828. updateDistanceFromListener(): void;
  35829. /**
  35830. * Sets a new custom attenuation function for the sound.
  35831. * @param callback Defines the function used for the attenuation
  35832. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  35833. */
  35834. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  35835. /**
  35836. * Play the sound
  35837. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  35838. * @param offset (optional) Start the sound at a specific time in seconds
  35839. * @param length (optional) Sound duration (in seconds)
  35840. */
  35841. play(time?: number, offset?: number, length?: number): void;
  35842. private _onended;
  35843. /**
  35844. * Stop the sound
  35845. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  35846. */
  35847. stop(time?: number): void;
  35848. /**
  35849. * Put the sound in pause
  35850. */
  35851. pause(): void;
  35852. /**
  35853. * Sets a dedicated volume for this sounds
  35854. * @param newVolume Define the new volume of the sound
  35855. * @param time Define time for gradual change to new volume
  35856. */
  35857. setVolume(newVolume: number, time?: number): void;
  35858. /**
  35859. * Set the sound play back rate
  35860. * @param newPlaybackRate Define the playback rate the sound should be played at
  35861. */
  35862. setPlaybackRate(newPlaybackRate: number): void;
  35863. /**
  35864. * Gets the volume of the sound.
  35865. * @returns the volume of the sound
  35866. */
  35867. getVolume(): number;
  35868. /**
  35869. * Attach the sound to a dedicated mesh
  35870. * @param transformNode The transform node to connect the sound with
  35871. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  35872. */
  35873. attachToMesh(transformNode: TransformNode): void;
  35874. /**
  35875. * Detach the sound from the previously attached mesh
  35876. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  35877. */
  35878. detachFromMesh(): void;
  35879. private _onRegisterAfterWorldMatrixUpdate;
  35880. /**
  35881. * Clone the current sound in the scene.
  35882. * @returns the new sound clone
  35883. */
  35884. clone(): Nullable<Sound>;
  35885. /**
  35886. * Gets the current underlying audio buffer containing the data
  35887. * @returns the audio buffer
  35888. */
  35889. getAudioBuffer(): Nullable<AudioBuffer>;
  35890. /**
  35891. * Serializes the Sound in a JSON representation
  35892. * @returns the JSON representation of the sound
  35893. */
  35894. serialize(): any;
  35895. /**
  35896. * Parse a JSON representation of a sound to innstantiate in a given scene
  35897. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  35898. * @param scene Define the scene the new parsed sound should be created in
  35899. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  35900. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  35901. * @returns the newly parsed sound
  35902. */
  35903. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  35904. }
  35905. }
  35906. declare module "babylonjs/Actions/directAudioActions" {
  35907. import { Action } from "babylonjs/Actions/action";
  35908. import { Condition } from "babylonjs/Actions/condition";
  35909. import { Sound } from "babylonjs/Audio/sound";
  35910. /**
  35911. * This defines an action helpful to play a defined sound on a triggered action.
  35912. */
  35913. export class PlaySoundAction extends Action {
  35914. private _sound;
  35915. /**
  35916. * Instantiate the action
  35917. * @param triggerOptions defines the trigger options
  35918. * @param sound defines the sound to play
  35919. * @param condition defines the trigger related conditions
  35920. */
  35921. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  35922. /** @hidden */
  35923. _prepare(): void;
  35924. /**
  35925. * Execute the action and play the sound.
  35926. */
  35927. execute(): void;
  35928. /**
  35929. * Serializes the actions and its related information.
  35930. * @param parent defines the object to serialize in
  35931. * @returns the serialized object
  35932. */
  35933. serialize(parent: any): any;
  35934. }
  35935. /**
  35936. * This defines an action helpful to stop a defined sound on a triggered action.
  35937. */
  35938. export class StopSoundAction extends Action {
  35939. private _sound;
  35940. /**
  35941. * Instantiate the action
  35942. * @param triggerOptions defines the trigger options
  35943. * @param sound defines the sound to stop
  35944. * @param condition defines the trigger related conditions
  35945. */
  35946. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  35947. /** @hidden */
  35948. _prepare(): void;
  35949. /**
  35950. * Execute the action and stop the sound.
  35951. */
  35952. execute(): void;
  35953. /**
  35954. * Serializes the actions and its related information.
  35955. * @param parent defines the object to serialize in
  35956. * @returns the serialized object
  35957. */
  35958. serialize(parent: any): any;
  35959. }
  35960. }
  35961. declare module "babylonjs/Actions/interpolateValueAction" {
  35962. import { Action } from "babylonjs/Actions/action";
  35963. import { Condition } from "babylonjs/Actions/condition";
  35964. import { Observable } from "babylonjs/Misc/observable";
  35965. /**
  35966. * This defines an action responsible to change the value of a property
  35967. * by interpolating between its current value and the newly set one once triggered.
  35968. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  35969. */
  35970. export class InterpolateValueAction extends Action {
  35971. /**
  35972. * Defines the path of the property where the value should be interpolated
  35973. */
  35974. propertyPath: string;
  35975. /**
  35976. * Defines the target value at the end of the interpolation.
  35977. */
  35978. value: any;
  35979. /**
  35980. * Defines the time it will take for the property to interpolate to the value.
  35981. */
  35982. duration: number;
  35983. /**
  35984. * Defines if the other scene animations should be stopped when the action has been triggered
  35985. */
  35986. stopOtherAnimations?: boolean;
  35987. /**
  35988. * Defines a callback raised once the interpolation animation has been done.
  35989. */
  35990. onInterpolationDone?: () => void;
  35991. /**
  35992. * Observable triggered once the interpolation animation has been done.
  35993. */
  35994. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  35995. private _target;
  35996. private _effectiveTarget;
  35997. private _property;
  35998. /**
  35999. * Instantiate the action
  36000. * @param triggerOptions defines the trigger options
  36001. * @param target defines the object containing the value to interpolate
  36002. * @param propertyPath defines the path to the property in the target object
  36003. * @param value defines the target value at the end of the interpolation
  36004. * @param duration deines the time it will take for the property to interpolate to the value.
  36005. * @param condition defines the trigger related conditions
  36006. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36007. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36008. */
  36009. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36010. /** @hidden */
  36011. _prepare(): void;
  36012. /**
  36013. * Execute the action starts the value interpolation.
  36014. */
  36015. execute(): void;
  36016. /**
  36017. * Serializes the actions and its related information.
  36018. * @param parent defines the object to serialize in
  36019. * @returns the serialized object
  36020. */
  36021. serialize(parent: any): any;
  36022. }
  36023. }
  36024. declare module "babylonjs/Actions/index" {
  36025. export * from "babylonjs/Actions/action";
  36026. export * from "babylonjs/Actions/actionEvent";
  36027. export * from "babylonjs/Actions/actionManager";
  36028. export * from "babylonjs/Actions/condition";
  36029. export * from "babylonjs/Actions/directActions";
  36030. export * from "babylonjs/Actions/directAudioActions";
  36031. export * from "babylonjs/Actions/interpolateValueAction";
  36032. }
  36033. declare module "babylonjs/Animations/index" {
  36034. export * from "babylonjs/Animations/animatable";
  36035. export * from "babylonjs/Animations/animation";
  36036. export * from "babylonjs/Animations/animationGroup";
  36037. export * from "babylonjs/Animations/animationPropertiesOverride";
  36038. export * from "babylonjs/Animations/easing";
  36039. export * from "babylonjs/Animations/runtimeAnimation";
  36040. export * from "babylonjs/Animations/animationEvent";
  36041. export * from "babylonjs/Animations/animationGroup";
  36042. export * from "babylonjs/Animations/animationKey";
  36043. export * from "babylonjs/Animations/animationRange";
  36044. export * from "babylonjs/Animations/animatable.interface";
  36045. }
  36046. declare module "babylonjs/Audio/soundTrack" {
  36047. import { Sound } from "babylonjs/Audio/sound";
  36048. import { Analyser } from "babylonjs/Audio/analyser";
  36049. import { Scene } from "babylonjs/scene";
  36050. /**
  36051. * Options allowed during the creation of a sound track.
  36052. */
  36053. export interface ISoundTrackOptions {
  36054. /**
  36055. * The volume the sound track should take during creation
  36056. */
  36057. volume?: number;
  36058. /**
  36059. * Define if the sound track is the main sound track of the scene
  36060. */
  36061. mainTrack?: boolean;
  36062. }
  36063. /**
  36064. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36065. * It will be also used in a future release to apply effects on a specific track.
  36066. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36067. */
  36068. export class SoundTrack {
  36069. /**
  36070. * The unique identifier of the sound track in the scene.
  36071. */
  36072. id: number;
  36073. /**
  36074. * The list of sounds included in the sound track.
  36075. */
  36076. soundCollection: Array<Sound>;
  36077. private _outputAudioNode;
  36078. private _scene;
  36079. private _isMainTrack;
  36080. private _connectedAnalyser;
  36081. private _options;
  36082. private _isInitialized;
  36083. /**
  36084. * Creates a new sound track.
  36085. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36086. * @param scene Define the scene the sound track belongs to
  36087. * @param options
  36088. */
  36089. constructor(scene: Scene, options?: ISoundTrackOptions);
  36090. private _initializeSoundTrackAudioGraph;
  36091. /**
  36092. * Release the sound track and its associated resources
  36093. */
  36094. dispose(): void;
  36095. /**
  36096. * Adds a sound to this sound track
  36097. * @param sound define the cound to add
  36098. * @ignoreNaming
  36099. */
  36100. AddSound(sound: Sound): void;
  36101. /**
  36102. * Removes a sound to this sound track
  36103. * @param sound define the cound to remove
  36104. * @ignoreNaming
  36105. */
  36106. RemoveSound(sound: Sound): void;
  36107. /**
  36108. * Set a global volume for the full sound track.
  36109. * @param newVolume Define the new volume of the sound track
  36110. */
  36111. setVolume(newVolume: number): void;
  36112. /**
  36113. * Switch the panning model to HRTF:
  36114. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36115. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36116. */
  36117. switchPanningModelToHRTF(): void;
  36118. /**
  36119. * Switch the panning model to Equal Power:
  36120. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36121. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36122. */
  36123. switchPanningModelToEqualPower(): void;
  36124. /**
  36125. * Connect the sound track to an audio analyser allowing some amazing
  36126. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  36127. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  36128. * @param analyser The analyser to connect to the engine
  36129. */
  36130. connectToAnalyser(analyser: Analyser): void;
  36131. }
  36132. }
  36133. declare module "babylonjs/Audio/audioSceneComponent" {
  36134. import { Sound } from "babylonjs/Audio/sound";
  36135. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  36136. import { Nullable } from "babylonjs/types";
  36137. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  36138. import { Scene } from "babylonjs/scene";
  36139. import { AbstractScene } from "babylonjs/abstractScene";
  36140. import "babylonjs/Audio/audioEngine";
  36141. module "babylonjs/abstractScene" {
  36142. interface AbstractScene {
  36143. /**
  36144. * The list of sounds used in the scene.
  36145. */
  36146. sounds: Nullable<Array<Sound>>;
  36147. }
  36148. }
  36149. module "babylonjs/scene" {
  36150. interface Scene {
  36151. /**
  36152. * @hidden
  36153. * Backing field
  36154. */
  36155. _mainSoundTrack: SoundTrack;
  36156. /**
  36157. * The main sound track played by the scene.
  36158. * It cotains your primary collection of sounds.
  36159. */
  36160. mainSoundTrack: SoundTrack;
  36161. /**
  36162. * The list of sound tracks added to the scene
  36163. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36164. */
  36165. soundTracks: Nullable<Array<SoundTrack>>;
  36166. /**
  36167. * Gets a sound using a given name
  36168. * @param name defines the name to search for
  36169. * @return the found sound or null if not found at all.
  36170. */
  36171. getSoundByName(name: string): Nullable<Sound>;
  36172. /**
  36173. * Gets or sets if audio support is enabled
  36174. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36175. */
  36176. audioEnabled: boolean;
  36177. /**
  36178. * Gets or sets if audio will be output to headphones
  36179. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36180. */
  36181. headphone: boolean;
  36182. }
  36183. }
  36184. /**
  36185. * Defines the sound scene component responsible to manage any sounds
  36186. * in a given scene.
  36187. */
  36188. export class AudioSceneComponent implements ISceneSerializableComponent {
  36189. /**
  36190. * The component name helpfull to identify the component in the list of scene components.
  36191. */
  36192. readonly name: string;
  36193. /**
  36194. * The scene the component belongs to.
  36195. */
  36196. scene: Scene;
  36197. private _audioEnabled;
  36198. /**
  36199. * Gets whether audio is enabled or not.
  36200. * Please use related enable/disable method to switch state.
  36201. */
  36202. readonly audioEnabled: boolean;
  36203. private _headphone;
  36204. /**
  36205. * Gets whether audio is outputing to headphone or not.
  36206. * Please use the according Switch methods to change output.
  36207. */
  36208. readonly headphone: boolean;
  36209. /**
  36210. * Creates a new instance of the component for the given scene
  36211. * @param scene Defines the scene to register the component in
  36212. */
  36213. constructor(scene: Scene);
  36214. /**
  36215. * Registers the component in a given scene
  36216. */
  36217. register(): void;
  36218. /**
  36219. * Rebuilds the elements related to this component in case of
  36220. * context lost for instance.
  36221. */
  36222. rebuild(): void;
  36223. /**
  36224. * Serializes the component data to the specified json object
  36225. * @param serializationObject The object to serialize to
  36226. */
  36227. serialize(serializationObject: any): void;
  36228. /**
  36229. * Adds all the elements from the container to the scene
  36230. * @param container the container holding the elements
  36231. */
  36232. addFromContainer(container: AbstractScene): void;
  36233. /**
  36234. * Removes all the elements in the container from the scene
  36235. * @param container contains the elements to remove
  36236. * @param dispose if the removed element should be disposed (default: false)
  36237. */
  36238. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  36239. /**
  36240. * Disposes the component and the associated ressources.
  36241. */
  36242. dispose(): void;
  36243. /**
  36244. * Disables audio in the associated scene.
  36245. */
  36246. disableAudio(): void;
  36247. /**
  36248. * Enables audio in the associated scene.
  36249. */
  36250. enableAudio(): void;
  36251. /**
  36252. * Switch audio to headphone output.
  36253. */
  36254. switchAudioModeForHeadphones(): void;
  36255. /**
  36256. * Switch audio to normal speakers.
  36257. */
  36258. switchAudioModeForNormalSpeakers(): void;
  36259. private _afterRender;
  36260. }
  36261. }
  36262. declare module "babylonjs/Audio/weightedsound" {
  36263. import { Sound } from "babylonjs/Audio/sound";
  36264. /**
  36265. * Wraps one or more Sound objects and selects one with random weight for playback.
  36266. */
  36267. export class WeightedSound {
  36268. /** When true a Sound will be selected and played when the current playing Sound completes. */
  36269. loop: boolean;
  36270. private _coneInnerAngle;
  36271. private _coneOuterAngle;
  36272. private _volume;
  36273. /** A Sound is currently playing. */
  36274. isPlaying: boolean;
  36275. /** A Sound is currently paused. */
  36276. isPaused: boolean;
  36277. private _sounds;
  36278. private _weights;
  36279. private _currentIndex?;
  36280. /**
  36281. * Creates a new WeightedSound from the list of sounds given.
  36282. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  36283. * @param sounds Array of Sounds that will be selected from.
  36284. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  36285. */
  36286. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  36287. /**
  36288. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  36289. */
  36290. /**
  36291. * The size of cone in degress for a directional sound in which there will be no attenuation.
  36292. */
  36293. directionalConeInnerAngle: number;
  36294. /**
  36295. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36296. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36297. */
  36298. /**
  36299. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36300. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36301. */
  36302. directionalConeOuterAngle: number;
  36303. /**
  36304. * Playback volume.
  36305. */
  36306. /**
  36307. * Playback volume.
  36308. */
  36309. volume: number;
  36310. private _onended;
  36311. /**
  36312. * Suspend playback
  36313. */
  36314. pause(): void;
  36315. /**
  36316. * Stop playback
  36317. */
  36318. stop(): void;
  36319. /**
  36320. * Start playback.
  36321. * @param startOffset Position the clip head at a specific time in seconds.
  36322. */
  36323. play(startOffset?: number): void;
  36324. }
  36325. }
  36326. declare module "babylonjs/Audio/index" {
  36327. export * from "babylonjs/Audio/analyser";
  36328. export * from "babylonjs/Audio/audioEngine";
  36329. export * from "babylonjs/Audio/audioSceneComponent";
  36330. export * from "babylonjs/Audio/sound";
  36331. export * from "babylonjs/Audio/soundTrack";
  36332. export * from "babylonjs/Audio/weightedsound";
  36333. }
  36334. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  36335. import { Behavior } from "babylonjs/Behaviors/behavior";
  36336. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36337. import { BackEase } from "babylonjs/Animations/easing";
  36338. /**
  36339. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  36340. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  36341. */
  36342. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  36343. /**
  36344. * Gets the name of the behavior.
  36345. */
  36346. readonly name: string;
  36347. /**
  36348. * The easing function used by animations
  36349. */
  36350. static EasingFunction: BackEase;
  36351. /**
  36352. * The easing mode used by animations
  36353. */
  36354. static EasingMode: number;
  36355. /**
  36356. * The duration of the animation, in milliseconds
  36357. */
  36358. transitionDuration: number;
  36359. /**
  36360. * Length of the distance animated by the transition when lower radius is reached
  36361. */
  36362. lowerRadiusTransitionRange: number;
  36363. /**
  36364. * Length of the distance animated by the transition when upper radius is reached
  36365. */
  36366. upperRadiusTransitionRange: number;
  36367. private _autoTransitionRange;
  36368. /**
  36369. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36370. */
  36371. /**
  36372. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36373. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  36374. */
  36375. autoTransitionRange: boolean;
  36376. private _attachedCamera;
  36377. private _onAfterCheckInputsObserver;
  36378. private _onMeshTargetChangedObserver;
  36379. /**
  36380. * Initializes the behavior.
  36381. */
  36382. init(): void;
  36383. /**
  36384. * Attaches the behavior to its arc rotate camera.
  36385. * @param camera Defines the camera to attach the behavior to
  36386. */
  36387. attach(camera: ArcRotateCamera): void;
  36388. /**
  36389. * Detaches the behavior from its current arc rotate camera.
  36390. */
  36391. detach(): void;
  36392. private _radiusIsAnimating;
  36393. private _radiusBounceTransition;
  36394. private _animatables;
  36395. private _cachedWheelPrecision;
  36396. /**
  36397. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  36398. * @param radiusLimit The limit to check against.
  36399. * @return Bool to indicate if at limit.
  36400. */
  36401. private _isRadiusAtLimit;
  36402. /**
  36403. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  36404. * @param radiusDelta The delta by which to animate to. Can be negative.
  36405. */
  36406. private _applyBoundRadiusAnimation;
  36407. /**
  36408. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  36409. */
  36410. protected _clearAnimationLocks(): void;
  36411. /**
  36412. * Stops and removes all animations that have been applied to the camera
  36413. */
  36414. stopAllAnimations(): void;
  36415. }
  36416. }
  36417. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  36418. import { Behavior } from "babylonjs/Behaviors/behavior";
  36419. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36420. import { ExponentialEase } from "babylonjs/Animations/easing";
  36421. import { Nullable } from "babylonjs/types";
  36422. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36423. import { Vector3 } from "babylonjs/Maths/math.vector";
  36424. /**
  36425. * 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.
  36426. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  36427. */
  36428. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  36429. /**
  36430. * Gets the name of the behavior.
  36431. */
  36432. readonly name: string;
  36433. private _mode;
  36434. private _radiusScale;
  36435. private _positionScale;
  36436. private _defaultElevation;
  36437. private _elevationReturnTime;
  36438. private _elevationReturnWaitTime;
  36439. private _zoomStopsAnimation;
  36440. private _framingTime;
  36441. /**
  36442. * The easing function used by animations
  36443. */
  36444. static EasingFunction: ExponentialEase;
  36445. /**
  36446. * The easing mode used by animations
  36447. */
  36448. static EasingMode: number;
  36449. /**
  36450. * Sets the current mode used by the behavior
  36451. */
  36452. /**
  36453. * Gets current mode used by the behavior.
  36454. */
  36455. mode: number;
  36456. /**
  36457. * Sets the scale applied to the radius (1 by default)
  36458. */
  36459. /**
  36460. * Gets the scale applied to the radius
  36461. */
  36462. radiusScale: number;
  36463. /**
  36464. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  36465. */
  36466. /**
  36467. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  36468. */
  36469. positionScale: number;
  36470. /**
  36471. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  36472. * behaviour is triggered, in radians.
  36473. */
  36474. /**
  36475. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  36476. * behaviour is triggered, in radians.
  36477. */
  36478. defaultElevation: number;
  36479. /**
  36480. * Sets the time (in milliseconds) taken to return to the default beta position.
  36481. * Negative value indicates camera should not return to default.
  36482. */
  36483. /**
  36484. * Gets the time (in milliseconds) taken to return to the default beta position.
  36485. * Negative value indicates camera should not return to default.
  36486. */
  36487. elevationReturnTime: number;
  36488. /**
  36489. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  36490. */
  36491. /**
  36492. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  36493. */
  36494. elevationReturnWaitTime: number;
  36495. /**
  36496. * Sets the flag that indicates if user zooming should stop animation.
  36497. */
  36498. /**
  36499. * Gets the flag that indicates if user zooming should stop animation.
  36500. */
  36501. zoomStopsAnimation: boolean;
  36502. /**
  36503. * Sets the transition time when framing the mesh, in milliseconds
  36504. */
  36505. /**
  36506. * Gets the transition time when framing the mesh, in milliseconds
  36507. */
  36508. framingTime: number;
  36509. /**
  36510. * Define if the behavior should automatically change the configured
  36511. * camera limits and sensibilities.
  36512. */
  36513. autoCorrectCameraLimitsAndSensibility: boolean;
  36514. private _onPrePointerObservableObserver;
  36515. private _onAfterCheckInputsObserver;
  36516. private _onMeshTargetChangedObserver;
  36517. private _attachedCamera;
  36518. private _isPointerDown;
  36519. private _lastInteractionTime;
  36520. /**
  36521. * Initializes the behavior.
  36522. */
  36523. init(): void;
  36524. /**
  36525. * Attaches the behavior to its arc rotate camera.
  36526. * @param camera Defines the camera to attach the behavior to
  36527. */
  36528. attach(camera: ArcRotateCamera): void;
  36529. /**
  36530. * Detaches the behavior from its current arc rotate camera.
  36531. */
  36532. detach(): void;
  36533. private _animatables;
  36534. private _betaIsAnimating;
  36535. private _betaTransition;
  36536. private _radiusTransition;
  36537. private _vectorTransition;
  36538. /**
  36539. * Targets the given mesh and updates zoom level accordingly.
  36540. * @param mesh The mesh to target.
  36541. * @param radius Optional. If a cached radius position already exists, overrides default.
  36542. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  36543. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36544. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36545. */
  36546. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36547. /**
  36548. * Targets the given mesh with its children and updates zoom level accordingly.
  36549. * @param mesh The mesh to target.
  36550. * @param radius Optional. If a cached radius position already exists, overrides default.
  36551. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  36552. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36553. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36554. */
  36555. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36556. /**
  36557. * Targets the given meshes with their children and updates zoom level accordingly.
  36558. * @param meshes The mesh to target.
  36559. * @param radius Optional. If a cached radius position already exists, overrides default.
  36560. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  36561. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36562. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36563. */
  36564. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36565. /**
  36566. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  36567. * @param minimumWorld Determines the smaller position of the bounding box extend
  36568. * @param maximumWorld Determines the bigger position of the bounding box extend
  36569. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  36570. * @param onAnimationEnd Callback triggered at the end of the framing animation
  36571. */
  36572. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  36573. /**
  36574. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  36575. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  36576. * frustum width.
  36577. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  36578. * to fully enclose the mesh in the viewing frustum.
  36579. */
  36580. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  36581. /**
  36582. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  36583. * is automatically returned to its default position (expected to be above ground plane).
  36584. */
  36585. private _maintainCameraAboveGround;
  36586. /**
  36587. * Returns the frustum slope based on the canvas ratio and camera FOV
  36588. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  36589. */
  36590. private _getFrustumSlope;
  36591. /**
  36592. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  36593. */
  36594. private _clearAnimationLocks;
  36595. /**
  36596. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  36597. */
  36598. private _applyUserInteraction;
  36599. /**
  36600. * Stops and removes all animations that have been applied to the camera
  36601. */
  36602. stopAllAnimations(): void;
  36603. /**
  36604. * Gets a value indicating if the user is moving the camera
  36605. */
  36606. readonly isUserIsMoving: boolean;
  36607. /**
  36608. * The camera can move all the way towards the mesh.
  36609. */
  36610. static IgnoreBoundsSizeMode: number;
  36611. /**
  36612. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  36613. */
  36614. static FitFrustumSidesMode: number;
  36615. }
  36616. }
  36617. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  36618. import { Nullable } from "babylonjs/types";
  36619. import { Camera } from "babylonjs/Cameras/camera";
  36620. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  36621. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  36622. /**
  36623. * Base class for Camera Pointer Inputs.
  36624. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  36625. * for example usage.
  36626. */
  36627. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  36628. /**
  36629. * Defines the camera the input is attached to.
  36630. */
  36631. abstract camera: Camera;
  36632. /**
  36633. * Whether keyboard modifier keys are pressed at time of last mouse event.
  36634. */
  36635. protected _altKey: boolean;
  36636. protected _ctrlKey: boolean;
  36637. protected _metaKey: boolean;
  36638. protected _shiftKey: boolean;
  36639. /**
  36640. * Which mouse buttons were pressed at time of last mouse event.
  36641. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  36642. */
  36643. protected _buttonsPressed: number;
  36644. /**
  36645. * Defines the buttons associated with the input to handle camera move.
  36646. */
  36647. buttons: number[];
  36648. /**
  36649. * Attach the input controls to a specific dom element to get the input from.
  36650. * @param element Defines the element the controls should be listened from
  36651. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  36652. */
  36653. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  36654. /**
  36655. * Detach the current controls from the specified dom element.
  36656. * @param element Defines the element to stop listening the inputs from
  36657. */
  36658. detachControl(element: Nullable<HTMLElement>): void;
  36659. /**
  36660. * Gets the class name of the current input.
  36661. * @returns the class name
  36662. */
  36663. getClassName(): string;
  36664. /**
  36665. * Get the friendly name associated with the input class.
  36666. * @returns the input friendly name
  36667. */
  36668. getSimpleName(): string;
  36669. /**
  36670. * Called on pointer POINTERDOUBLETAP event.
  36671. * Override this method to provide functionality on POINTERDOUBLETAP event.
  36672. */
  36673. protected onDoubleTap(type: string): void;
  36674. /**
  36675. * Called on pointer POINTERMOVE event if only a single touch is active.
  36676. * Override this method to provide functionality.
  36677. */
  36678. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  36679. /**
  36680. * Called on pointer POINTERMOVE event if multiple touches are active.
  36681. * Override this method to provide functionality.
  36682. */
  36683. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  36684. /**
  36685. * Called on JS contextmenu event.
  36686. * Override this method to provide functionality.
  36687. */
  36688. protected onContextMenu(evt: PointerEvent): void;
  36689. /**
  36690. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  36691. * press.
  36692. * Override this method to provide functionality.
  36693. */
  36694. protected onButtonDown(evt: PointerEvent): void;
  36695. /**
  36696. * Called each time a new POINTERUP event occurs. Ie, for each button
  36697. * release.
  36698. * Override this method to provide functionality.
  36699. */
  36700. protected onButtonUp(evt: PointerEvent): void;
  36701. /**
  36702. * Called when window becomes inactive.
  36703. * Override this method to provide functionality.
  36704. */
  36705. protected onLostFocus(): void;
  36706. private _pointerInput;
  36707. private _observer;
  36708. private _onLostFocus;
  36709. private pointA;
  36710. private pointB;
  36711. }
  36712. }
  36713. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  36714. import { Nullable } from "babylonjs/types";
  36715. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36716. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  36717. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  36718. /**
  36719. * Manage the pointers inputs to control an arc rotate camera.
  36720. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  36721. */
  36722. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  36723. /**
  36724. * Defines the camera the input is attached to.
  36725. */
  36726. camera: ArcRotateCamera;
  36727. /**
  36728. * Gets the class name of the current input.
  36729. * @returns the class name
  36730. */
  36731. getClassName(): string;
  36732. /**
  36733. * Defines the buttons associated with the input to handle camera move.
  36734. */
  36735. buttons: number[];
  36736. /**
  36737. * Defines the pointer angular sensibility along the X axis or how fast is
  36738. * the camera rotating.
  36739. */
  36740. angularSensibilityX: number;
  36741. /**
  36742. * Defines the pointer angular sensibility along the Y axis or how fast is
  36743. * the camera rotating.
  36744. */
  36745. angularSensibilityY: number;
  36746. /**
  36747. * Defines the pointer pinch precision or how fast is the camera zooming.
  36748. */
  36749. pinchPrecision: number;
  36750. /**
  36751. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  36752. * from 0.
  36753. * It defines the percentage of current camera.radius to use as delta when
  36754. * pinch zoom is used.
  36755. */
  36756. pinchDeltaPercentage: number;
  36757. /**
  36758. * Defines the pointer panning sensibility or how fast is the camera moving.
  36759. */
  36760. panningSensibility: number;
  36761. /**
  36762. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  36763. */
  36764. multiTouchPanning: boolean;
  36765. /**
  36766. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  36767. * zoom (pinch) through multitouch.
  36768. */
  36769. multiTouchPanAndZoom: boolean;
  36770. /**
  36771. * Revers pinch action direction.
  36772. */
  36773. pinchInwards: boolean;
  36774. private _isPanClick;
  36775. private _twoFingerActivityCount;
  36776. private _isPinching;
  36777. /**
  36778. * Called on pointer POINTERMOVE event if only a single touch is active.
  36779. */
  36780. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  36781. /**
  36782. * Called on pointer POINTERDOUBLETAP event.
  36783. */
  36784. protected onDoubleTap(type: string): void;
  36785. /**
  36786. * Called on pointer POINTERMOVE event if multiple touches are active.
  36787. */
  36788. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  36789. /**
  36790. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  36791. * press.
  36792. */
  36793. protected onButtonDown(evt: PointerEvent): void;
  36794. /**
  36795. * Called each time a new POINTERUP event occurs. Ie, for each button
  36796. * release.
  36797. */
  36798. protected onButtonUp(evt: PointerEvent): void;
  36799. /**
  36800. * Called when window becomes inactive.
  36801. */
  36802. protected onLostFocus(): void;
  36803. }
  36804. }
  36805. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  36806. import { Nullable } from "babylonjs/types";
  36807. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36808. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  36809. /**
  36810. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  36811. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  36812. */
  36813. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  36814. /**
  36815. * Defines the camera the input is attached to.
  36816. */
  36817. camera: ArcRotateCamera;
  36818. /**
  36819. * Defines the list of key codes associated with the up action (increase alpha)
  36820. */
  36821. keysUp: number[];
  36822. /**
  36823. * Defines the list of key codes associated with the down action (decrease alpha)
  36824. */
  36825. keysDown: number[];
  36826. /**
  36827. * Defines the list of key codes associated with the left action (increase beta)
  36828. */
  36829. keysLeft: number[];
  36830. /**
  36831. * Defines the list of key codes associated with the right action (decrease beta)
  36832. */
  36833. keysRight: number[];
  36834. /**
  36835. * Defines the list of key codes associated with the reset action.
  36836. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  36837. */
  36838. keysReset: number[];
  36839. /**
  36840. * Defines the panning sensibility of the inputs.
  36841. * (How fast is the camera paning)
  36842. */
  36843. panningSensibility: number;
  36844. /**
  36845. * Defines the zooming sensibility of the inputs.
  36846. * (How fast is the camera zooming)
  36847. */
  36848. zoomingSensibility: number;
  36849. /**
  36850. * Defines wether maintaining the alt key down switch the movement mode from
  36851. * orientation to zoom.
  36852. */
  36853. useAltToZoom: boolean;
  36854. /**
  36855. * Rotation speed of the camera
  36856. */
  36857. angularSpeed: number;
  36858. private _keys;
  36859. private _ctrlPressed;
  36860. private _altPressed;
  36861. private _onCanvasBlurObserver;
  36862. private _onKeyboardObserver;
  36863. private _engine;
  36864. private _scene;
  36865. /**
  36866. * Attach the input controls to a specific dom element to get the input from.
  36867. * @param element Defines the element the controls should be listened from
  36868. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  36869. */
  36870. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  36871. /**
  36872. * Detach the current controls from the specified dom element.
  36873. * @param element Defines the element to stop listening the inputs from
  36874. */
  36875. detachControl(element: Nullable<HTMLElement>): void;
  36876. /**
  36877. * Update the current camera state depending on the inputs that have been used this frame.
  36878. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  36879. */
  36880. checkInputs(): void;
  36881. /**
  36882. * Gets the class name of the current intput.
  36883. * @returns the class name
  36884. */
  36885. getClassName(): string;
  36886. /**
  36887. * Get the friendly name associated with the input class.
  36888. * @returns the input friendly name
  36889. */
  36890. getSimpleName(): string;
  36891. }
  36892. }
  36893. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  36894. import { Nullable } from "babylonjs/types";
  36895. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36896. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  36897. /**
  36898. * Manage the mouse wheel inputs to control an arc rotate camera.
  36899. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  36900. */
  36901. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  36902. /**
  36903. * Defines the camera the input is attached to.
  36904. */
  36905. camera: ArcRotateCamera;
  36906. /**
  36907. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  36908. */
  36909. wheelPrecision: number;
  36910. /**
  36911. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  36912. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  36913. */
  36914. wheelDeltaPercentage: number;
  36915. private _wheel;
  36916. private _observer;
  36917. private computeDeltaFromMouseWheelLegacyEvent;
  36918. /**
  36919. * Attach the input controls to a specific dom element to get the input from.
  36920. * @param element Defines the element the controls should be listened from
  36921. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  36922. */
  36923. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  36924. /**
  36925. * Detach the current controls from the specified dom element.
  36926. * @param element Defines the element to stop listening the inputs from
  36927. */
  36928. detachControl(element: Nullable<HTMLElement>): void;
  36929. /**
  36930. * Gets the class name of the current intput.
  36931. * @returns the class name
  36932. */
  36933. getClassName(): string;
  36934. /**
  36935. * Get the friendly name associated with the input class.
  36936. * @returns the input friendly name
  36937. */
  36938. getSimpleName(): string;
  36939. }
  36940. }
  36941. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  36942. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36943. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  36944. /**
  36945. * Default Inputs manager for the ArcRotateCamera.
  36946. * It groups all the default supported inputs for ease of use.
  36947. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  36948. */
  36949. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  36950. /**
  36951. * Instantiates a new ArcRotateCameraInputsManager.
  36952. * @param camera Defines the camera the inputs belong to
  36953. */
  36954. constructor(camera: ArcRotateCamera);
  36955. /**
  36956. * Add mouse wheel input support to the input manager.
  36957. * @returns the current input manager
  36958. */
  36959. addMouseWheel(): ArcRotateCameraInputsManager;
  36960. /**
  36961. * Add pointers input support to the input manager.
  36962. * @returns the current input manager
  36963. */
  36964. addPointers(): ArcRotateCameraInputsManager;
  36965. /**
  36966. * Add keyboard input support to the input manager.
  36967. * @returns the current input manager
  36968. */
  36969. addKeyboard(): ArcRotateCameraInputsManager;
  36970. }
  36971. }
  36972. declare module "babylonjs/Cameras/arcRotateCamera" {
  36973. import { Observable } from "babylonjs/Misc/observable";
  36974. import { Nullable } from "babylonjs/types";
  36975. import { Scene } from "babylonjs/scene";
  36976. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  36977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36978. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  36979. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  36980. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  36981. import { Camera } from "babylonjs/Cameras/camera";
  36982. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  36983. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  36984. import { Collider } from "babylonjs/Collisions/collider";
  36985. /**
  36986. * This represents an orbital type of camera.
  36987. *
  36988. * 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.
  36989. * 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.
  36990. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  36991. */
  36992. export class ArcRotateCamera extends TargetCamera {
  36993. /**
  36994. * Defines the rotation angle of the camera along the longitudinal axis.
  36995. */
  36996. alpha: number;
  36997. /**
  36998. * Defines the rotation angle of the camera along the latitudinal axis.
  36999. */
  37000. beta: number;
  37001. /**
  37002. * Defines the radius of the camera from it s target point.
  37003. */
  37004. radius: number;
  37005. protected _target: Vector3;
  37006. protected _targetHost: Nullable<AbstractMesh>;
  37007. /**
  37008. * Defines the target point of the camera.
  37009. * The camera looks towards it form the radius distance.
  37010. */
  37011. target: Vector3;
  37012. /**
  37013. * Define the current local position of the camera in the scene
  37014. */
  37015. position: Vector3;
  37016. protected _upVector: Vector3;
  37017. protected _upToYMatrix: Matrix;
  37018. protected _YToUpMatrix: Matrix;
  37019. /**
  37020. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37021. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37022. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37023. */
  37024. upVector: Vector3;
  37025. /**
  37026. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37027. */
  37028. setMatUp(): void;
  37029. /**
  37030. * Current inertia value on the longitudinal axis.
  37031. * The bigger this number the longer it will take for the camera to stop.
  37032. */
  37033. inertialAlphaOffset: number;
  37034. /**
  37035. * Current inertia value on the latitudinal axis.
  37036. * The bigger this number the longer it will take for the camera to stop.
  37037. */
  37038. inertialBetaOffset: number;
  37039. /**
  37040. * Current inertia value on the radius axis.
  37041. * The bigger this number the longer it will take for the camera to stop.
  37042. */
  37043. inertialRadiusOffset: number;
  37044. /**
  37045. * Minimum allowed angle on the longitudinal axis.
  37046. * This can help limiting how the Camera is able to move in the scene.
  37047. */
  37048. lowerAlphaLimit: Nullable<number>;
  37049. /**
  37050. * Maximum allowed angle on the longitudinal axis.
  37051. * This can help limiting how the Camera is able to move in the scene.
  37052. */
  37053. upperAlphaLimit: Nullable<number>;
  37054. /**
  37055. * Minimum allowed angle on the latitudinal axis.
  37056. * This can help limiting how the Camera is able to move in the scene.
  37057. */
  37058. lowerBetaLimit: number;
  37059. /**
  37060. * Maximum allowed angle on the latitudinal axis.
  37061. * This can help limiting how the Camera is able to move in the scene.
  37062. */
  37063. upperBetaLimit: number;
  37064. /**
  37065. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37066. * This can help limiting how the Camera is able to move in the scene.
  37067. */
  37068. lowerRadiusLimit: Nullable<number>;
  37069. /**
  37070. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37071. * This can help limiting how the Camera is able to move in the scene.
  37072. */
  37073. upperRadiusLimit: Nullable<number>;
  37074. /**
  37075. * Defines the current inertia value used during panning of the camera along the X axis.
  37076. */
  37077. inertialPanningX: number;
  37078. /**
  37079. * Defines the current inertia value used during panning of the camera along the Y axis.
  37080. */
  37081. inertialPanningY: number;
  37082. /**
  37083. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  37084. * Basically if your fingers moves away from more than this distance you will be considered
  37085. * in pinch mode.
  37086. */
  37087. pinchToPanMaxDistance: number;
  37088. /**
  37089. * Defines the maximum distance the camera can pan.
  37090. * This could help keeping the cammera always in your scene.
  37091. */
  37092. panningDistanceLimit: Nullable<number>;
  37093. /**
  37094. * Defines the target of the camera before paning.
  37095. */
  37096. panningOriginTarget: Vector3;
  37097. /**
  37098. * Defines the value of the inertia used during panning.
  37099. * 0 would mean stop inertia and one would mean no decelleration at all.
  37100. */
  37101. panningInertia: number;
  37102. /**
  37103. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  37104. */
  37105. angularSensibilityX: number;
  37106. /**
  37107. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  37108. */
  37109. angularSensibilityY: number;
  37110. /**
  37111. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  37112. */
  37113. pinchPrecision: number;
  37114. /**
  37115. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  37116. * It will be used instead of pinchDeltaPrecision if different from 0.
  37117. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37118. */
  37119. pinchDeltaPercentage: number;
  37120. /**
  37121. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  37122. */
  37123. panningSensibility: number;
  37124. /**
  37125. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  37126. */
  37127. keysUp: number[];
  37128. /**
  37129. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  37130. */
  37131. keysDown: number[];
  37132. /**
  37133. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  37134. */
  37135. keysLeft: number[];
  37136. /**
  37137. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  37138. */
  37139. keysRight: number[];
  37140. /**
  37141. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37142. */
  37143. wheelPrecision: number;
  37144. /**
  37145. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  37146. * It will be used instead of pinchDeltaPrecision if different from 0.
  37147. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37148. */
  37149. wheelDeltaPercentage: number;
  37150. /**
  37151. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  37152. */
  37153. zoomOnFactor: number;
  37154. /**
  37155. * Defines a screen offset for the camera position.
  37156. */
  37157. targetScreenOffset: Vector2;
  37158. /**
  37159. * Allows the camera to be completely reversed.
  37160. * If false the camera can not arrive upside down.
  37161. */
  37162. allowUpsideDown: boolean;
  37163. /**
  37164. * Define if double tap/click is used to restore the previously saved state of the camera.
  37165. */
  37166. useInputToRestoreState: boolean;
  37167. /** @hidden */
  37168. _viewMatrix: Matrix;
  37169. /** @hidden */
  37170. _useCtrlForPanning: boolean;
  37171. /** @hidden */
  37172. _panningMouseButton: number;
  37173. /**
  37174. * Defines the input associated to the camera.
  37175. */
  37176. inputs: ArcRotateCameraInputsManager;
  37177. /** @hidden */
  37178. _reset: () => void;
  37179. /**
  37180. * Defines the allowed panning axis.
  37181. */
  37182. panningAxis: Vector3;
  37183. protected _localDirection: Vector3;
  37184. protected _transformedDirection: Vector3;
  37185. private _bouncingBehavior;
  37186. /**
  37187. * Gets the bouncing behavior of the camera if it has been enabled.
  37188. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37189. */
  37190. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  37191. /**
  37192. * Defines if the bouncing behavior of the camera is enabled on the camera.
  37193. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37194. */
  37195. useBouncingBehavior: boolean;
  37196. private _framingBehavior;
  37197. /**
  37198. * Gets the framing behavior of the camera if it has been enabled.
  37199. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37200. */
  37201. readonly framingBehavior: Nullable<FramingBehavior>;
  37202. /**
  37203. * Defines if the framing behavior of the camera is enabled on the camera.
  37204. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37205. */
  37206. useFramingBehavior: boolean;
  37207. private _autoRotationBehavior;
  37208. /**
  37209. * Gets the auto rotation behavior of the camera if it has been enabled.
  37210. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37211. */
  37212. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  37213. /**
  37214. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  37215. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37216. */
  37217. useAutoRotationBehavior: boolean;
  37218. /**
  37219. * Observable triggered when the mesh target has been changed on the camera.
  37220. */
  37221. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  37222. /**
  37223. * Event raised when the camera is colliding with a mesh.
  37224. */
  37225. onCollide: (collidedMesh: AbstractMesh) => void;
  37226. /**
  37227. * Defines whether the camera should check collision with the objects oh the scene.
  37228. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  37229. */
  37230. checkCollisions: boolean;
  37231. /**
  37232. * Defines the collision radius of the camera.
  37233. * This simulates a sphere around the camera.
  37234. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  37235. */
  37236. collisionRadius: Vector3;
  37237. protected _collider: Collider;
  37238. protected _previousPosition: Vector3;
  37239. protected _collisionVelocity: Vector3;
  37240. protected _newPosition: Vector3;
  37241. protected _previousAlpha: number;
  37242. protected _previousBeta: number;
  37243. protected _previousRadius: number;
  37244. protected _collisionTriggered: boolean;
  37245. protected _targetBoundingCenter: Nullable<Vector3>;
  37246. private _computationVector;
  37247. /**
  37248. * Instantiates a new ArcRotateCamera in a given scene
  37249. * @param name Defines the name of the camera
  37250. * @param alpha Defines the camera rotation along the logitudinal axis
  37251. * @param beta Defines the camera rotation along the latitudinal axis
  37252. * @param radius Defines the camera distance from its target
  37253. * @param target Defines the camera target
  37254. * @param scene Defines the scene the camera belongs to
  37255. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  37256. */
  37257. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  37258. /** @hidden */
  37259. _initCache(): void;
  37260. /** @hidden */
  37261. _updateCache(ignoreParentClass?: boolean): void;
  37262. protected _getTargetPosition(): Vector3;
  37263. private _storedAlpha;
  37264. private _storedBeta;
  37265. private _storedRadius;
  37266. private _storedTarget;
  37267. /**
  37268. * Stores the current state of the camera (alpha, beta, radius and target)
  37269. * @returns the camera itself
  37270. */
  37271. storeState(): Camera;
  37272. /**
  37273. * @hidden
  37274. * Restored camera state. You must call storeState() first
  37275. */
  37276. _restoreStateValues(): boolean;
  37277. /** @hidden */
  37278. _isSynchronizedViewMatrix(): boolean;
  37279. /**
  37280. * Attached controls to the current camera.
  37281. * @param element Defines the element the controls should be listened from
  37282. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37283. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  37284. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  37285. */
  37286. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  37287. /**
  37288. * Detach the current controls from the camera.
  37289. * The camera will stop reacting to inputs.
  37290. * @param element Defines the element to stop listening the inputs from
  37291. */
  37292. detachControl(element: HTMLElement): void;
  37293. /** @hidden */
  37294. _checkInputs(): void;
  37295. protected _checkLimits(): void;
  37296. /**
  37297. * Rebuilds angles (alpha, beta) and radius from the give position and target
  37298. */
  37299. rebuildAnglesAndRadius(): void;
  37300. /**
  37301. * Use a position to define the current camera related information like aplha, beta and radius
  37302. * @param position Defines the position to set the camera at
  37303. */
  37304. setPosition(position: Vector3): void;
  37305. /**
  37306. * Defines the target the camera should look at.
  37307. * This will automatically adapt alpha beta and radius to fit within the new target.
  37308. * @param target Defines the new target as a Vector or a mesh
  37309. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  37310. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  37311. */
  37312. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  37313. /** @hidden */
  37314. _getViewMatrix(): Matrix;
  37315. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  37316. /**
  37317. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  37318. * @param meshes Defines the mesh to zoom on
  37319. * @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)
  37320. */
  37321. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  37322. /**
  37323. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  37324. * The target will be changed but the radius
  37325. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  37326. * @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)
  37327. */
  37328. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  37329. min: Vector3;
  37330. max: Vector3;
  37331. distance: number;
  37332. }, doNotUpdateMaxZ?: boolean): void;
  37333. /**
  37334. * @override
  37335. * Override Camera.createRigCamera
  37336. */
  37337. createRigCamera(name: string, cameraIndex: number): Camera;
  37338. /**
  37339. * @hidden
  37340. * @override
  37341. * Override Camera._updateRigCameras
  37342. */
  37343. _updateRigCameras(): void;
  37344. /**
  37345. * Destroy the camera and release the current resources hold by it.
  37346. */
  37347. dispose(): void;
  37348. /**
  37349. * Gets the current object class name.
  37350. * @return the class name
  37351. */
  37352. getClassName(): string;
  37353. }
  37354. }
  37355. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  37356. import { Behavior } from "babylonjs/Behaviors/behavior";
  37357. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37358. /**
  37359. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  37360. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37361. */
  37362. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  37363. /**
  37364. * Gets the name of the behavior.
  37365. */
  37366. readonly name: string;
  37367. private _zoomStopsAnimation;
  37368. private _idleRotationSpeed;
  37369. private _idleRotationWaitTime;
  37370. private _idleRotationSpinupTime;
  37371. /**
  37372. * Sets the flag that indicates if user zooming should stop animation.
  37373. */
  37374. /**
  37375. * Gets the flag that indicates if user zooming should stop animation.
  37376. */
  37377. zoomStopsAnimation: boolean;
  37378. /**
  37379. * Sets the default speed at which the camera rotates around the model.
  37380. */
  37381. /**
  37382. * Gets the default speed at which the camera rotates around the model.
  37383. */
  37384. idleRotationSpeed: number;
  37385. /**
  37386. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  37387. */
  37388. /**
  37389. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  37390. */
  37391. idleRotationWaitTime: number;
  37392. /**
  37393. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37394. */
  37395. /**
  37396. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37397. */
  37398. idleRotationSpinupTime: number;
  37399. /**
  37400. * Gets a value indicating if the camera is currently rotating because of this behavior
  37401. */
  37402. readonly rotationInProgress: boolean;
  37403. private _onPrePointerObservableObserver;
  37404. private _onAfterCheckInputsObserver;
  37405. private _attachedCamera;
  37406. private _isPointerDown;
  37407. private _lastFrameTime;
  37408. private _lastInteractionTime;
  37409. private _cameraRotationSpeed;
  37410. /**
  37411. * Initializes the behavior.
  37412. */
  37413. init(): void;
  37414. /**
  37415. * Attaches the behavior to its arc rotate camera.
  37416. * @param camera Defines the camera to attach the behavior to
  37417. */
  37418. attach(camera: ArcRotateCamera): void;
  37419. /**
  37420. * Detaches the behavior from its current arc rotate camera.
  37421. */
  37422. detach(): void;
  37423. /**
  37424. * Returns true if user is scrolling.
  37425. * @return true if user is scrolling.
  37426. */
  37427. private _userIsZooming;
  37428. private _lastFrameRadius;
  37429. private _shouldAnimationStopForInteraction;
  37430. /**
  37431. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37432. */
  37433. private _applyUserInteraction;
  37434. private _userIsMoving;
  37435. }
  37436. }
  37437. declare module "babylonjs/Behaviors/Cameras/index" {
  37438. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37439. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37440. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  37441. }
  37442. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  37443. import { Mesh } from "babylonjs/Meshes/mesh";
  37444. import { TransformNode } from "babylonjs/Meshes/transformNode";
  37445. import { Behavior } from "babylonjs/Behaviors/behavior";
  37446. /**
  37447. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  37448. */
  37449. export class AttachToBoxBehavior implements Behavior<Mesh> {
  37450. private ui;
  37451. /**
  37452. * The name of the behavior
  37453. */
  37454. name: string;
  37455. /**
  37456. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  37457. */
  37458. distanceAwayFromFace: number;
  37459. /**
  37460. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  37461. */
  37462. distanceAwayFromBottomOfFace: number;
  37463. private _faceVectors;
  37464. private _target;
  37465. private _scene;
  37466. private _onRenderObserver;
  37467. private _tmpMatrix;
  37468. private _tmpVector;
  37469. /**
  37470. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  37471. * @param ui The transform node that should be attched to the mesh
  37472. */
  37473. constructor(ui: TransformNode);
  37474. /**
  37475. * Initializes the behavior
  37476. */
  37477. init(): void;
  37478. private _closestFace;
  37479. private _zeroVector;
  37480. private _lookAtTmpMatrix;
  37481. private _lookAtToRef;
  37482. /**
  37483. * Attaches the AttachToBoxBehavior to the passed in mesh
  37484. * @param target The mesh that the specified node will be attached to
  37485. */
  37486. attach(target: Mesh): void;
  37487. /**
  37488. * Detaches the behavior from the mesh
  37489. */
  37490. detach(): void;
  37491. }
  37492. }
  37493. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  37494. import { Behavior } from "babylonjs/Behaviors/behavior";
  37495. import { Mesh } from "babylonjs/Meshes/mesh";
  37496. /**
  37497. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  37498. */
  37499. export class FadeInOutBehavior implements Behavior<Mesh> {
  37500. /**
  37501. * Time in milliseconds to delay before fading in (Default: 0)
  37502. */
  37503. delay: number;
  37504. /**
  37505. * Time in milliseconds for the mesh to fade in (Default: 300)
  37506. */
  37507. fadeInTime: number;
  37508. private _millisecondsPerFrame;
  37509. private _hovered;
  37510. private _hoverValue;
  37511. private _ownerNode;
  37512. /**
  37513. * Instatiates the FadeInOutBehavior
  37514. */
  37515. constructor();
  37516. /**
  37517. * The name of the behavior
  37518. */
  37519. readonly name: string;
  37520. /**
  37521. * Initializes the behavior
  37522. */
  37523. init(): void;
  37524. /**
  37525. * Attaches the fade behavior on the passed in mesh
  37526. * @param ownerNode The mesh that will be faded in/out once attached
  37527. */
  37528. attach(ownerNode: Mesh): void;
  37529. /**
  37530. * Detaches the behavior from the mesh
  37531. */
  37532. detach(): void;
  37533. /**
  37534. * Triggers the mesh to begin fading in or out
  37535. * @param value if the object should fade in or out (true to fade in)
  37536. */
  37537. fadeIn(value: boolean): void;
  37538. private _update;
  37539. private _setAllVisibility;
  37540. }
  37541. }
  37542. declare module "babylonjs/Misc/pivotTools" {
  37543. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37544. /**
  37545. * Class containing a set of static utilities functions for managing Pivots
  37546. * @hidden
  37547. */
  37548. export class PivotTools {
  37549. private static _PivotCached;
  37550. private static _OldPivotPoint;
  37551. private static _PivotTranslation;
  37552. private static _PivotTmpVector;
  37553. /** @hidden */
  37554. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  37555. /** @hidden */
  37556. static _RestorePivotPoint(mesh: AbstractMesh): void;
  37557. }
  37558. }
  37559. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  37560. import { Scene } from "babylonjs/scene";
  37561. import { Vector4 } from "babylonjs/Maths/math.vector";
  37562. import { Mesh } from "babylonjs/Meshes/mesh";
  37563. import { Nullable } from "babylonjs/types";
  37564. import { Plane } from "babylonjs/Maths/math.plane";
  37565. /**
  37566. * Class containing static functions to help procedurally build meshes
  37567. */
  37568. export class PlaneBuilder {
  37569. /**
  37570. * Creates a plane mesh
  37571. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  37572. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  37573. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  37574. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  37575. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  37576. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  37577. * @param name defines the name of the mesh
  37578. * @param options defines the options used to create the mesh
  37579. * @param scene defines the hosting scene
  37580. * @returns the plane mesh
  37581. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  37582. */
  37583. static CreatePlane(name: string, options: {
  37584. size?: number;
  37585. width?: number;
  37586. height?: number;
  37587. sideOrientation?: number;
  37588. frontUVs?: Vector4;
  37589. backUVs?: Vector4;
  37590. updatable?: boolean;
  37591. sourcePlane?: Plane;
  37592. }, scene?: Nullable<Scene>): Mesh;
  37593. }
  37594. }
  37595. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  37596. import { Behavior } from "babylonjs/Behaviors/behavior";
  37597. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37598. import { Observable } from "babylonjs/Misc/observable";
  37599. import { Vector3 } from "babylonjs/Maths/math.vector";
  37600. import { Ray } from "babylonjs/Culling/ray";
  37601. import "babylonjs/Meshes/Builders/planeBuilder";
  37602. /**
  37603. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  37604. */
  37605. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  37606. private static _AnyMouseID;
  37607. /**
  37608. * Abstract mesh the behavior is set on
  37609. */
  37610. attachedNode: AbstractMesh;
  37611. private _dragPlane;
  37612. private _scene;
  37613. private _pointerObserver;
  37614. private _beforeRenderObserver;
  37615. private static _planeScene;
  37616. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  37617. /**
  37618. * 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)
  37619. */
  37620. maxDragAngle: number;
  37621. /**
  37622. * @hidden
  37623. */
  37624. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  37625. /**
  37626. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  37627. */
  37628. currentDraggingPointerID: number;
  37629. /**
  37630. * The last position where the pointer hit the drag plane in world space
  37631. */
  37632. lastDragPosition: Vector3;
  37633. /**
  37634. * If the behavior is currently in a dragging state
  37635. */
  37636. dragging: boolean;
  37637. /**
  37638. * 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)
  37639. */
  37640. dragDeltaRatio: number;
  37641. /**
  37642. * If the drag plane orientation should be updated during the dragging (Default: true)
  37643. */
  37644. updateDragPlane: boolean;
  37645. private _debugMode;
  37646. private _moving;
  37647. /**
  37648. * Fires each time the attached mesh is dragged with the pointer
  37649. * * delta between last drag position and current drag position in world space
  37650. * * dragDistance along the drag axis
  37651. * * dragPlaneNormal normal of the current drag plane used during the drag
  37652. * * dragPlanePoint in world space where the drag intersects the drag plane
  37653. */
  37654. onDragObservable: Observable<{
  37655. delta: Vector3;
  37656. dragPlanePoint: Vector3;
  37657. dragPlaneNormal: Vector3;
  37658. dragDistance: number;
  37659. pointerId: number;
  37660. }>;
  37661. /**
  37662. * Fires each time a drag begins (eg. mouse down on mesh)
  37663. */
  37664. onDragStartObservable: Observable<{
  37665. dragPlanePoint: Vector3;
  37666. pointerId: number;
  37667. }>;
  37668. /**
  37669. * Fires each time a drag ends (eg. mouse release after drag)
  37670. */
  37671. onDragEndObservable: Observable<{
  37672. dragPlanePoint: Vector3;
  37673. pointerId: number;
  37674. }>;
  37675. /**
  37676. * If the attached mesh should be moved when dragged
  37677. */
  37678. moveAttached: boolean;
  37679. /**
  37680. * If the drag behavior will react to drag events (Default: true)
  37681. */
  37682. enabled: boolean;
  37683. /**
  37684. * If pointer events should start and release the drag (Default: true)
  37685. */
  37686. startAndReleaseDragOnPointerEvents: boolean;
  37687. /**
  37688. * If camera controls should be detached during the drag
  37689. */
  37690. detachCameraControls: boolean;
  37691. /**
  37692. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  37693. */
  37694. useObjectOrienationForDragging: boolean;
  37695. private _options;
  37696. /**
  37697. * Creates a pointer drag behavior that can be attached to a mesh
  37698. * @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)
  37699. */
  37700. constructor(options?: {
  37701. dragAxis?: Vector3;
  37702. dragPlaneNormal?: Vector3;
  37703. });
  37704. /**
  37705. * Predicate to determine if it is valid to move the object to a new position when it is moved
  37706. */
  37707. validateDrag: (targetPosition: Vector3) => boolean;
  37708. /**
  37709. * The name of the behavior
  37710. */
  37711. readonly name: string;
  37712. /**
  37713. * Initializes the behavior
  37714. */
  37715. init(): void;
  37716. private _tmpVector;
  37717. private _alternatePickedPoint;
  37718. private _worldDragAxis;
  37719. private _targetPosition;
  37720. private _attachedElement;
  37721. /**
  37722. * Attaches the drag behavior the passed in mesh
  37723. * @param ownerNode The mesh that will be dragged around once attached
  37724. */
  37725. attach(ownerNode: AbstractMesh): void;
  37726. /**
  37727. * Force relase the drag action by code.
  37728. */
  37729. releaseDrag(): void;
  37730. private _startDragRay;
  37731. private _lastPointerRay;
  37732. /**
  37733. * Simulates the start of a pointer drag event on the behavior
  37734. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  37735. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  37736. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  37737. */
  37738. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  37739. private _startDrag;
  37740. private _dragDelta;
  37741. private _moveDrag;
  37742. private _pickWithRayOnDragPlane;
  37743. private _pointA;
  37744. private _pointB;
  37745. private _pointC;
  37746. private _lineA;
  37747. private _lineB;
  37748. private _localAxis;
  37749. private _lookAt;
  37750. private _updateDragPlanePosition;
  37751. /**
  37752. * Detaches the behavior from the mesh
  37753. */
  37754. detach(): void;
  37755. }
  37756. }
  37757. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  37758. import { Mesh } from "babylonjs/Meshes/mesh";
  37759. import { Behavior } from "babylonjs/Behaviors/behavior";
  37760. /**
  37761. * A behavior that when attached to a mesh will allow the mesh to be scaled
  37762. */
  37763. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  37764. private _dragBehaviorA;
  37765. private _dragBehaviorB;
  37766. private _startDistance;
  37767. private _initialScale;
  37768. private _targetScale;
  37769. private _ownerNode;
  37770. private _sceneRenderObserver;
  37771. /**
  37772. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  37773. */
  37774. constructor();
  37775. /**
  37776. * The name of the behavior
  37777. */
  37778. readonly name: string;
  37779. /**
  37780. * Initializes the behavior
  37781. */
  37782. init(): void;
  37783. private _getCurrentDistance;
  37784. /**
  37785. * Attaches the scale behavior the passed in mesh
  37786. * @param ownerNode The mesh that will be scaled around once attached
  37787. */
  37788. attach(ownerNode: Mesh): void;
  37789. /**
  37790. * Detaches the behavior from the mesh
  37791. */
  37792. detach(): void;
  37793. }
  37794. }
  37795. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  37796. import { Behavior } from "babylonjs/Behaviors/behavior";
  37797. import { Mesh } from "babylonjs/Meshes/mesh";
  37798. import { Observable } from "babylonjs/Misc/observable";
  37799. /**
  37800. * 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
  37801. */
  37802. export class SixDofDragBehavior implements Behavior<Mesh> {
  37803. private static _virtualScene;
  37804. private _ownerNode;
  37805. private _sceneRenderObserver;
  37806. private _scene;
  37807. private _targetPosition;
  37808. private _virtualOriginMesh;
  37809. private _virtualDragMesh;
  37810. private _pointerObserver;
  37811. private _moving;
  37812. private _startingOrientation;
  37813. /**
  37814. * 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)
  37815. */
  37816. private zDragFactor;
  37817. /**
  37818. * If the object should rotate to face the drag origin
  37819. */
  37820. rotateDraggedObject: boolean;
  37821. /**
  37822. * If the behavior is currently in a dragging state
  37823. */
  37824. dragging: boolean;
  37825. /**
  37826. * 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)
  37827. */
  37828. dragDeltaRatio: number;
  37829. /**
  37830. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  37831. */
  37832. currentDraggingPointerID: number;
  37833. /**
  37834. * If camera controls should be detached during the drag
  37835. */
  37836. detachCameraControls: boolean;
  37837. /**
  37838. * Fires each time a drag starts
  37839. */
  37840. onDragStartObservable: Observable<{}>;
  37841. /**
  37842. * Fires each time a drag ends (eg. mouse release after drag)
  37843. */
  37844. onDragEndObservable: Observable<{}>;
  37845. /**
  37846. * 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
  37847. */
  37848. constructor();
  37849. /**
  37850. * The name of the behavior
  37851. */
  37852. readonly name: string;
  37853. /**
  37854. * Initializes the behavior
  37855. */
  37856. init(): void;
  37857. /**
  37858. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  37859. */
  37860. private readonly _pointerCamera;
  37861. /**
  37862. * Attaches the scale behavior the passed in mesh
  37863. * @param ownerNode The mesh that will be scaled around once attached
  37864. */
  37865. attach(ownerNode: Mesh): void;
  37866. /**
  37867. * Detaches the behavior from the mesh
  37868. */
  37869. detach(): void;
  37870. }
  37871. }
  37872. declare module "babylonjs/Behaviors/Meshes/index" {
  37873. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  37874. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  37875. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  37876. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  37877. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  37878. }
  37879. declare module "babylonjs/Behaviors/index" {
  37880. export * from "babylonjs/Behaviors/behavior";
  37881. export * from "babylonjs/Behaviors/Cameras/index";
  37882. export * from "babylonjs/Behaviors/Meshes/index";
  37883. }
  37884. declare module "babylonjs/Bones/boneIKController" {
  37885. import { Bone } from "babylonjs/Bones/bone";
  37886. import { Vector3 } from "babylonjs/Maths/math.vector";
  37887. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37888. import { Nullable } from "babylonjs/types";
  37889. /**
  37890. * Class used to apply inverse kinematics to bones
  37891. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  37892. */
  37893. export class BoneIKController {
  37894. private static _tmpVecs;
  37895. private static _tmpQuat;
  37896. private static _tmpMats;
  37897. /**
  37898. * Gets or sets the target mesh
  37899. */
  37900. targetMesh: AbstractMesh;
  37901. /** Gets or sets the mesh used as pole */
  37902. poleTargetMesh: AbstractMesh;
  37903. /**
  37904. * Gets or sets the bone used as pole
  37905. */
  37906. poleTargetBone: Nullable<Bone>;
  37907. /**
  37908. * Gets or sets the target position
  37909. */
  37910. targetPosition: Vector3;
  37911. /**
  37912. * Gets or sets the pole target position
  37913. */
  37914. poleTargetPosition: Vector3;
  37915. /**
  37916. * Gets or sets the pole target local offset
  37917. */
  37918. poleTargetLocalOffset: Vector3;
  37919. /**
  37920. * Gets or sets the pole angle
  37921. */
  37922. poleAngle: number;
  37923. /**
  37924. * Gets or sets the mesh associated with the controller
  37925. */
  37926. mesh: AbstractMesh;
  37927. /**
  37928. * 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)
  37929. */
  37930. slerpAmount: number;
  37931. private _bone1Quat;
  37932. private _bone1Mat;
  37933. private _bone2Ang;
  37934. private _bone1;
  37935. private _bone2;
  37936. private _bone1Length;
  37937. private _bone2Length;
  37938. private _maxAngle;
  37939. private _maxReach;
  37940. private _rightHandedSystem;
  37941. private _bendAxis;
  37942. private _slerping;
  37943. private _adjustRoll;
  37944. /**
  37945. * Gets or sets maximum allowed angle
  37946. */
  37947. maxAngle: number;
  37948. /**
  37949. * Creates a new BoneIKController
  37950. * @param mesh defines the mesh to control
  37951. * @param bone defines the bone to control
  37952. * @param options defines options to set up the controller
  37953. */
  37954. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  37955. targetMesh?: AbstractMesh;
  37956. poleTargetMesh?: AbstractMesh;
  37957. poleTargetBone?: Bone;
  37958. poleTargetLocalOffset?: Vector3;
  37959. poleAngle?: number;
  37960. bendAxis?: Vector3;
  37961. maxAngle?: number;
  37962. slerpAmount?: number;
  37963. });
  37964. private _setMaxAngle;
  37965. /**
  37966. * Force the controller to update the bones
  37967. */
  37968. update(): void;
  37969. }
  37970. }
  37971. declare module "babylonjs/Bones/boneLookController" {
  37972. import { Vector3 } from "babylonjs/Maths/math.vector";
  37973. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37974. import { Bone } from "babylonjs/Bones/bone";
  37975. import { Space } from "babylonjs/Maths/math.axis";
  37976. /**
  37977. * Class used to make a bone look toward a point in space
  37978. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  37979. */
  37980. export class BoneLookController {
  37981. private static _tmpVecs;
  37982. private static _tmpQuat;
  37983. private static _tmpMats;
  37984. /**
  37985. * The target Vector3 that the bone will look at
  37986. */
  37987. target: Vector3;
  37988. /**
  37989. * The mesh that the bone is attached to
  37990. */
  37991. mesh: AbstractMesh;
  37992. /**
  37993. * The bone that will be looking to the target
  37994. */
  37995. bone: Bone;
  37996. /**
  37997. * The up axis of the coordinate system that is used when the bone is rotated
  37998. */
  37999. upAxis: Vector3;
  38000. /**
  38001. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38002. */
  38003. upAxisSpace: Space;
  38004. /**
  38005. * Used to make an adjustment to the yaw of the bone
  38006. */
  38007. adjustYaw: number;
  38008. /**
  38009. * Used to make an adjustment to the pitch of the bone
  38010. */
  38011. adjustPitch: number;
  38012. /**
  38013. * Used to make an adjustment to the roll of the bone
  38014. */
  38015. adjustRoll: number;
  38016. /**
  38017. * 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)
  38018. */
  38019. slerpAmount: number;
  38020. private _minYaw;
  38021. private _maxYaw;
  38022. private _minPitch;
  38023. private _maxPitch;
  38024. private _minYawSin;
  38025. private _minYawCos;
  38026. private _maxYawSin;
  38027. private _maxYawCos;
  38028. private _midYawConstraint;
  38029. private _minPitchTan;
  38030. private _maxPitchTan;
  38031. private _boneQuat;
  38032. private _slerping;
  38033. private _transformYawPitch;
  38034. private _transformYawPitchInv;
  38035. private _firstFrameSkipped;
  38036. private _yawRange;
  38037. private _fowardAxis;
  38038. /**
  38039. * Gets or sets the minimum yaw angle that the bone can look to
  38040. */
  38041. minYaw: number;
  38042. /**
  38043. * Gets or sets the maximum yaw angle that the bone can look to
  38044. */
  38045. maxYaw: number;
  38046. /**
  38047. * Gets or sets the minimum pitch angle that the bone can look to
  38048. */
  38049. minPitch: number;
  38050. /**
  38051. * Gets or sets the maximum pitch angle that the bone can look to
  38052. */
  38053. maxPitch: number;
  38054. /**
  38055. * Create a BoneLookController
  38056. * @param mesh the mesh that the bone belongs to
  38057. * @param bone the bone that will be looking to the target
  38058. * @param target the target Vector3 to look at
  38059. * @param options optional settings:
  38060. * * maxYaw: the maximum angle the bone will yaw to
  38061. * * minYaw: the minimum angle the bone will yaw to
  38062. * * maxPitch: the maximum angle the bone will pitch to
  38063. * * minPitch: the minimum angle the bone will yaw to
  38064. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38065. * * upAxis: the up axis of the coordinate system
  38066. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38067. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38068. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38069. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38070. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38071. * * adjustRoll: used to make an adjustment to the roll of the bone
  38072. **/
  38073. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38074. maxYaw?: number;
  38075. minYaw?: number;
  38076. maxPitch?: number;
  38077. minPitch?: number;
  38078. slerpAmount?: number;
  38079. upAxis?: Vector3;
  38080. upAxisSpace?: Space;
  38081. yawAxis?: Vector3;
  38082. pitchAxis?: Vector3;
  38083. adjustYaw?: number;
  38084. adjustPitch?: number;
  38085. adjustRoll?: number;
  38086. });
  38087. /**
  38088. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  38089. */
  38090. update(): void;
  38091. private _getAngleDiff;
  38092. private _getAngleBetween;
  38093. private _isAngleBetween;
  38094. }
  38095. }
  38096. declare module "babylonjs/Bones/index" {
  38097. export * from "babylonjs/Bones/bone";
  38098. export * from "babylonjs/Bones/boneIKController";
  38099. export * from "babylonjs/Bones/boneLookController";
  38100. export * from "babylonjs/Bones/skeleton";
  38101. }
  38102. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  38103. import { Nullable } from "babylonjs/types";
  38104. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38105. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38106. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  38107. /**
  38108. * Manage the gamepad inputs to control an arc rotate camera.
  38109. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38110. */
  38111. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  38112. /**
  38113. * Defines the camera the input is attached to.
  38114. */
  38115. camera: ArcRotateCamera;
  38116. /**
  38117. * Defines the gamepad the input is gathering event from.
  38118. */
  38119. gamepad: Nullable<Gamepad>;
  38120. /**
  38121. * Defines the gamepad rotation sensiblity.
  38122. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  38123. */
  38124. gamepadRotationSensibility: number;
  38125. /**
  38126. * Defines the gamepad move sensiblity.
  38127. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  38128. */
  38129. gamepadMoveSensibility: number;
  38130. private _onGamepadConnectedObserver;
  38131. private _onGamepadDisconnectedObserver;
  38132. /**
  38133. * Attach the input controls to a specific dom element to get the input from.
  38134. * @param element Defines the element the controls should be listened from
  38135. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38136. */
  38137. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38138. /**
  38139. * Detach the current controls from the specified dom element.
  38140. * @param element Defines the element to stop listening the inputs from
  38141. */
  38142. detachControl(element: Nullable<HTMLElement>): void;
  38143. /**
  38144. * Update the current camera state depending on the inputs that have been used this frame.
  38145. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38146. */
  38147. checkInputs(): void;
  38148. /**
  38149. * Gets the class name of the current intput.
  38150. * @returns the class name
  38151. */
  38152. getClassName(): string;
  38153. /**
  38154. * Get the friendly name associated with the input class.
  38155. * @returns the input friendly name
  38156. */
  38157. getSimpleName(): string;
  38158. }
  38159. }
  38160. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  38161. import { Nullable } from "babylonjs/types";
  38162. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38163. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38164. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  38165. interface ArcRotateCameraInputsManager {
  38166. /**
  38167. * Add orientation input support to the input manager.
  38168. * @returns the current input manager
  38169. */
  38170. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  38171. }
  38172. }
  38173. /**
  38174. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  38175. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38176. */
  38177. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  38178. /**
  38179. * Defines the camera the input is attached to.
  38180. */
  38181. camera: ArcRotateCamera;
  38182. /**
  38183. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  38184. */
  38185. alphaCorrection: number;
  38186. /**
  38187. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  38188. */
  38189. gammaCorrection: number;
  38190. private _alpha;
  38191. private _gamma;
  38192. private _dirty;
  38193. private _deviceOrientationHandler;
  38194. /**
  38195. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  38196. */
  38197. constructor();
  38198. /**
  38199. * Attach the input controls to a specific dom element to get the input from.
  38200. * @param element Defines the element the controls should be listened from
  38201. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38202. */
  38203. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38204. /** @hidden */
  38205. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  38206. /**
  38207. * Update the current camera state depending on the inputs that have been used this frame.
  38208. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38209. */
  38210. checkInputs(): void;
  38211. /**
  38212. * Detach the current controls from the specified dom element.
  38213. * @param element Defines the element to stop listening the inputs from
  38214. */
  38215. detachControl(element: Nullable<HTMLElement>): void;
  38216. /**
  38217. * Gets the class name of the current intput.
  38218. * @returns the class name
  38219. */
  38220. getClassName(): string;
  38221. /**
  38222. * Get the friendly name associated with the input class.
  38223. * @returns the input friendly name
  38224. */
  38225. getSimpleName(): string;
  38226. }
  38227. }
  38228. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  38229. import { Nullable } from "babylonjs/types";
  38230. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38231. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38232. /**
  38233. * Listen to mouse events to control the camera.
  38234. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38235. */
  38236. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  38237. /**
  38238. * Defines the camera the input is attached to.
  38239. */
  38240. camera: FlyCamera;
  38241. /**
  38242. * Defines if touch is enabled. (Default is true.)
  38243. */
  38244. touchEnabled: boolean;
  38245. /**
  38246. * Defines the buttons associated with the input to handle camera rotation.
  38247. */
  38248. buttons: number[];
  38249. /**
  38250. * Assign buttons for Yaw control.
  38251. */
  38252. buttonsYaw: number[];
  38253. /**
  38254. * Assign buttons for Pitch control.
  38255. */
  38256. buttonsPitch: number[];
  38257. /**
  38258. * Assign buttons for Roll control.
  38259. */
  38260. buttonsRoll: number[];
  38261. /**
  38262. * Detect if any button is being pressed while mouse is moved.
  38263. * -1 = Mouse locked.
  38264. * 0 = Left button.
  38265. * 1 = Middle Button.
  38266. * 2 = Right Button.
  38267. */
  38268. activeButton: number;
  38269. /**
  38270. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  38271. * Higher values reduce its sensitivity.
  38272. */
  38273. angularSensibility: number;
  38274. private _mousemoveCallback;
  38275. private _observer;
  38276. private _rollObserver;
  38277. private previousPosition;
  38278. private noPreventDefault;
  38279. private element;
  38280. /**
  38281. * Listen to mouse events to control the camera.
  38282. * @param touchEnabled Define if touch is enabled. (Default is true.)
  38283. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38284. */
  38285. constructor(touchEnabled?: boolean);
  38286. /**
  38287. * Attach the mouse control to the HTML DOM element.
  38288. * @param element Defines the element that listens to the input events.
  38289. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  38290. */
  38291. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38292. /**
  38293. * Detach the current controls from the specified dom element.
  38294. * @param element Defines the element to stop listening the inputs from
  38295. */
  38296. detachControl(element: Nullable<HTMLElement>): void;
  38297. /**
  38298. * Gets the class name of the current input.
  38299. * @returns the class name.
  38300. */
  38301. getClassName(): string;
  38302. /**
  38303. * Get the friendly name associated with the input class.
  38304. * @returns the input's friendly name.
  38305. */
  38306. getSimpleName(): string;
  38307. private _pointerInput;
  38308. private _onMouseMove;
  38309. /**
  38310. * Rotate camera by mouse offset.
  38311. */
  38312. private rotateCamera;
  38313. }
  38314. }
  38315. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  38316. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38317. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  38318. /**
  38319. * Default Inputs manager for the FlyCamera.
  38320. * It groups all the default supported inputs for ease of use.
  38321. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38322. */
  38323. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  38324. /**
  38325. * Instantiates a new FlyCameraInputsManager.
  38326. * @param camera Defines the camera the inputs belong to.
  38327. */
  38328. constructor(camera: FlyCamera);
  38329. /**
  38330. * Add keyboard input support to the input manager.
  38331. * @returns the new FlyCameraKeyboardMoveInput().
  38332. */
  38333. addKeyboard(): FlyCameraInputsManager;
  38334. /**
  38335. * Add mouse input support to the input manager.
  38336. * @param touchEnabled Enable touch screen support.
  38337. * @returns the new FlyCameraMouseInput().
  38338. */
  38339. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  38340. }
  38341. }
  38342. declare module "babylonjs/Cameras/flyCamera" {
  38343. import { Scene } from "babylonjs/scene";
  38344. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  38345. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38346. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  38347. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  38348. /**
  38349. * This is a flying camera, designed for 3D movement and rotation in all directions,
  38350. * such as in a 3D Space Shooter or a Flight Simulator.
  38351. */
  38352. export class FlyCamera extends TargetCamera {
  38353. /**
  38354. * Define the collision ellipsoid of the camera.
  38355. * This is helpful for simulating a camera body, like a player's body.
  38356. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38357. */
  38358. ellipsoid: Vector3;
  38359. /**
  38360. * Define an offset for the position of the ellipsoid around the camera.
  38361. * This can be helpful if the camera is attached away from the player's body center,
  38362. * such as at its head.
  38363. */
  38364. ellipsoidOffset: Vector3;
  38365. /**
  38366. * Enable or disable collisions of the camera with the rest of the scene objects.
  38367. */
  38368. checkCollisions: boolean;
  38369. /**
  38370. * Enable or disable gravity on the camera.
  38371. */
  38372. applyGravity: boolean;
  38373. /**
  38374. * Define the current direction the camera is moving to.
  38375. */
  38376. cameraDirection: Vector3;
  38377. /**
  38378. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  38379. * This overrides and empties cameraRotation.
  38380. */
  38381. rotationQuaternion: Quaternion;
  38382. /**
  38383. * Track Roll to maintain the wanted Rolling when looking around.
  38384. */
  38385. _trackRoll: number;
  38386. /**
  38387. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  38388. */
  38389. rollCorrect: number;
  38390. /**
  38391. * Mimic a banked turn, Rolling the camera when Yawing.
  38392. * It's recommended to use rollCorrect = 10 for faster banking correction.
  38393. */
  38394. bankedTurn: boolean;
  38395. /**
  38396. * Limit in radians for how much Roll banking will add. (Default: 90°)
  38397. */
  38398. bankedTurnLimit: number;
  38399. /**
  38400. * Value of 0 disables the banked Roll.
  38401. * Value of 1 is equal to the Yaw angle in radians.
  38402. */
  38403. bankedTurnMultiplier: number;
  38404. /**
  38405. * The inputs manager loads all the input sources, such as keyboard and mouse.
  38406. */
  38407. inputs: FlyCameraInputsManager;
  38408. /**
  38409. * Gets the input sensibility for mouse input.
  38410. * Higher values reduce sensitivity.
  38411. */
  38412. /**
  38413. * Sets the input sensibility for a mouse input.
  38414. * Higher values reduce sensitivity.
  38415. */
  38416. angularSensibility: number;
  38417. /**
  38418. * Get the keys for camera movement forward.
  38419. */
  38420. /**
  38421. * Set the keys for camera movement forward.
  38422. */
  38423. keysForward: number[];
  38424. /**
  38425. * Get the keys for camera movement backward.
  38426. */
  38427. keysBackward: number[];
  38428. /**
  38429. * Get the keys for camera movement up.
  38430. */
  38431. /**
  38432. * Set the keys for camera movement up.
  38433. */
  38434. keysUp: number[];
  38435. /**
  38436. * Get the keys for camera movement down.
  38437. */
  38438. /**
  38439. * Set the keys for camera movement down.
  38440. */
  38441. keysDown: number[];
  38442. /**
  38443. * Get the keys for camera movement left.
  38444. */
  38445. /**
  38446. * Set the keys for camera movement left.
  38447. */
  38448. keysLeft: number[];
  38449. /**
  38450. * Set the keys for camera movement right.
  38451. */
  38452. /**
  38453. * Set the keys for camera movement right.
  38454. */
  38455. keysRight: number[];
  38456. /**
  38457. * Event raised when the camera collides with a mesh in the scene.
  38458. */
  38459. onCollide: (collidedMesh: AbstractMesh) => void;
  38460. private _collider;
  38461. private _needMoveForGravity;
  38462. private _oldPosition;
  38463. private _diffPosition;
  38464. private _newPosition;
  38465. /** @hidden */
  38466. _localDirection: Vector3;
  38467. /** @hidden */
  38468. _transformedDirection: Vector3;
  38469. /**
  38470. * Instantiates a FlyCamera.
  38471. * This is a flying camera, designed for 3D movement and rotation in all directions,
  38472. * such as in a 3D Space Shooter or a Flight Simulator.
  38473. * @param name Define the name of the camera in the scene.
  38474. * @param position Define the starting position of the camera in the scene.
  38475. * @param scene Define the scene the camera belongs to.
  38476. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  38477. */
  38478. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  38479. /**
  38480. * Attach a control to the HTML DOM element.
  38481. * @param element Defines the element that listens to the input events.
  38482. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  38483. */
  38484. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38485. /**
  38486. * Detach a control from the HTML DOM element.
  38487. * The camera will stop reacting to that input.
  38488. * @param element Defines the element that listens to the input events.
  38489. */
  38490. detachControl(element: HTMLElement): void;
  38491. private _collisionMask;
  38492. /**
  38493. * Get the mask that the camera ignores in collision events.
  38494. */
  38495. /**
  38496. * Set the mask that the camera ignores in collision events.
  38497. */
  38498. collisionMask: number;
  38499. /** @hidden */
  38500. _collideWithWorld(displacement: Vector3): void;
  38501. /** @hidden */
  38502. private _onCollisionPositionChange;
  38503. /** @hidden */
  38504. _checkInputs(): void;
  38505. /** @hidden */
  38506. _decideIfNeedsToMove(): boolean;
  38507. /** @hidden */
  38508. _updatePosition(): void;
  38509. /**
  38510. * Restore the Roll to its target value at the rate specified.
  38511. * @param rate - Higher means slower restoring.
  38512. * @hidden
  38513. */
  38514. restoreRoll(rate: number): void;
  38515. /**
  38516. * Destroy the camera and release the current resources held by it.
  38517. */
  38518. dispose(): void;
  38519. /**
  38520. * Get the current object class name.
  38521. * @returns the class name.
  38522. */
  38523. getClassName(): string;
  38524. }
  38525. }
  38526. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  38527. import { Nullable } from "babylonjs/types";
  38528. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38529. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38530. /**
  38531. * Listen to keyboard events to control the camera.
  38532. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38533. */
  38534. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  38535. /**
  38536. * Defines the camera the input is attached to.
  38537. */
  38538. camera: FlyCamera;
  38539. /**
  38540. * The list of keyboard keys used to control the forward move of the camera.
  38541. */
  38542. keysForward: number[];
  38543. /**
  38544. * The list of keyboard keys used to control the backward move of the camera.
  38545. */
  38546. keysBackward: number[];
  38547. /**
  38548. * The list of keyboard keys used to control the forward move of the camera.
  38549. */
  38550. keysUp: number[];
  38551. /**
  38552. * The list of keyboard keys used to control the backward move of the camera.
  38553. */
  38554. keysDown: number[];
  38555. /**
  38556. * The list of keyboard keys used to control the right strafe move of the camera.
  38557. */
  38558. keysRight: number[];
  38559. /**
  38560. * The list of keyboard keys used to control the left strafe move of the camera.
  38561. */
  38562. keysLeft: number[];
  38563. private _keys;
  38564. private _onCanvasBlurObserver;
  38565. private _onKeyboardObserver;
  38566. private _engine;
  38567. private _scene;
  38568. /**
  38569. * Attach the input controls to a specific dom element to get the input from.
  38570. * @param element Defines the element the controls should be listened from
  38571. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38572. */
  38573. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38574. /**
  38575. * Detach the current controls from the specified dom element.
  38576. * @param element Defines the element to stop listening the inputs from
  38577. */
  38578. detachControl(element: Nullable<HTMLElement>): void;
  38579. /**
  38580. * Gets the class name of the current intput.
  38581. * @returns the class name
  38582. */
  38583. getClassName(): string;
  38584. /** @hidden */
  38585. _onLostFocus(e: FocusEvent): void;
  38586. /**
  38587. * Get the friendly name associated with the input class.
  38588. * @returns the input friendly name
  38589. */
  38590. getSimpleName(): string;
  38591. /**
  38592. * Update the current camera state depending on the inputs that have been used this frame.
  38593. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38594. */
  38595. checkInputs(): void;
  38596. }
  38597. }
  38598. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  38599. import { Nullable } from "babylonjs/types";
  38600. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38601. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38602. /**
  38603. * Manage the mouse wheel inputs to control a follow camera.
  38604. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38605. */
  38606. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  38607. /**
  38608. * Defines the camera the input is attached to.
  38609. */
  38610. camera: FollowCamera;
  38611. /**
  38612. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  38613. */
  38614. axisControlRadius: boolean;
  38615. /**
  38616. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  38617. */
  38618. axisControlHeight: boolean;
  38619. /**
  38620. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  38621. */
  38622. axisControlRotation: boolean;
  38623. /**
  38624. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  38625. * relation to mouseWheel events.
  38626. */
  38627. wheelPrecision: number;
  38628. /**
  38629. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  38630. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  38631. */
  38632. wheelDeltaPercentage: number;
  38633. private _wheel;
  38634. private _observer;
  38635. /**
  38636. * Attach the input controls to a specific dom element to get the input from.
  38637. * @param element Defines the element the controls should be listened from
  38638. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38639. */
  38640. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38641. /**
  38642. * Detach the current controls from the specified dom element.
  38643. * @param element Defines the element to stop listening the inputs from
  38644. */
  38645. detachControl(element: Nullable<HTMLElement>): void;
  38646. /**
  38647. * Gets the class name of the current intput.
  38648. * @returns the class name
  38649. */
  38650. getClassName(): string;
  38651. /**
  38652. * Get the friendly name associated with the input class.
  38653. * @returns the input friendly name
  38654. */
  38655. getSimpleName(): string;
  38656. }
  38657. }
  38658. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  38659. import { Nullable } from "babylonjs/types";
  38660. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38661. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  38662. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  38663. /**
  38664. * Manage the pointers inputs to control an follow camera.
  38665. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38666. */
  38667. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  38668. /**
  38669. * Defines the camera the input is attached to.
  38670. */
  38671. camera: FollowCamera;
  38672. /**
  38673. * Gets the class name of the current input.
  38674. * @returns the class name
  38675. */
  38676. getClassName(): string;
  38677. /**
  38678. * Defines the pointer angular sensibility along the X axis or how fast is
  38679. * the camera rotating.
  38680. * A negative number will reverse the axis direction.
  38681. */
  38682. angularSensibilityX: number;
  38683. /**
  38684. * Defines the pointer angular sensibility along the Y axis or how fast is
  38685. * the camera rotating.
  38686. * A negative number will reverse the axis direction.
  38687. */
  38688. angularSensibilityY: number;
  38689. /**
  38690. * Defines the pointer pinch precision or how fast is the camera zooming.
  38691. * A negative number will reverse the axis direction.
  38692. */
  38693. pinchPrecision: number;
  38694. /**
  38695. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  38696. * from 0.
  38697. * It defines the percentage of current camera.radius to use as delta when
  38698. * pinch zoom is used.
  38699. */
  38700. pinchDeltaPercentage: number;
  38701. /**
  38702. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  38703. */
  38704. axisXControlRadius: boolean;
  38705. /**
  38706. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  38707. */
  38708. axisXControlHeight: boolean;
  38709. /**
  38710. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  38711. */
  38712. axisXControlRotation: boolean;
  38713. /**
  38714. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  38715. */
  38716. axisYControlRadius: boolean;
  38717. /**
  38718. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  38719. */
  38720. axisYControlHeight: boolean;
  38721. /**
  38722. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  38723. */
  38724. axisYControlRotation: boolean;
  38725. /**
  38726. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  38727. */
  38728. axisPinchControlRadius: boolean;
  38729. /**
  38730. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  38731. */
  38732. axisPinchControlHeight: boolean;
  38733. /**
  38734. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  38735. */
  38736. axisPinchControlRotation: boolean;
  38737. /**
  38738. * Log error messages if basic misconfiguration has occurred.
  38739. */
  38740. warningEnable: boolean;
  38741. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  38742. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  38743. private _warningCounter;
  38744. private _warning;
  38745. }
  38746. }
  38747. declare module "babylonjs/Cameras/followCameraInputsManager" {
  38748. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  38749. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38750. /**
  38751. * Default Inputs manager for the FollowCamera.
  38752. * It groups all the default supported inputs for ease of use.
  38753. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38754. */
  38755. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  38756. /**
  38757. * Instantiates a new FollowCameraInputsManager.
  38758. * @param camera Defines the camera the inputs belong to
  38759. */
  38760. constructor(camera: FollowCamera);
  38761. /**
  38762. * Add keyboard input support to the input manager.
  38763. * @returns the current input manager
  38764. */
  38765. addKeyboard(): FollowCameraInputsManager;
  38766. /**
  38767. * Add mouse wheel input support to the input manager.
  38768. * @returns the current input manager
  38769. */
  38770. addMouseWheel(): FollowCameraInputsManager;
  38771. /**
  38772. * Add pointers input support to the input manager.
  38773. * @returns the current input manager
  38774. */
  38775. addPointers(): FollowCameraInputsManager;
  38776. /**
  38777. * Add orientation input support to the input manager.
  38778. * @returns the current input manager
  38779. */
  38780. addVRDeviceOrientation(): FollowCameraInputsManager;
  38781. }
  38782. }
  38783. declare module "babylonjs/Cameras/followCamera" {
  38784. import { Nullable } from "babylonjs/types";
  38785. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  38786. import { Scene } from "babylonjs/scene";
  38787. import { Vector3 } from "babylonjs/Maths/math.vector";
  38788. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38789. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  38790. /**
  38791. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  38792. * an arc rotate version arcFollowCamera are available.
  38793. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  38794. */
  38795. export class FollowCamera extends TargetCamera {
  38796. /**
  38797. * Distance the follow camera should follow an object at
  38798. */
  38799. radius: number;
  38800. /**
  38801. * Minimum allowed distance of the camera to the axis of rotation
  38802. * (The camera can not get closer).
  38803. * This can help limiting how the Camera is able to move in the scene.
  38804. */
  38805. lowerRadiusLimit: Nullable<number>;
  38806. /**
  38807. * Maximum allowed distance of the camera to the axis of rotation
  38808. * (The camera can not get further).
  38809. * This can help limiting how the Camera is able to move in the scene.
  38810. */
  38811. upperRadiusLimit: Nullable<number>;
  38812. /**
  38813. * Define a rotation offset between the camera and the object it follows
  38814. */
  38815. rotationOffset: number;
  38816. /**
  38817. * Minimum allowed angle to camera position relative to target object.
  38818. * This can help limiting how the Camera is able to move in the scene.
  38819. */
  38820. lowerRotationOffsetLimit: Nullable<number>;
  38821. /**
  38822. * Maximum allowed angle to camera position relative to target object.
  38823. * This can help limiting how the Camera is able to move in the scene.
  38824. */
  38825. upperRotationOffsetLimit: Nullable<number>;
  38826. /**
  38827. * Define a height offset between the camera and the object it follows.
  38828. * It can help following an object from the top (like a car chaing a plane)
  38829. */
  38830. heightOffset: number;
  38831. /**
  38832. * Minimum allowed height of camera position relative to target object.
  38833. * This can help limiting how the Camera is able to move in the scene.
  38834. */
  38835. lowerHeightOffsetLimit: Nullable<number>;
  38836. /**
  38837. * Maximum allowed height of camera position relative to target object.
  38838. * This can help limiting how the Camera is able to move in the scene.
  38839. */
  38840. upperHeightOffsetLimit: Nullable<number>;
  38841. /**
  38842. * Define how fast the camera can accelerate to follow it s target.
  38843. */
  38844. cameraAcceleration: number;
  38845. /**
  38846. * Define the speed limit of the camera following an object.
  38847. */
  38848. maxCameraSpeed: number;
  38849. /**
  38850. * Define the target of the camera.
  38851. */
  38852. lockedTarget: Nullable<AbstractMesh>;
  38853. /**
  38854. * Defines the input associated with the camera.
  38855. */
  38856. inputs: FollowCameraInputsManager;
  38857. /**
  38858. * Instantiates the follow camera.
  38859. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  38860. * @param name Define the name of the camera in the scene
  38861. * @param position Define the position of the camera
  38862. * @param scene Define the scene the camera belong to
  38863. * @param lockedTarget Define the target of the camera
  38864. */
  38865. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  38866. private _follow;
  38867. /**
  38868. * Attached controls to the current camera.
  38869. * @param element Defines the element the controls should be listened from
  38870. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38871. */
  38872. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38873. /**
  38874. * Detach the current controls from the camera.
  38875. * The camera will stop reacting to inputs.
  38876. * @param element Defines the element to stop listening the inputs from
  38877. */
  38878. detachControl(element: HTMLElement): void;
  38879. /** @hidden */
  38880. _checkInputs(): void;
  38881. private _checkLimits;
  38882. /**
  38883. * Gets the camera class name.
  38884. * @returns the class name
  38885. */
  38886. getClassName(): string;
  38887. }
  38888. /**
  38889. * Arc Rotate version of the follow camera.
  38890. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  38891. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  38892. */
  38893. export class ArcFollowCamera extends TargetCamera {
  38894. /** The longitudinal angle of the camera */
  38895. alpha: number;
  38896. /** The latitudinal angle of the camera */
  38897. beta: number;
  38898. /** The radius of the camera from its target */
  38899. radius: number;
  38900. /** Define the camera target (the messh it should follow) */
  38901. target: Nullable<AbstractMesh>;
  38902. private _cartesianCoordinates;
  38903. /**
  38904. * Instantiates a new ArcFollowCamera
  38905. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  38906. * @param name Define the name of the camera
  38907. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  38908. * @param beta Define the rotation angle of the camera around the elevation axis
  38909. * @param radius Define the radius of the camera from its target point
  38910. * @param target Define the target of the camera
  38911. * @param scene Define the scene the camera belongs to
  38912. */
  38913. constructor(name: string,
  38914. /** The longitudinal angle of the camera */
  38915. alpha: number,
  38916. /** The latitudinal angle of the camera */
  38917. beta: number,
  38918. /** The radius of the camera from its target */
  38919. radius: number,
  38920. /** Define the camera target (the messh it should follow) */
  38921. target: Nullable<AbstractMesh>, scene: Scene);
  38922. private _follow;
  38923. /** @hidden */
  38924. _checkInputs(): void;
  38925. /**
  38926. * Returns the class name of the object.
  38927. * It is mostly used internally for serialization purposes.
  38928. */
  38929. getClassName(): string;
  38930. }
  38931. }
  38932. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  38933. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38934. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  38935. import { Nullable } from "babylonjs/types";
  38936. /**
  38937. * Manage the keyboard inputs to control the movement of a follow camera.
  38938. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38939. */
  38940. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  38941. /**
  38942. * Defines the camera the input is attached to.
  38943. */
  38944. camera: FollowCamera;
  38945. /**
  38946. * Defines the list of key codes associated with the up action (increase heightOffset)
  38947. */
  38948. keysHeightOffsetIncr: number[];
  38949. /**
  38950. * Defines the list of key codes associated with the down action (decrease heightOffset)
  38951. */
  38952. keysHeightOffsetDecr: number[];
  38953. /**
  38954. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  38955. */
  38956. keysHeightOffsetModifierAlt: boolean;
  38957. /**
  38958. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  38959. */
  38960. keysHeightOffsetModifierCtrl: boolean;
  38961. /**
  38962. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  38963. */
  38964. keysHeightOffsetModifierShift: boolean;
  38965. /**
  38966. * Defines the list of key codes associated with the left action (increase rotationOffset)
  38967. */
  38968. keysRotationOffsetIncr: number[];
  38969. /**
  38970. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  38971. */
  38972. keysRotationOffsetDecr: number[];
  38973. /**
  38974. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  38975. */
  38976. keysRotationOffsetModifierAlt: boolean;
  38977. /**
  38978. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  38979. */
  38980. keysRotationOffsetModifierCtrl: boolean;
  38981. /**
  38982. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  38983. */
  38984. keysRotationOffsetModifierShift: boolean;
  38985. /**
  38986. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  38987. */
  38988. keysRadiusIncr: number[];
  38989. /**
  38990. * Defines the list of key codes associated with the zoom-out action (increase radius)
  38991. */
  38992. keysRadiusDecr: number[];
  38993. /**
  38994. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  38995. */
  38996. keysRadiusModifierAlt: boolean;
  38997. /**
  38998. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  38999. */
  39000. keysRadiusModifierCtrl: boolean;
  39001. /**
  39002. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39003. */
  39004. keysRadiusModifierShift: boolean;
  39005. /**
  39006. * Defines the rate of change of heightOffset.
  39007. */
  39008. heightSensibility: number;
  39009. /**
  39010. * Defines the rate of change of rotationOffset.
  39011. */
  39012. rotationSensibility: number;
  39013. /**
  39014. * Defines the rate of change of radius.
  39015. */
  39016. radiusSensibility: number;
  39017. private _keys;
  39018. private _ctrlPressed;
  39019. private _altPressed;
  39020. private _shiftPressed;
  39021. private _onCanvasBlurObserver;
  39022. private _onKeyboardObserver;
  39023. private _engine;
  39024. private _scene;
  39025. /**
  39026. * Attach the input controls to a specific dom element to get the input from.
  39027. * @param element Defines the element the controls should be listened from
  39028. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39029. */
  39030. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39031. /**
  39032. * Detach the current controls from the specified dom element.
  39033. * @param element Defines the element to stop listening the inputs from
  39034. */
  39035. detachControl(element: Nullable<HTMLElement>): void;
  39036. /**
  39037. * Update the current camera state depending on the inputs that have been used this frame.
  39038. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39039. */
  39040. checkInputs(): void;
  39041. /**
  39042. * Gets the class name of the current input.
  39043. * @returns the class name
  39044. */
  39045. getClassName(): string;
  39046. /**
  39047. * Get the friendly name associated with the input class.
  39048. * @returns the input friendly name
  39049. */
  39050. getSimpleName(): string;
  39051. /**
  39052. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39053. * allow modification of the heightOffset value.
  39054. */
  39055. private _modifierHeightOffset;
  39056. /**
  39057. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39058. * allow modification of the rotationOffset value.
  39059. */
  39060. private _modifierRotationOffset;
  39061. /**
  39062. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39063. * allow modification of the radius value.
  39064. */
  39065. private _modifierRadius;
  39066. }
  39067. }
  39068. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39069. import { Nullable } from "babylonjs/types";
  39070. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39071. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39072. import { Observable } from "babylonjs/Misc/observable";
  39073. module "babylonjs/Cameras/freeCameraInputsManager" {
  39074. interface FreeCameraInputsManager {
  39075. /**
  39076. * @hidden
  39077. */
  39078. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  39079. /**
  39080. * Add orientation input support to the input manager.
  39081. * @returns the current input manager
  39082. */
  39083. addDeviceOrientation(): FreeCameraInputsManager;
  39084. }
  39085. }
  39086. /**
  39087. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  39088. * Screen rotation is taken into account.
  39089. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39090. */
  39091. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  39092. private _camera;
  39093. private _screenOrientationAngle;
  39094. private _constantTranform;
  39095. private _screenQuaternion;
  39096. private _alpha;
  39097. private _beta;
  39098. private _gamma;
  39099. /**
  39100. * Can be used to detect if a device orientation sensor is availible on a device
  39101. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  39102. * @returns a promise that will resolve on orientation change
  39103. */
  39104. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  39105. /**
  39106. * @hidden
  39107. */
  39108. _onDeviceOrientationChangedObservable: Observable<void>;
  39109. /**
  39110. * Instantiates a new input
  39111. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39112. */
  39113. constructor();
  39114. /**
  39115. * Define the camera controlled by the input.
  39116. */
  39117. camera: FreeCamera;
  39118. /**
  39119. * Attach the input controls to a specific dom element to get the input from.
  39120. * @param element Defines the element the controls should be listened from
  39121. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39122. */
  39123. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39124. private _orientationChanged;
  39125. private _deviceOrientation;
  39126. /**
  39127. * Detach the current controls from the specified dom element.
  39128. * @param element Defines the element to stop listening the inputs from
  39129. */
  39130. detachControl(element: Nullable<HTMLElement>): void;
  39131. /**
  39132. * Update the current camera state depending on the inputs that have been used this frame.
  39133. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39134. */
  39135. checkInputs(): void;
  39136. /**
  39137. * Gets the class name of the current intput.
  39138. * @returns the class name
  39139. */
  39140. getClassName(): string;
  39141. /**
  39142. * Get the friendly name associated with the input class.
  39143. * @returns the input friendly name
  39144. */
  39145. getSimpleName(): string;
  39146. }
  39147. }
  39148. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  39149. import { Nullable } from "babylonjs/types";
  39150. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39151. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39152. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39153. /**
  39154. * Manage the gamepad inputs to control a free camera.
  39155. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39156. */
  39157. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  39158. /**
  39159. * Define the camera the input is attached to.
  39160. */
  39161. camera: FreeCamera;
  39162. /**
  39163. * Define the Gamepad controlling the input
  39164. */
  39165. gamepad: Nullable<Gamepad>;
  39166. /**
  39167. * Defines the gamepad rotation sensiblity.
  39168. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39169. */
  39170. gamepadAngularSensibility: number;
  39171. /**
  39172. * Defines the gamepad move sensiblity.
  39173. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39174. */
  39175. gamepadMoveSensibility: number;
  39176. private _onGamepadConnectedObserver;
  39177. private _onGamepadDisconnectedObserver;
  39178. private _cameraTransform;
  39179. private _deltaTransform;
  39180. private _vector3;
  39181. private _vector2;
  39182. /**
  39183. * Attach the input controls to a specific dom element to get the input from.
  39184. * @param element Defines the element the controls should be listened from
  39185. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39186. */
  39187. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39188. /**
  39189. * Detach the current controls from the specified dom element.
  39190. * @param element Defines the element to stop listening the inputs from
  39191. */
  39192. detachControl(element: Nullable<HTMLElement>): void;
  39193. /**
  39194. * Update the current camera state depending on the inputs that have been used this frame.
  39195. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39196. */
  39197. checkInputs(): void;
  39198. /**
  39199. * Gets the class name of the current intput.
  39200. * @returns the class name
  39201. */
  39202. getClassName(): string;
  39203. /**
  39204. * Get the friendly name associated with the input class.
  39205. * @returns the input friendly name
  39206. */
  39207. getSimpleName(): string;
  39208. }
  39209. }
  39210. declare module "babylonjs/Misc/virtualJoystick" {
  39211. import { Nullable } from "babylonjs/types";
  39212. import { Vector3 } from "babylonjs/Maths/math.vector";
  39213. /**
  39214. * Defines the potential axis of a Joystick
  39215. */
  39216. export enum JoystickAxis {
  39217. /** X axis */
  39218. X = 0,
  39219. /** Y axis */
  39220. Y = 1,
  39221. /** Z axis */
  39222. Z = 2
  39223. }
  39224. /**
  39225. * Class used to define virtual joystick (used in touch mode)
  39226. */
  39227. export class VirtualJoystick {
  39228. /**
  39229. * Gets or sets a boolean indicating that left and right values must be inverted
  39230. */
  39231. reverseLeftRight: boolean;
  39232. /**
  39233. * Gets or sets a boolean indicating that up and down values must be inverted
  39234. */
  39235. reverseUpDown: boolean;
  39236. /**
  39237. * Gets the offset value for the position (ie. the change of the position value)
  39238. */
  39239. deltaPosition: Vector3;
  39240. /**
  39241. * Gets a boolean indicating if the virtual joystick was pressed
  39242. */
  39243. pressed: boolean;
  39244. /**
  39245. * Canvas the virtual joystick will render onto, default z-index of this is 5
  39246. */
  39247. static Canvas: Nullable<HTMLCanvasElement>;
  39248. private static _globalJoystickIndex;
  39249. private static vjCanvasContext;
  39250. private static vjCanvasWidth;
  39251. private static vjCanvasHeight;
  39252. private static halfWidth;
  39253. private _action;
  39254. private _axisTargetedByLeftAndRight;
  39255. private _axisTargetedByUpAndDown;
  39256. private _joystickSensibility;
  39257. private _inversedSensibility;
  39258. private _joystickPointerID;
  39259. private _joystickColor;
  39260. private _joystickPointerPos;
  39261. private _joystickPreviousPointerPos;
  39262. private _joystickPointerStartPos;
  39263. private _deltaJoystickVector;
  39264. private _leftJoystick;
  39265. private _touches;
  39266. private _onPointerDownHandlerRef;
  39267. private _onPointerMoveHandlerRef;
  39268. private _onPointerUpHandlerRef;
  39269. private _onResize;
  39270. /**
  39271. * Creates a new virtual joystick
  39272. * @param leftJoystick defines that the joystick is for left hand (false by default)
  39273. */
  39274. constructor(leftJoystick?: boolean);
  39275. /**
  39276. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  39277. * @param newJoystickSensibility defines the new sensibility
  39278. */
  39279. setJoystickSensibility(newJoystickSensibility: number): void;
  39280. private _onPointerDown;
  39281. private _onPointerMove;
  39282. private _onPointerUp;
  39283. /**
  39284. * Change the color of the virtual joystick
  39285. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  39286. */
  39287. setJoystickColor(newColor: string): void;
  39288. /**
  39289. * Defines a callback to call when the joystick is touched
  39290. * @param action defines the callback
  39291. */
  39292. setActionOnTouch(action: () => any): void;
  39293. /**
  39294. * Defines which axis you'd like to control for left & right
  39295. * @param axis defines the axis to use
  39296. */
  39297. setAxisForLeftRight(axis: JoystickAxis): void;
  39298. /**
  39299. * Defines which axis you'd like to control for up & down
  39300. * @param axis defines the axis to use
  39301. */
  39302. setAxisForUpDown(axis: JoystickAxis): void;
  39303. private _drawVirtualJoystick;
  39304. /**
  39305. * Release internal HTML canvas
  39306. */
  39307. releaseCanvas(): void;
  39308. }
  39309. }
  39310. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  39311. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  39312. import { Nullable } from "babylonjs/types";
  39313. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39314. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39315. module "babylonjs/Cameras/freeCameraInputsManager" {
  39316. interface FreeCameraInputsManager {
  39317. /**
  39318. * Add virtual joystick input support to the input manager.
  39319. * @returns the current input manager
  39320. */
  39321. addVirtualJoystick(): FreeCameraInputsManager;
  39322. }
  39323. }
  39324. /**
  39325. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  39326. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39327. */
  39328. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  39329. /**
  39330. * Defines the camera the input is attached to.
  39331. */
  39332. camera: FreeCamera;
  39333. private _leftjoystick;
  39334. private _rightjoystick;
  39335. /**
  39336. * Gets the left stick of the virtual joystick.
  39337. * @returns The virtual Joystick
  39338. */
  39339. getLeftJoystick(): VirtualJoystick;
  39340. /**
  39341. * Gets the right stick of the virtual joystick.
  39342. * @returns The virtual Joystick
  39343. */
  39344. getRightJoystick(): VirtualJoystick;
  39345. /**
  39346. * Update the current camera state depending on the inputs that have been used this frame.
  39347. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39348. */
  39349. checkInputs(): void;
  39350. /**
  39351. * Attach the input controls to a specific dom element to get the input from.
  39352. * @param element Defines the element the controls should be listened from
  39353. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39354. */
  39355. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39356. /**
  39357. * Detach the current controls from the specified dom element.
  39358. * @param element Defines the element to stop listening the inputs from
  39359. */
  39360. detachControl(element: Nullable<HTMLElement>): void;
  39361. /**
  39362. * Gets the class name of the current intput.
  39363. * @returns the class name
  39364. */
  39365. getClassName(): string;
  39366. /**
  39367. * Get the friendly name associated with the input class.
  39368. * @returns the input friendly name
  39369. */
  39370. getSimpleName(): string;
  39371. }
  39372. }
  39373. declare module "babylonjs/Cameras/Inputs/index" {
  39374. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  39375. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  39376. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  39377. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  39378. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  39379. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  39380. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  39381. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  39382. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  39383. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  39384. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  39385. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  39386. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  39387. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  39388. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  39389. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  39390. }
  39391. declare module "babylonjs/Cameras/touchCamera" {
  39392. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39393. import { Scene } from "babylonjs/scene";
  39394. import { Vector3 } from "babylonjs/Maths/math.vector";
  39395. /**
  39396. * This represents a FPS type of camera controlled by touch.
  39397. * This is like a universal camera minus the Gamepad controls.
  39398. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  39399. */
  39400. export class TouchCamera extends FreeCamera {
  39401. /**
  39402. * Defines the touch sensibility for rotation.
  39403. * The higher the faster.
  39404. */
  39405. touchAngularSensibility: number;
  39406. /**
  39407. * Defines the touch sensibility for move.
  39408. * The higher the faster.
  39409. */
  39410. touchMoveSensibility: number;
  39411. /**
  39412. * Instantiates a new touch camera.
  39413. * This represents a FPS type of camera controlled by touch.
  39414. * This is like a universal camera minus the Gamepad controls.
  39415. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  39416. * @param name Define the name of the camera in the scene
  39417. * @param position Define the start position of the camera in the scene
  39418. * @param scene Define the scene the camera belongs to
  39419. */
  39420. constructor(name: string, position: Vector3, scene: Scene);
  39421. /**
  39422. * Gets the current object class name.
  39423. * @return the class name
  39424. */
  39425. getClassName(): string;
  39426. /** @hidden */
  39427. _setupInputs(): void;
  39428. }
  39429. }
  39430. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  39431. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39432. import { Scene } from "babylonjs/scene";
  39433. import { Vector3 } from "babylonjs/Maths/math.vector";
  39434. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  39435. import { Axis } from "babylonjs/Maths/math.axis";
  39436. /**
  39437. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  39438. * being tilted forward or back and left or right.
  39439. */
  39440. export class DeviceOrientationCamera extends FreeCamera {
  39441. private _initialQuaternion;
  39442. private _quaternionCache;
  39443. private _tmpDragQuaternion;
  39444. private _disablePointerInputWhenUsingDeviceOrientation;
  39445. /**
  39446. * Creates a new device orientation camera
  39447. * @param name The name of the camera
  39448. * @param position The start position camera
  39449. * @param scene The scene the camera belongs to
  39450. */
  39451. constructor(name: string, position: Vector3, scene: Scene);
  39452. /**
  39453. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  39454. */
  39455. disablePointerInputWhenUsingDeviceOrientation: boolean;
  39456. private _dragFactor;
  39457. /**
  39458. * Enabled turning on the y axis when the orientation sensor is active
  39459. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  39460. */
  39461. enableHorizontalDragging(dragFactor?: number): void;
  39462. /**
  39463. * Gets the current instance class name ("DeviceOrientationCamera").
  39464. * This helps avoiding instanceof at run time.
  39465. * @returns the class name
  39466. */
  39467. getClassName(): string;
  39468. /**
  39469. * @hidden
  39470. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  39471. */
  39472. _checkInputs(): void;
  39473. /**
  39474. * Reset the camera to its default orientation on the specified axis only.
  39475. * @param axis The axis to reset
  39476. */
  39477. resetToCurrentRotation(axis?: Axis): void;
  39478. }
  39479. }
  39480. declare module "babylonjs/Gamepads/xboxGamepad" {
  39481. import { Observable } from "babylonjs/Misc/observable";
  39482. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39483. /**
  39484. * Defines supported buttons for XBox360 compatible gamepads
  39485. */
  39486. export enum Xbox360Button {
  39487. /** A */
  39488. A = 0,
  39489. /** B */
  39490. B = 1,
  39491. /** X */
  39492. X = 2,
  39493. /** Y */
  39494. Y = 3,
  39495. /** Start */
  39496. Start = 4,
  39497. /** Back */
  39498. Back = 5,
  39499. /** Left button */
  39500. LB = 6,
  39501. /** Right button */
  39502. RB = 7,
  39503. /** Left stick */
  39504. LeftStick = 8,
  39505. /** Right stick */
  39506. RightStick = 9
  39507. }
  39508. /** Defines values for XBox360 DPad */
  39509. export enum Xbox360Dpad {
  39510. /** Up */
  39511. Up = 0,
  39512. /** Down */
  39513. Down = 1,
  39514. /** Left */
  39515. Left = 2,
  39516. /** Right */
  39517. Right = 3
  39518. }
  39519. /**
  39520. * Defines a XBox360 gamepad
  39521. */
  39522. export class Xbox360Pad extends Gamepad {
  39523. private _leftTrigger;
  39524. private _rightTrigger;
  39525. private _onlefttriggerchanged;
  39526. private _onrighttriggerchanged;
  39527. private _onbuttondown;
  39528. private _onbuttonup;
  39529. private _ondpaddown;
  39530. private _ondpadup;
  39531. /** Observable raised when a button is pressed */
  39532. onButtonDownObservable: Observable<Xbox360Button>;
  39533. /** Observable raised when a button is released */
  39534. onButtonUpObservable: Observable<Xbox360Button>;
  39535. /** Observable raised when a pad is pressed */
  39536. onPadDownObservable: Observable<Xbox360Dpad>;
  39537. /** Observable raised when a pad is released */
  39538. onPadUpObservable: Observable<Xbox360Dpad>;
  39539. private _buttonA;
  39540. private _buttonB;
  39541. private _buttonX;
  39542. private _buttonY;
  39543. private _buttonBack;
  39544. private _buttonStart;
  39545. private _buttonLB;
  39546. private _buttonRB;
  39547. private _buttonLeftStick;
  39548. private _buttonRightStick;
  39549. private _dPadUp;
  39550. private _dPadDown;
  39551. private _dPadLeft;
  39552. private _dPadRight;
  39553. private _isXboxOnePad;
  39554. /**
  39555. * Creates a new XBox360 gamepad object
  39556. * @param id defines the id of this gamepad
  39557. * @param index defines its index
  39558. * @param gamepad defines the internal HTML gamepad object
  39559. * @param xboxOne defines if it is a XBox One gamepad
  39560. */
  39561. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  39562. /**
  39563. * Defines the callback to call when left trigger is pressed
  39564. * @param callback defines the callback to use
  39565. */
  39566. onlefttriggerchanged(callback: (value: number) => void): void;
  39567. /**
  39568. * Defines the callback to call when right trigger is pressed
  39569. * @param callback defines the callback to use
  39570. */
  39571. onrighttriggerchanged(callback: (value: number) => void): void;
  39572. /**
  39573. * Gets the left trigger value
  39574. */
  39575. /**
  39576. * Sets the left trigger value
  39577. */
  39578. leftTrigger: number;
  39579. /**
  39580. * Gets the right trigger value
  39581. */
  39582. /**
  39583. * Sets the right trigger value
  39584. */
  39585. rightTrigger: number;
  39586. /**
  39587. * Defines the callback to call when a button is pressed
  39588. * @param callback defines the callback to use
  39589. */
  39590. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  39591. /**
  39592. * Defines the callback to call when a button is released
  39593. * @param callback defines the callback to use
  39594. */
  39595. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  39596. /**
  39597. * Defines the callback to call when a pad is pressed
  39598. * @param callback defines the callback to use
  39599. */
  39600. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  39601. /**
  39602. * Defines the callback to call when a pad is released
  39603. * @param callback defines the callback to use
  39604. */
  39605. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  39606. private _setButtonValue;
  39607. private _setDPadValue;
  39608. /**
  39609. * Gets the value of the `A` button
  39610. */
  39611. /**
  39612. * Sets the value of the `A` button
  39613. */
  39614. buttonA: number;
  39615. /**
  39616. * Gets the value of the `B` button
  39617. */
  39618. /**
  39619. * Sets the value of the `B` button
  39620. */
  39621. buttonB: number;
  39622. /**
  39623. * Gets the value of the `X` button
  39624. */
  39625. /**
  39626. * Sets the value of the `X` button
  39627. */
  39628. buttonX: number;
  39629. /**
  39630. * Gets the value of the `Y` button
  39631. */
  39632. /**
  39633. * Sets the value of the `Y` button
  39634. */
  39635. buttonY: number;
  39636. /**
  39637. * Gets the value of the `Start` button
  39638. */
  39639. /**
  39640. * Sets the value of the `Start` button
  39641. */
  39642. buttonStart: number;
  39643. /**
  39644. * Gets the value of the `Back` button
  39645. */
  39646. /**
  39647. * Sets the value of the `Back` button
  39648. */
  39649. buttonBack: number;
  39650. /**
  39651. * Gets the value of the `Left` button
  39652. */
  39653. /**
  39654. * Sets the value of the `Left` button
  39655. */
  39656. buttonLB: number;
  39657. /**
  39658. * Gets the value of the `Right` button
  39659. */
  39660. /**
  39661. * Sets the value of the `Right` button
  39662. */
  39663. buttonRB: number;
  39664. /**
  39665. * Gets the value of the Left joystick
  39666. */
  39667. /**
  39668. * Sets the value of the Left joystick
  39669. */
  39670. buttonLeftStick: number;
  39671. /**
  39672. * Gets the value of the Right joystick
  39673. */
  39674. /**
  39675. * Sets the value of the Right joystick
  39676. */
  39677. buttonRightStick: number;
  39678. /**
  39679. * Gets the value of D-pad up
  39680. */
  39681. /**
  39682. * Sets the value of D-pad up
  39683. */
  39684. dPadUp: number;
  39685. /**
  39686. * Gets the value of D-pad down
  39687. */
  39688. /**
  39689. * Sets the value of D-pad down
  39690. */
  39691. dPadDown: number;
  39692. /**
  39693. * Gets the value of D-pad left
  39694. */
  39695. /**
  39696. * Sets the value of D-pad left
  39697. */
  39698. dPadLeft: number;
  39699. /**
  39700. * Gets the value of D-pad right
  39701. */
  39702. /**
  39703. * Sets the value of D-pad right
  39704. */
  39705. dPadRight: number;
  39706. /**
  39707. * Force the gamepad to synchronize with device values
  39708. */
  39709. update(): void;
  39710. /**
  39711. * Disposes the gamepad
  39712. */
  39713. dispose(): void;
  39714. }
  39715. }
  39716. declare module "babylonjs/Gamepads/dualShockGamepad" {
  39717. import { Observable } from "babylonjs/Misc/observable";
  39718. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39719. /**
  39720. * Defines supported buttons for DualShock compatible gamepads
  39721. */
  39722. export enum DualShockButton {
  39723. /** Cross */
  39724. Cross = 0,
  39725. /** Circle */
  39726. Circle = 1,
  39727. /** Square */
  39728. Square = 2,
  39729. /** Triangle */
  39730. Triangle = 3,
  39731. /** Options */
  39732. Options = 4,
  39733. /** Share */
  39734. Share = 5,
  39735. /** L1 */
  39736. L1 = 6,
  39737. /** R1 */
  39738. R1 = 7,
  39739. /** Left stick */
  39740. LeftStick = 8,
  39741. /** Right stick */
  39742. RightStick = 9
  39743. }
  39744. /** Defines values for DualShock DPad */
  39745. export enum DualShockDpad {
  39746. /** Up */
  39747. Up = 0,
  39748. /** Down */
  39749. Down = 1,
  39750. /** Left */
  39751. Left = 2,
  39752. /** Right */
  39753. Right = 3
  39754. }
  39755. /**
  39756. * Defines a DualShock gamepad
  39757. */
  39758. export class DualShockPad extends Gamepad {
  39759. private _leftTrigger;
  39760. private _rightTrigger;
  39761. private _onlefttriggerchanged;
  39762. private _onrighttriggerchanged;
  39763. private _onbuttondown;
  39764. private _onbuttonup;
  39765. private _ondpaddown;
  39766. private _ondpadup;
  39767. /** Observable raised when a button is pressed */
  39768. onButtonDownObservable: Observable<DualShockButton>;
  39769. /** Observable raised when a button is released */
  39770. onButtonUpObservable: Observable<DualShockButton>;
  39771. /** Observable raised when a pad is pressed */
  39772. onPadDownObservable: Observable<DualShockDpad>;
  39773. /** Observable raised when a pad is released */
  39774. onPadUpObservable: Observable<DualShockDpad>;
  39775. private _buttonCross;
  39776. private _buttonCircle;
  39777. private _buttonSquare;
  39778. private _buttonTriangle;
  39779. private _buttonShare;
  39780. private _buttonOptions;
  39781. private _buttonL1;
  39782. private _buttonR1;
  39783. private _buttonLeftStick;
  39784. private _buttonRightStick;
  39785. private _dPadUp;
  39786. private _dPadDown;
  39787. private _dPadLeft;
  39788. private _dPadRight;
  39789. /**
  39790. * Creates a new DualShock gamepad object
  39791. * @param id defines the id of this gamepad
  39792. * @param index defines its index
  39793. * @param gamepad defines the internal HTML gamepad object
  39794. */
  39795. constructor(id: string, index: number, gamepad: any);
  39796. /**
  39797. * Defines the callback to call when left trigger is pressed
  39798. * @param callback defines the callback to use
  39799. */
  39800. onlefttriggerchanged(callback: (value: number) => void): void;
  39801. /**
  39802. * Defines the callback to call when right trigger is pressed
  39803. * @param callback defines the callback to use
  39804. */
  39805. onrighttriggerchanged(callback: (value: number) => void): void;
  39806. /**
  39807. * Gets the left trigger value
  39808. */
  39809. /**
  39810. * Sets the left trigger value
  39811. */
  39812. leftTrigger: number;
  39813. /**
  39814. * Gets the right trigger value
  39815. */
  39816. /**
  39817. * Sets the right trigger value
  39818. */
  39819. rightTrigger: number;
  39820. /**
  39821. * Defines the callback to call when a button is pressed
  39822. * @param callback defines the callback to use
  39823. */
  39824. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  39825. /**
  39826. * Defines the callback to call when a button is released
  39827. * @param callback defines the callback to use
  39828. */
  39829. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  39830. /**
  39831. * Defines the callback to call when a pad is pressed
  39832. * @param callback defines the callback to use
  39833. */
  39834. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  39835. /**
  39836. * Defines the callback to call when a pad is released
  39837. * @param callback defines the callback to use
  39838. */
  39839. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  39840. private _setButtonValue;
  39841. private _setDPadValue;
  39842. /**
  39843. * Gets the value of the `Cross` button
  39844. */
  39845. /**
  39846. * Sets the value of the `Cross` button
  39847. */
  39848. buttonCross: number;
  39849. /**
  39850. * Gets the value of the `Circle` button
  39851. */
  39852. /**
  39853. * Sets the value of the `Circle` button
  39854. */
  39855. buttonCircle: number;
  39856. /**
  39857. * Gets the value of the `Square` button
  39858. */
  39859. /**
  39860. * Sets the value of the `Square` button
  39861. */
  39862. buttonSquare: number;
  39863. /**
  39864. * Gets the value of the `Triangle` button
  39865. */
  39866. /**
  39867. * Sets the value of the `Triangle` button
  39868. */
  39869. buttonTriangle: number;
  39870. /**
  39871. * Gets the value of the `Options` button
  39872. */
  39873. /**
  39874. * Sets the value of the `Options` button
  39875. */
  39876. buttonOptions: number;
  39877. /**
  39878. * Gets the value of the `Share` button
  39879. */
  39880. /**
  39881. * Sets the value of the `Share` button
  39882. */
  39883. buttonShare: number;
  39884. /**
  39885. * Gets the value of the `L1` button
  39886. */
  39887. /**
  39888. * Sets the value of the `L1` button
  39889. */
  39890. buttonL1: number;
  39891. /**
  39892. * Gets the value of the `R1` button
  39893. */
  39894. /**
  39895. * Sets the value of the `R1` button
  39896. */
  39897. buttonR1: number;
  39898. /**
  39899. * Gets the value of the Left joystick
  39900. */
  39901. /**
  39902. * Sets the value of the Left joystick
  39903. */
  39904. buttonLeftStick: number;
  39905. /**
  39906. * Gets the value of the Right joystick
  39907. */
  39908. /**
  39909. * Sets the value of the Right joystick
  39910. */
  39911. buttonRightStick: number;
  39912. /**
  39913. * Gets the value of D-pad up
  39914. */
  39915. /**
  39916. * Sets the value of D-pad up
  39917. */
  39918. dPadUp: number;
  39919. /**
  39920. * Gets the value of D-pad down
  39921. */
  39922. /**
  39923. * Sets the value of D-pad down
  39924. */
  39925. dPadDown: number;
  39926. /**
  39927. * Gets the value of D-pad left
  39928. */
  39929. /**
  39930. * Sets the value of D-pad left
  39931. */
  39932. dPadLeft: number;
  39933. /**
  39934. * Gets the value of D-pad right
  39935. */
  39936. /**
  39937. * Sets the value of D-pad right
  39938. */
  39939. dPadRight: number;
  39940. /**
  39941. * Force the gamepad to synchronize with device values
  39942. */
  39943. update(): void;
  39944. /**
  39945. * Disposes the gamepad
  39946. */
  39947. dispose(): void;
  39948. }
  39949. }
  39950. declare module "babylonjs/Gamepads/gamepadManager" {
  39951. import { Observable } from "babylonjs/Misc/observable";
  39952. import { Nullable } from "babylonjs/types";
  39953. import { Scene } from "babylonjs/scene";
  39954. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39955. /**
  39956. * Manager for handling gamepads
  39957. */
  39958. export class GamepadManager {
  39959. private _scene?;
  39960. private _babylonGamepads;
  39961. private _oneGamepadConnected;
  39962. /** @hidden */
  39963. _isMonitoring: boolean;
  39964. private _gamepadEventSupported;
  39965. private _gamepadSupport;
  39966. /**
  39967. * observable to be triggered when the gamepad controller has been connected
  39968. */
  39969. onGamepadConnectedObservable: Observable<Gamepad>;
  39970. /**
  39971. * observable to be triggered when the gamepad controller has been disconnected
  39972. */
  39973. onGamepadDisconnectedObservable: Observable<Gamepad>;
  39974. private _onGamepadConnectedEvent;
  39975. private _onGamepadDisconnectedEvent;
  39976. /**
  39977. * Initializes the gamepad manager
  39978. * @param _scene BabylonJS scene
  39979. */
  39980. constructor(_scene?: Scene | undefined);
  39981. /**
  39982. * The gamepads in the game pad manager
  39983. */
  39984. readonly gamepads: Gamepad[];
  39985. /**
  39986. * Get the gamepad controllers based on type
  39987. * @param type The type of gamepad controller
  39988. * @returns Nullable gamepad
  39989. */
  39990. getGamepadByType(type?: number): Nullable<Gamepad>;
  39991. /**
  39992. * Disposes the gamepad manager
  39993. */
  39994. dispose(): void;
  39995. private _addNewGamepad;
  39996. private _startMonitoringGamepads;
  39997. private _stopMonitoringGamepads;
  39998. /** @hidden */
  39999. _checkGamepadsStatus(): void;
  40000. private _updateGamepadObjects;
  40001. }
  40002. }
  40003. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40004. import { Nullable } from "babylonjs/types";
  40005. import { Scene } from "babylonjs/scene";
  40006. import { ISceneComponent } from "babylonjs/sceneComponent";
  40007. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40008. module "babylonjs/scene" {
  40009. interface Scene {
  40010. /** @hidden */
  40011. _gamepadManager: Nullable<GamepadManager>;
  40012. /**
  40013. * Gets the gamepad manager associated with the scene
  40014. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40015. */
  40016. gamepadManager: GamepadManager;
  40017. }
  40018. }
  40019. module "babylonjs/Cameras/freeCameraInputsManager" {
  40020. /**
  40021. * Interface representing a free camera inputs manager
  40022. */
  40023. interface FreeCameraInputsManager {
  40024. /**
  40025. * Adds gamepad input support to the FreeCameraInputsManager.
  40026. * @returns the FreeCameraInputsManager
  40027. */
  40028. addGamepad(): FreeCameraInputsManager;
  40029. }
  40030. }
  40031. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40032. /**
  40033. * Interface representing an arc rotate camera inputs manager
  40034. */
  40035. interface ArcRotateCameraInputsManager {
  40036. /**
  40037. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40038. * @returns the camera inputs manager
  40039. */
  40040. addGamepad(): ArcRotateCameraInputsManager;
  40041. }
  40042. }
  40043. /**
  40044. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40045. */
  40046. export class GamepadSystemSceneComponent implements ISceneComponent {
  40047. /**
  40048. * The component name helpfull to identify the component in the list of scene components.
  40049. */
  40050. readonly name: string;
  40051. /**
  40052. * The scene the component belongs to.
  40053. */
  40054. scene: Scene;
  40055. /**
  40056. * Creates a new instance of the component for the given scene
  40057. * @param scene Defines the scene to register the component in
  40058. */
  40059. constructor(scene: Scene);
  40060. /**
  40061. * Registers the component in a given scene
  40062. */
  40063. register(): void;
  40064. /**
  40065. * Rebuilds the elements related to this component in case of
  40066. * context lost for instance.
  40067. */
  40068. rebuild(): void;
  40069. /**
  40070. * Disposes the component and the associated ressources
  40071. */
  40072. dispose(): void;
  40073. private _beforeCameraUpdate;
  40074. }
  40075. }
  40076. declare module "babylonjs/Cameras/universalCamera" {
  40077. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  40078. import { Scene } from "babylonjs/scene";
  40079. import { Vector3 } from "babylonjs/Maths/math.vector";
  40080. import "babylonjs/Gamepads/gamepadSceneComponent";
  40081. /**
  40082. * 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,
  40083. * which still works and will still be found in many Playgrounds.
  40084. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40085. */
  40086. export class UniversalCamera extends TouchCamera {
  40087. /**
  40088. * Defines the gamepad rotation sensiblity.
  40089. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40090. */
  40091. gamepadAngularSensibility: number;
  40092. /**
  40093. * Defines the gamepad move sensiblity.
  40094. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40095. */
  40096. gamepadMoveSensibility: number;
  40097. /**
  40098. * 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,
  40099. * which still works and will still be found in many Playgrounds.
  40100. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40101. * @param name Define the name of the camera in the scene
  40102. * @param position Define the start position of the camera in the scene
  40103. * @param scene Define the scene the camera belongs to
  40104. */
  40105. constructor(name: string, position: Vector3, scene: Scene);
  40106. /**
  40107. * Gets the current object class name.
  40108. * @return the class name
  40109. */
  40110. getClassName(): string;
  40111. }
  40112. }
  40113. declare module "babylonjs/Cameras/gamepadCamera" {
  40114. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40115. import { Scene } from "babylonjs/scene";
  40116. import { Vector3 } from "babylonjs/Maths/math.vector";
  40117. /**
  40118. * This represents a FPS type of camera. This is only here for back compat purpose.
  40119. * Please use the UniversalCamera instead as both are identical.
  40120. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40121. */
  40122. export class GamepadCamera extends UniversalCamera {
  40123. /**
  40124. * Instantiates a new Gamepad Camera
  40125. * This represents a FPS type of camera. This is only here for back compat purpose.
  40126. * Please use the UniversalCamera instead as both are identical.
  40127. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40128. * @param name Define the name of the camera in the scene
  40129. * @param position Define the start position of the camera in the scene
  40130. * @param scene Define the scene the camera belongs to
  40131. */
  40132. constructor(name: string, position: Vector3, scene: Scene);
  40133. /**
  40134. * Gets the current object class name.
  40135. * @return the class name
  40136. */
  40137. getClassName(): string;
  40138. }
  40139. }
  40140. declare module "babylonjs/Shaders/pass.fragment" {
  40141. /** @hidden */
  40142. export var passPixelShader: {
  40143. name: string;
  40144. shader: string;
  40145. };
  40146. }
  40147. declare module "babylonjs/Shaders/passCube.fragment" {
  40148. /** @hidden */
  40149. export var passCubePixelShader: {
  40150. name: string;
  40151. shader: string;
  40152. };
  40153. }
  40154. declare module "babylonjs/PostProcesses/passPostProcess" {
  40155. import { Nullable } from "babylonjs/types";
  40156. import { Camera } from "babylonjs/Cameras/camera";
  40157. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40158. import { Engine } from "babylonjs/Engines/engine";
  40159. import "babylonjs/Shaders/pass.fragment";
  40160. import "babylonjs/Shaders/passCube.fragment";
  40161. /**
  40162. * PassPostProcess which produces an output the same as it's input
  40163. */
  40164. export class PassPostProcess extends PostProcess {
  40165. /**
  40166. * Creates the PassPostProcess
  40167. * @param name The name of the effect.
  40168. * @param options The required width/height ratio to downsize to before computing the render pass.
  40169. * @param camera The camera to apply the render pass to.
  40170. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40171. * @param engine The engine which the post process will be applied. (default: current engine)
  40172. * @param reusable If the post process can be reused on the same frame. (default: false)
  40173. * @param textureType The type of texture to be used when performing the post processing.
  40174. * @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)
  40175. */
  40176. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40177. }
  40178. /**
  40179. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  40180. */
  40181. export class PassCubePostProcess extends PostProcess {
  40182. private _face;
  40183. /**
  40184. * Gets or sets the cube face to display.
  40185. * * 0 is +X
  40186. * * 1 is -X
  40187. * * 2 is +Y
  40188. * * 3 is -Y
  40189. * * 4 is +Z
  40190. * * 5 is -Z
  40191. */
  40192. face: number;
  40193. /**
  40194. * Creates the PassCubePostProcess
  40195. * @param name The name of the effect.
  40196. * @param options The required width/height ratio to downsize to before computing the render pass.
  40197. * @param camera The camera to apply the render pass to.
  40198. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40199. * @param engine The engine which the post process will be applied. (default: current engine)
  40200. * @param reusable If the post process can be reused on the same frame. (default: false)
  40201. * @param textureType The type of texture to be used when performing the post processing.
  40202. * @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)
  40203. */
  40204. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40205. }
  40206. }
  40207. declare module "babylonjs/Shaders/anaglyph.fragment" {
  40208. /** @hidden */
  40209. export var anaglyphPixelShader: {
  40210. name: string;
  40211. shader: string;
  40212. };
  40213. }
  40214. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  40215. import { Engine } from "babylonjs/Engines/engine";
  40216. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40217. import { Camera } from "babylonjs/Cameras/camera";
  40218. import "babylonjs/Shaders/anaglyph.fragment";
  40219. /**
  40220. * Postprocess used to generate anaglyphic rendering
  40221. */
  40222. export class AnaglyphPostProcess extends PostProcess {
  40223. private _passedProcess;
  40224. /**
  40225. * Creates a new AnaglyphPostProcess
  40226. * @param name defines postprocess name
  40227. * @param options defines creation options or target ratio scale
  40228. * @param rigCameras defines cameras using this postprocess
  40229. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  40230. * @param engine defines hosting engine
  40231. * @param reusable defines if the postprocess will be reused multiple times per frame
  40232. */
  40233. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  40234. }
  40235. }
  40236. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  40237. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  40238. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40239. import { Scene } from "babylonjs/scene";
  40240. import { Vector3 } from "babylonjs/Maths/math.vector";
  40241. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40242. /**
  40243. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  40244. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40245. */
  40246. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  40247. /**
  40248. * Creates a new AnaglyphArcRotateCamera
  40249. * @param name defines camera name
  40250. * @param alpha defines alpha angle (in radians)
  40251. * @param beta defines beta angle (in radians)
  40252. * @param radius defines radius
  40253. * @param target defines camera target
  40254. * @param interaxialDistance defines distance between each color axis
  40255. * @param scene defines the hosting scene
  40256. */
  40257. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  40258. /**
  40259. * Gets camera class name
  40260. * @returns AnaglyphArcRotateCamera
  40261. */
  40262. getClassName(): string;
  40263. }
  40264. }
  40265. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  40266. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40267. import { Scene } from "babylonjs/scene";
  40268. import { Vector3 } from "babylonjs/Maths/math.vector";
  40269. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40270. /**
  40271. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  40272. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40273. */
  40274. export class AnaglyphFreeCamera extends FreeCamera {
  40275. /**
  40276. * Creates a new AnaglyphFreeCamera
  40277. * @param name defines camera name
  40278. * @param position defines initial position
  40279. * @param interaxialDistance defines distance between each color axis
  40280. * @param scene defines the hosting scene
  40281. */
  40282. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40283. /**
  40284. * Gets camera class name
  40285. * @returns AnaglyphFreeCamera
  40286. */
  40287. getClassName(): string;
  40288. }
  40289. }
  40290. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  40291. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  40292. import { Scene } from "babylonjs/scene";
  40293. import { Vector3 } from "babylonjs/Maths/math.vector";
  40294. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40295. /**
  40296. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  40297. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40298. */
  40299. export class AnaglyphGamepadCamera extends GamepadCamera {
  40300. /**
  40301. * Creates a new AnaglyphGamepadCamera
  40302. * @param name defines camera name
  40303. * @param position defines initial position
  40304. * @param interaxialDistance defines distance between each color axis
  40305. * @param scene defines the hosting scene
  40306. */
  40307. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40308. /**
  40309. * Gets camera class name
  40310. * @returns AnaglyphGamepadCamera
  40311. */
  40312. getClassName(): string;
  40313. }
  40314. }
  40315. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  40316. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40317. import { Scene } from "babylonjs/scene";
  40318. import { Vector3 } from "babylonjs/Maths/math.vector";
  40319. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40320. /**
  40321. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  40322. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40323. */
  40324. export class AnaglyphUniversalCamera extends UniversalCamera {
  40325. /**
  40326. * Creates a new AnaglyphUniversalCamera
  40327. * @param name defines camera name
  40328. * @param position defines initial position
  40329. * @param interaxialDistance defines distance between each color axis
  40330. * @param scene defines the hosting scene
  40331. */
  40332. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40333. /**
  40334. * Gets camera class name
  40335. * @returns AnaglyphUniversalCamera
  40336. */
  40337. getClassName(): string;
  40338. }
  40339. }
  40340. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  40341. /** @hidden */
  40342. export var stereoscopicInterlacePixelShader: {
  40343. name: string;
  40344. shader: string;
  40345. };
  40346. }
  40347. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  40348. import { Camera } from "babylonjs/Cameras/camera";
  40349. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40350. import { Engine } from "babylonjs/Engines/engine";
  40351. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  40352. /**
  40353. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  40354. */
  40355. export class StereoscopicInterlacePostProcess extends PostProcess {
  40356. private _stepSize;
  40357. private _passedProcess;
  40358. /**
  40359. * Initializes a StereoscopicInterlacePostProcess
  40360. * @param name The name of the effect.
  40361. * @param rigCameras The rig cameras to be appled to the post process
  40362. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  40363. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40364. * @param engine The engine which the post process will be applied. (default: current engine)
  40365. * @param reusable If the post process can be reused on the same frame. (default: false)
  40366. */
  40367. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  40368. }
  40369. }
  40370. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  40371. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  40372. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40373. import { Scene } from "babylonjs/scene";
  40374. import { Vector3 } from "babylonjs/Maths/math.vector";
  40375. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40376. /**
  40377. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  40378. * @see http://doc.babylonjs.com/features/cameras
  40379. */
  40380. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  40381. /**
  40382. * Creates a new StereoscopicArcRotateCamera
  40383. * @param name defines camera name
  40384. * @param alpha defines alpha angle (in radians)
  40385. * @param beta defines beta angle (in radians)
  40386. * @param radius defines radius
  40387. * @param target defines camera target
  40388. * @param interaxialDistance defines distance between each color axis
  40389. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40390. * @param scene defines the hosting scene
  40391. */
  40392. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40393. /**
  40394. * Gets camera class name
  40395. * @returns StereoscopicArcRotateCamera
  40396. */
  40397. getClassName(): string;
  40398. }
  40399. }
  40400. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  40401. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40402. import { Scene } from "babylonjs/scene";
  40403. import { Vector3 } from "babylonjs/Maths/math.vector";
  40404. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40405. /**
  40406. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  40407. * @see http://doc.babylonjs.com/features/cameras
  40408. */
  40409. export class StereoscopicFreeCamera extends FreeCamera {
  40410. /**
  40411. * Creates a new StereoscopicFreeCamera
  40412. * @param name defines camera name
  40413. * @param position defines initial position
  40414. * @param interaxialDistance defines distance between each color axis
  40415. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40416. * @param scene defines the hosting scene
  40417. */
  40418. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40419. /**
  40420. * Gets camera class name
  40421. * @returns StereoscopicFreeCamera
  40422. */
  40423. getClassName(): string;
  40424. }
  40425. }
  40426. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  40427. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  40428. import { Scene } from "babylonjs/scene";
  40429. import { Vector3 } from "babylonjs/Maths/math.vector";
  40430. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40431. /**
  40432. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  40433. * @see http://doc.babylonjs.com/features/cameras
  40434. */
  40435. export class StereoscopicGamepadCamera extends GamepadCamera {
  40436. /**
  40437. * Creates a new StereoscopicGamepadCamera
  40438. * @param name defines camera name
  40439. * @param position defines initial position
  40440. * @param interaxialDistance defines distance between each color axis
  40441. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40442. * @param scene defines the hosting scene
  40443. */
  40444. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40445. /**
  40446. * Gets camera class name
  40447. * @returns StereoscopicGamepadCamera
  40448. */
  40449. getClassName(): string;
  40450. }
  40451. }
  40452. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  40453. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40454. import { Scene } from "babylonjs/scene";
  40455. import { Vector3 } from "babylonjs/Maths/math.vector";
  40456. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40457. /**
  40458. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  40459. * @see http://doc.babylonjs.com/features/cameras
  40460. */
  40461. export class StereoscopicUniversalCamera extends UniversalCamera {
  40462. /**
  40463. * Creates a new StereoscopicUniversalCamera
  40464. * @param name defines camera name
  40465. * @param position defines initial position
  40466. * @param interaxialDistance defines distance between each color axis
  40467. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40468. * @param scene defines the hosting scene
  40469. */
  40470. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40471. /**
  40472. * Gets camera class name
  40473. * @returns StereoscopicUniversalCamera
  40474. */
  40475. getClassName(): string;
  40476. }
  40477. }
  40478. declare module "babylonjs/Cameras/Stereoscopic/index" {
  40479. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  40480. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  40481. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  40482. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  40483. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  40484. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  40485. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  40486. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  40487. }
  40488. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  40489. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40490. import { Scene } from "babylonjs/scene";
  40491. import { Vector3 } from "babylonjs/Maths/math.vector";
  40492. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  40493. /**
  40494. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  40495. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  40496. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  40497. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  40498. */
  40499. export class VirtualJoysticksCamera extends FreeCamera {
  40500. /**
  40501. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  40502. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  40503. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  40504. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  40505. * @param name Define the name of the camera in the scene
  40506. * @param position Define the start position of the camera in the scene
  40507. * @param scene Define the scene the camera belongs to
  40508. */
  40509. constructor(name: string, position: Vector3, scene: Scene);
  40510. /**
  40511. * Gets the current object class name.
  40512. * @return the class name
  40513. */
  40514. getClassName(): string;
  40515. }
  40516. }
  40517. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  40518. import { Matrix } from "babylonjs/Maths/math.vector";
  40519. /**
  40520. * This represents all the required metrics to create a VR camera.
  40521. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  40522. */
  40523. export class VRCameraMetrics {
  40524. /**
  40525. * Define the horizontal resolution off the screen.
  40526. */
  40527. hResolution: number;
  40528. /**
  40529. * Define the vertical resolution off the screen.
  40530. */
  40531. vResolution: number;
  40532. /**
  40533. * Define the horizontal screen size.
  40534. */
  40535. hScreenSize: number;
  40536. /**
  40537. * Define the vertical screen size.
  40538. */
  40539. vScreenSize: number;
  40540. /**
  40541. * Define the vertical screen center position.
  40542. */
  40543. vScreenCenter: number;
  40544. /**
  40545. * Define the distance of the eyes to the screen.
  40546. */
  40547. eyeToScreenDistance: number;
  40548. /**
  40549. * Define the distance between both lenses
  40550. */
  40551. lensSeparationDistance: number;
  40552. /**
  40553. * Define the distance between both viewer's eyes.
  40554. */
  40555. interpupillaryDistance: number;
  40556. /**
  40557. * Define the distortion factor of the VR postprocess.
  40558. * Please, touch with care.
  40559. */
  40560. distortionK: number[];
  40561. /**
  40562. * Define the chromatic aberration correction factors for the VR post process.
  40563. */
  40564. chromaAbCorrection: number[];
  40565. /**
  40566. * Define the scale factor of the post process.
  40567. * The smaller the better but the slower.
  40568. */
  40569. postProcessScaleFactor: number;
  40570. /**
  40571. * Define an offset for the lens center.
  40572. */
  40573. lensCenterOffset: number;
  40574. /**
  40575. * Define if the current vr camera should compensate the distortion of the lense or not.
  40576. */
  40577. compensateDistortion: boolean;
  40578. /**
  40579. * Defines if multiview should be enabled when rendering (Default: false)
  40580. */
  40581. multiviewEnabled: boolean;
  40582. /**
  40583. * Gets the rendering aspect ratio based on the provided resolutions.
  40584. */
  40585. readonly aspectRatio: number;
  40586. /**
  40587. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  40588. */
  40589. readonly aspectRatioFov: number;
  40590. /**
  40591. * @hidden
  40592. */
  40593. readonly leftHMatrix: Matrix;
  40594. /**
  40595. * @hidden
  40596. */
  40597. readonly rightHMatrix: Matrix;
  40598. /**
  40599. * @hidden
  40600. */
  40601. readonly leftPreViewMatrix: Matrix;
  40602. /**
  40603. * @hidden
  40604. */
  40605. readonly rightPreViewMatrix: Matrix;
  40606. /**
  40607. * Get the default VRMetrics based on the most generic setup.
  40608. * @returns the default vr metrics
  40609. */
  40610. static GetDefault(): VRCameraMetrics;
  40611. }
  40612. }
  40613. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  40614. /** @hidden */
  40615. export var vrDistortionCorrectionPixelShader: {
  40616. name: string;
  40617. shader: string;
  40618. };
  40619. }
  40620. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  40621. import { Camera } from "babylonjs/Cameras/camera";
  40622. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40623. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40624. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  40625. /**
  40626. * VRDistortionCorrectionPostProcess used for mobile VR
  40627. */
  40628. export class VRDistortionCorrectionPostProcess extends PostProcess {
  40629. private _isRightEye;
  40630. private _distortionFactors;
  40631. private _postProcessScaleFactor;
  40632. private _lensCenterOffset;
  40633. private _scaleIn;
  40634. private _scaleFactor;
  40635. private _lensCenter;
  40636. /**
  40637. * Initializes the VRDistortionCorrectionPostProcess
  40638. * @param name The name of the effect.
  40639. * @param camera The camera to apply the render pass to.
  40640. * @param isRightEye If this is for the right eye distortion
  40641. * @param vrMetrics All the required metrics for the VR camera
  40642. */
  40643. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  40644. }
  40645. }
  40646. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  40647. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  40648. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40649. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40650. import { Scene } from "babylonjs/scene";
  40651. import { Vector3 } from "babylonjs/Maths/math.vector";
  40652. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  40653. import "babylonjs/Cameras/RigModes/vrRigMode";
  40654. /**
  40655. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  40656. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  40657. */
  40658. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  40659. /**
  40660. * Creates a new VRDeviceOrientationArcRotateCamera
  40661. * @param name defines camera name
  40662. * @param alpha defines the camera rotation along the logitudinal axis
  40663. * @param beta defines the camera rotation along the latitudinal axis
  40664. * @param radius defines the camera distance from its target
  40665. * @param target defines the camera target
  40666. * @param scene defines the scene the camera belongs to
  40667. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  40668. * @param vrCameraMetrics defines the vr metrics associated to the camera
  40669. */
  40670. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  40671. /**
  40672. * Gets camera class name
  40673. * @returns VRDeviceOrientationArcRotateCamera
  40674. */
  40675. getClassName(): string;
  40676. }
  40677. }
  40678. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  40679. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  40680. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40681. import { Scene } from "babylonjs/scene";
  40682. import { Vector3 } from "babylonjs/Maths/math.vector";
  40683. import "babylonjs/Cameras/RigModes/vrRigMode";
  40684. /**
  40685. * Camera used to simulate VR rendering (based on FreeCamera)
  40686. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  40687. */
  40688. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  40689. /**
  40690. * Creates a new VRDeviceOrientationFreeCamera
  40691. * @param name defines camera name
  40692. * @param position defines the start position of the camera
  40693. * @param scene defines the scene the camera belongs to
  40694. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  40695. * @param vrCameraMetrics defines the vr metrics associated to the camera
  40696. */
  40697. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  40698. /**
  40699. * Gets camera class name
  40700. * @returns VRDeviceOrientationFreeCamera
  40701. */
  40702. getClassName(): string;
  40703. }
  40704. }
  40705. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  40706. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  40707. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  40708. import { Scene } from "babylonjs/scene";
  40709. import { Vector3 } from "babylonjs/Maths/math.vector";
  40710. import "babylonjs/Gamepads/gamepadSceneComponent";
  40711. /**
  40712. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  40713. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  40714. */
  40715. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  40716. /**
  40717. * Creates a new VRDeviceOrientationGamepadCamera
  40718. * @param name defines camera name
  40719. * @param position defines the start position of the camera
  40720. * @param scene defines the scene the camera belongs to
  40721. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  40722. * @param vrCameraMetrics defines the vr metrics associated to the camera
  40723. */
  40724. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  40725. /**
  40726. * Gets camera class name
  40727. * @returns VRDeviceOrientationGamepadCamera
  40728. */
  40729. getClassName(): string;
  40730. }
  40731. }
  40732. declare module "babylonjs/Materials/pushMaterial" {
  40733. import { Nullable } from "babylonjs/types";
  40734. import { Scene } from "babylonjs/scene";
  40735. import { Matrix } from "babylonjs/Maths/math.vector";
  40736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40737. import { Mesh } from "babylonjs/Meshes/mesh";
  40738. import { Material } from "babylonjs/Materials/material";
  40739. import { Effect } from "babylonjs/Materials/effect";
  40740. /**
  40741. * Base class of materials working in push mode in babylon JS
  40742. * @hidden
  40743. */
  40744. export class PushMaterial extends Material {
  40745. protected _activeEffect: Effect;
  40746. protected _normalMatrix: Matrix;
  40747. /**
  40748. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  40749. * This means that the material can keep using a previous shader while a new one is being compiled.
  40750. * This is mostly used when shader parallel compilation is supported (true by default)
  40751. */
  40752. allowShaderHotSwapping: boolean;
  40753. constructor(name: string, scene: Scene);
  40754. getEffect(): Effect;
  40755. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  40756. /**
  40757. * Binds the given world matrix to the active effect
  40758. *
  40759. * @param world the matrix to bind
  40760. */
  40761. bindOnlyWorldMatrix(world: Matrix): void;
  40762. /**
  40763. * Binds the given normal matrix to the active effect
  40764. *
  40765. * @param normalMatrix the matrix to bind
  40766. */
  40767. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  40768. bind(world: Matrix, mesh?: Mesh): void;
  40769. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  40770. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  40771. }
  40772. }
  40773. declare module "babylonjs/Materials/materialFlags" {
  40774. /**
  40775. * This groups all the flags used to control the materials channel.
  40776. */
  40777. export class MaterialFlags {
  40778. private static _DiffuseTextureEnabled;
  40779. /**
  40780. * Are diffuse textures enabled in the application.
  40781. */
  40782. static DiffuseTextureEnabled: boolean;
  40783. private static _AmbientTextureEnabled;
  40784. /**
  40785. * Are ambient textures enabled in the application.
  40786. */
  40787. static AmbientTextureEnabled: boolean;
  40788. private static _OpacityTextureEnabled;
  40789. /**
  40790. * Are opacity textures enabled in the application.
  40791. */
  40792. static OpacityTextureEnabled: boolean;
  40793. private static _ReflectionTextureEnabled;
  40794. /**
  40795. * Are reflection textures enabled in the application.
  40796. */
  40797. static ReflectionTextureEnabled: boolean;
  40798. private static _EmissiveTextureEnabled;
  40799. /**
  40800. * Are emissive textures enabled in the application.
  40801. */
  40802. static EmissiveTextureEnabled: boolean;
  40803. private static _SpecularTextureEnabled;
  40804. /**
  40805. * Are specular textures enabled in the application.
  40806. */
  40807. static SpecularTextureEnabled: boolean;
  40808. private static _BumpTextureEnabled;
  40809. /**
  40810. * Are bump textures enabled in the application.
  40811. */
  40812. static BumpTextureEnabled: boolean;
  40813. private static _LightmapTextureEnabled;
  40814. /**
  40815. * Are lightmap textures enabled in the application.
  40816. */
  40817. static LightmapTextureEnabled: boolean;
  40818. private static _RefractionTextureEnabled;
  40819. /**
  40820. * Are refraction textures enabled in the application.
  40821. */
  40822. static RefractionTextureEnabled: boolean;
  40823. private static _ColorGradingTextureEnabled;
  40824. /**
  40825. * Are color grading textures enabled in the application.
  40826. */
  40827. static ColorGradingTextureEnabled: boolean;
  40828. private static _FresnelEnabled;
  40829. /**
  40830. * Are fresnels enabled in the application.
  40831. */
  40832. static FresnelEnabled: boolean;
  40833. private static _ClearCoatTextureEnabled;
  40834. /**
  40835. * Are clear coat textures enabled in the application.
  40836. */
  40837. static ClearCoatTextureEnabled: boolean;
  40838. private static _ClearCoatBumpTextureEnabled;
  40839. /**
  40840. * Are clear coat bump textures enabled in the application.
  40841. */
  40842. static ClearCoatBumpTextureEnabled: boolean;
  40843. private static _ClearCoatTintTextureEnabled;
  40844. /**
  40845. * Are clear coat tint textures enabled in the application.
  40846. */
  40847. static ClearCoatTintTextureEnabled: boolean;
  40848. private static _SheenTextureEnabled;
  40849. /**
  40850. * Are sheen textures enabled in the application.
  40851. */
  40852. static SheenTextureEnabled: boolean;
  40853. private static _AnisotropicTextureEnabled;
  40854. /**
  40855. * Are anisotropic textures enabled in the application.
  40856. */
  40857. static AnisotropicTextureEnabled: boolean;
  40858. private static _ThicknessTextureEnabled;
  40859. /**
  40860. * Are thickness textures enabled in the application.
  40861. */
  40862. static ThicknessTextureEnabled: boolean;
  40863. }
  40864. }
  40865. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  40866. /** @hidden */
  40867. export var defaultFragmentDeclaration: {
  40868. name: string;
  40869. shader: string;
  40870. };
  40871. }
  40872. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  40873. /** @hidden */
  40874. export var defaultUboDeclaration: {
  40875. name: string;
  40876. shader: string;
  40877. };
  40878. }
  40879. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  40880. /** @hidden */
  40881. export var lightFragmentDeclaration: {
  40882. name: string;
  40883. shader: string;
  40884. };
  40885. }
  40886. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  40887. /** @hidden */
  40888. export var lightUboDeclaration: {
  40889. name: string;
  40890. shader: string;
  40891. };
  40892. }
  40893. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  40894. /** @hidden */
  40895. export var lightsFragmentFunctions: {
  40896. name: string;
  40897. shader: string;
  40898. };
  40899. }
  40900. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  40901. /** @hidden */
  40902. export var shadowsFragmentFunctions: {
  40903. name: string;
  40904. shader: string;
  40905. };
  40906. }
  40907. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  40908. /** @hidden */
  40909. export var fresnelFunction: {
  40910. name: string;
  40911. shader: string;
  40912. };
  40913. }
  40914. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  40915. /** @hidden */
  40916. export var reflectionFunction: {
  40917. name: string;
  40918. shader: string;
  40919. };
  40920. }
  40921. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  40922. /** @hidden */
  40923. export var bumpFragmentFunctions: {
  40924. name: string;
  40925. shader: string;
  40926. };
  40927. }
  40928. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  40929. /** @hidden */
  40930. export var logDepthDeclaration: {
  40931. name: string;
  40932. shader: string;
  40933. };
  40934. }
  40935. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  40936. /** @hidden */
  40937. export var bumpFragment: {
  40938. name: string;
  40939. shader: string;
  40940. };
  40941. }
  40942. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  40943. /** @hidden */
  40944. export var depthPrePass: {
  40945. name: string;
  40946. shader: string;
  40947. };
  40948. }
  40949. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  40950. /** @hidden */
  40951. export var lightFragment: {
  40952. name: string;
  40953. shader: string;
  40954. };
  40955. }
  40956. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  40957. /** @hidden */
  40958. export var logDepthFragment: {
  40959. name: string;
  40960. shader: string;
  40961. };
  40962. }
  40963. declare module "babylonjs/Shaders/default.fragment" {
  40964. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  40965. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  40966. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  40967. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  40968. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  40969. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  40970. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  40971. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  40972. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  40973. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  40974. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  40975. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  40976. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  40977. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  40978. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  40979. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  40980. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  40981. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  40982. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  40983. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  40984. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  40985. /** @hidden */
  40986. export var defaultPixelShader: {
  40987. name: string;
  40988. shader: string;
  40989. };
  40990. }
  40991. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  40992. /** @hidden */
  40993. export var defaultVertexDeclaration: {
  40994. name: string;
  40995. shader: string;
  40996. };
  40997. }
  40998. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  40999. /** @hidden */
  41000. export var bumpVertexDeclaration: {
  41001. name: string;
  41002. shader: string;
  41003. };
  41004. }
  41005. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41006. /** @hidden */
  41007. export var bumpVertex: {
  41008. name: string;
  41009. shader: string;
  41010. };
  41011. }
  41012. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41013. /** @hidden */
  41014. export var fogVertex: {
  41015. name: string;
  41016. shader: string;
  41017. };
  41018. }
  41019. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41020. /** @hidden */
  41021. export var shadowsVertex: {
  41022. name: string;
  41023. shader: string;
  41024. };
  41025. }
  41026. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41027. /** @hidden */
  41028. export var pointCloudVertex: {
  41029. name: string;
  41030. shader: string;
  41031. };
  41032. }
  41033. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41034. /** @hidden */
  41035. export var logDepthVertex: {
  41036. name: string;
  41037. shader: string;
  41038. };
  41039. }
  41040. declare module "babylonjs/Shaders/default.vertex" {
  41041. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41042. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41043. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41044. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41045. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41046. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41047. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41048. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41049. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41050. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41051. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41052. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41053. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41054. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41055. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41056. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41057. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41058. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41059. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41060. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41061. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41062. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41063. /** @hidden */
  41064. export var defaultVertexShader: {
  41065. name: string;
  41066. shader: string;
  41067. };
  41068. }
  41069. declare module "babylonjs/Materials/standardMaterial" {
  41070. import { SmartArray } from "babylonjs/Misc/smartArray";
  41071. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  41072. import { Nullable } from "babylonjs/types";
  41073. import { Scene } from "babylonjs/scene";
  41074. import { Matrix } from "babylonjs/Maths/math.vector";
  41075. import { Color3 } from "babylonjs/Maths/math.color";
  41076. import { SubMesh } from "babylonjs/Meshes/subMesh";
  41077. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41078. import { Mesh } from "babylonjs/Meshes/mesh";
  41079. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  41080. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41081. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  41082. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  41083. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  41084. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41085. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41086. import "babylonjs/Shaders/default.fragment";
  41087. import "babylonjs/Shaders/default.vertex";
  41088. /** @hidden */
  41089. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  41090. MAINUV1: boolean;
  41091. MAINUV2: boolean;
  41092. DIFFUSE: boolean;
  41093. DIFFUSEDIRECTUV: number;
  41094. AMBIENT: boolean;
  41095. AMBIENTDIRECTUV: number;
  41096. OPACITY: boolean;
  41097. OPACITYDIRECTUV: number;
  41098. OPACITYRGB: boolean;
  41099. REFLECTION: boolean;
  41100. EMISSIVE: boolean;
  41101. EMISSIVEDIRECTUV: number;
  41102. SPECULAR: boolean;
  41103. SPECULARDIRECTUV: number;
  41104. BUMP: boolean;
  41105. BUMPDIRECTUV: number;
  41106. PARALLAX: boolean;
  41107. PARALLAXOCCLUSION: boolean;
  41108. SPECULAROVERALPHA: boolean;
  41109. CLIPPLANE: boolean;
  41110. CLIPPLANE2: boolean;
  41111. CLIPPLANE3: boolean;
  41112. CLIPPLANE4: boolean;
  41113. ALPHATEST: boolean;
  41114. DEPTHPREPASS: boolean;
  41115. ALPHAFROMDIFFUSE: boolean;
  41116. POINTSIZE: boolean;
  41117. FOG: boolean;
  41118. SPECULARTERM: boolean;
  41119. DIFFUSEFRESNEL: boolean;
  41120. OPACITYFRESNEL: boolean;
  41121. REFLECTIONFRESNEL: boolean;
  41122. REFRACTIONFRESNEL: boolean;
  41123. EMISSIVEFRESNEL: boolean;
  41124. FRESNEL: boolean;
  41125. NORMAL: boolean;
  41126. UV1: boolean;
  41127. UV2: boolean;
  41128. VERTEXCOLOR: boolean;
  41129. VERTEXALPHA: boolean;
  41130. NUM_BONE_INFLUENCERS: number;
  41131. BonesPerMesh: number;
  41132. BONETEXTURE: boolean;
  41133. INSTANCES: boolean;
  41134. GLOSSINESS: boolean;
  41135. ROUGHNESS: boolean;
  41136. EMISSIVEASILLUMINATION: boolean;
  41137. LINKEMISSIVEWITHDIFFUSE: boolean;
  41138. REFLECTIONFRESNELFROMSPECULAR: boolean;
  41139. LIGHTMAP: boolean;
  41140. LIGHTMAPDIRECTUV: number;
  41141. OBJECTSPACE_NORMALMAP: boolean;
  41142. USELIGHTMAPASSHADOWMAP: boolean;
  41143. REFLECTIONMAP_3D: boolean;
  41144. REFLECTIONMAP_SPHERICAL: boolean;
  41145. REFLECTIONMAP_PLANAR: boolean;
  41146. REFLECTIONMAP_CUBIC: boolean;
  41147. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  41148. REFLECTIONMAP_PROJECTION: boolean;
  41149. REFLECTIONMAP_SKYBOX: boolean;
  41150. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  41151. REFLECTIONMAP_EXPLICIT: boolean;
  41152. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  41153. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  41154. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  41155. INVERTCUBICMAP: boolean;
  41156. LOGARITHMICDEPTH: boolean;
  41157. REFRACTION: boolean;
  41158. REFRACTIONMAP_3D: boolean;
  41159. REFLECTIONOVERALPHA: boolean;
  41160. TWOSIDEDLIGHTING: boolean;
  41161. SHADOWFLOAT: boolean;
  41162. MORPHTARGETS: boolean;
  41163. MORPHTARGETS_NORMAL: boolean;
  41164. MORPHTARGETS_TANGENT: boolean;
  41165. MORPHTARGETS_UV: boolean;
  41166. NUM_MORPH_INFLUENCERS: number;
  41167. NONUNIFORMSCALING: boolean;
  41168. PREMULTIPLYALPHA: boolean;
  41169. IMAGEPROCESSING: boolean;
  41170. VIGNETTE: boolean;
  41171. VIGNETTEBLENDMODEMULTIPLY: boolean;
  41172. VIGNETTEBLENDMODEOPAQUE: boolean;
  41173. TONEMAPPING: boolean;
  41174. TONEMAPPING_ACES: boolean;
  41175. CONTRAST: boolean;
  41176. COLORCURVES: boolean;
  41177. COLORGRADING: boolean;
  41178. COLORGRADING3D: boolean;
  41179. SAMPLER3DGREENDEPTH: boolean;
  41180. SAMPLER3DBGRMAP: boolean;
  41181. IMAGEPROCESSINGPOSTPROCESS: boolean;
  41182. MULTIVIEW: boolean;
  41183. /**
  41184. * If the reflection texture on this material is in linear color space
  41185. * @hidden
  41186. */
  41187. IS_REFLECTION_LINEAR: boolean;
  41188. /**
  41189. * If the refraction texture on this material is in linear color space
  41190. * @hidden
  41191. */
  41192. IS_REFRACTION_LINEAR: boolean;
  41193. EXPOSURE: boolean;
  41194. constructor();
  41195. setReflectionMode(modeToEnable: string): void;
  41196. }
  41197. /**
  41198. * This is the default material used in Babylon. It is the best trade off between quality
  41199. * and performances.
  41200. * @see http://doc.babylonjs.com/babylon101/materials
  41201. */
  41202. export class StandardMaterial extends PushMaterial {
  41203. private _diffuseTexture;
  41204. /**
  41205. * The basic texture of the material as viewed under a light.
  41206. */
  41207. diffuseTexture: Nullable<BaseTexture>;
  41208. private _ambientTexture;
  41209. /**
  41210. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  41211. */
  41212. ambientTexture: Nullable<BaseTexture>;
  41213. private _opacityTexture;
  41214. /**
  41215. * Define the transparency of the material from a texture.
  41216. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  41217. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  41218. */
  41219. opacityTexture: Nullable<BaseTexture>;
  41220. private _reflectionTexture;
  41221. /**
  41222. * Define the texture used to display the reflection.
  41223. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41224. */
  41225. reflectionTexture: Nullable<BaseTexture>;
  41226. private _emissiveTexture;
  41227. /**
  41228. * Define texture of the material as if self lit.
  41229. * This will be mixed in the final result even in the absence of light.
  41230. */
  41231. emissiveTexture: Nullable<BaseTexture>;
  41232. private _specularTexture;
  41233. /**
  41234. * Define how the color and intensity of the highlight given by the light in the material.
  41235. */
  41236. specularTexture: Nullable<BaseTexture>;
  41237. private _bumpTexture;
  41238. /**
  41239. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  41240. * 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.
  41241. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  41242. */
  41243. bumpTexture: Nullable<BaseTexture>;
  41244. private _lightmapTexture;
  41245. /**
  41246. * Complex lighting can be computationally expensive to compute at runtime.
  41247. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  41248. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  41249. */
  41250. lightmapTexture: Nullable<BaseTexture>;
  41251. private _refractionTexture;
  41252. /**
  41253. * Define the texture used to display the refraction.
  41254. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41255. */
  41256. refractionTexture: Nullable<BaseTexture>;
  41257. /**
  41258. * The color of the material lit by the environmental background lighting.
  41259. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  41260. */
  41261. ambientColor: Color3;
  41262. /**
  41263. * The basic color of the material as viewed under a light.
  41264. */
  41265. diffuseColor: Color3;
  41266. /**
  41267. * Define how the color and intensity of the highlight given by the light in the material.
  41268. */
  41269. specularColor: Color3;
  41270. /**
  41271. * Define the color of the material as if self lit.
  41272. * This will be mixed in the final result even in the absence of light.
  41273. */
  41274. emissiveColor: Color3;
  41275. /**
  41276. * Defines how sharp are the highlights in the material.
  41277. * The bigger the value the sharper giving a more glossy feeling to the result.
  41278. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  41279. */
  41280. specularPower: number;
  41281. private _useAlphaFromDiffuseTexture;
  41282. /**
  41283. * Does the transparency come from the diffuse texture alpha channel.
  41284. */
  41285. useAlphaFromDiffuseTexture: boolean;
  41286. private _useEmissiveAsIllumination;
  41287. /**
  41288. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  41289. */
  41290. useEmissiveAsIllumination: boolean;
  41291. private _linkEmissiveWithDiffuse;
  41292. /**
  41293. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  41294. * the emissive level when the final color is close to one.
  41295. */
  41296. linkEmissiveWithDiffuse: boolean;
  41297. private _useSpecularOverAlpha;
  41298. /**
  41299. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  41300. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  41301. */
  41302. useSpecularOverAlpha: boolean;
  41303. private _useReflectionOverAlpha;
  41304. /**
  41305. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  41306. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  41307. */
  41308. useReflectionOverAlpha: boolean;
  41309. private _disableLighting;
  41310. /**
  41311. * Does lights from the scene impacts this material.
  41312. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  41313. */
  41314. disableLighting: boolean;
  41315. private _useObjectSpaceNormalMap;
  41316. /**
  41317. * Allows using an object space normal map (instead of tangent space).
  41318. */
  41319. useObjectSpaceNormalMap: boolean;
  41320. private _useParallax;
  41321. /**
  41322. * Is parallax enabled or not.
  41323. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41324. */
  41325. useParallax: boolean;
  41326. private _useParallaxOcclusion;
  41327. /**
  41328. * Is parallax occlusion enabled or not.
  41329. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  41330. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41331. */
  41332. useParallaxOcclusion: boolean;
  41333. /**
  41334. * 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.
  41335. */
  41336. parallaxScaleBias: number;
  41337. private _roughness;
  41338. /**
  41339. * Helps to define how blurry the reflections should appears in the material.
  41340. */
  41341. roughness: number;
  41342. /**
  41343. * In case of refraction, define the value of the index of refraction.
  41344. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41345. */
  41346. indexOfRefraction: number;
  41347. /**
  41348. * Invert the refraction texture alongside the y axis.
  41349. * It can be useful with procedural textures or probe for instance.
  41350. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41351. */
  41352. invertRefractionY: boolean;
  41353. /**
  41354. * Defines the alpha limits in alpha test mode.
  41355. */
  41356. alphaCutOff: number;
  41357. private _useLightmapAsShadowmap;
  41358. /**
  41359. * In case of light mapping, define whether the map contains light or shadow informations.
  41360. */
  41361. useLightmapAsShadowmap: boolean;
  41362. private _diffuseFresnelParameters;
  41363. /**
  41364. * Define the diffuse fresnel parameters of the material.
  41365. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41366. */
  41367. diffuseFresnelParameters: FresnelParameters;
  41368. private _opacityFresnelParameters;
  41369. /**
  41370. * Define the opacity fresnel parameters of the material.
  41371. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41372. */
  41373. opacityFresnelParameters: FresnelParameters;
  41374. private _reflectionFresnelParameters;
  41375. /**
  41376. * Define the reflection fresnel parameters of the material.
  41377. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41378. */
  41379. reflectionFresnelParameters: FresnelParameters;
  41380. private _refractionFresnelParameters;
  41381. /**
  41382. * Define the refraction fresnel parameters of the material.
  41383. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41384. */
  41385. refractionFresnelParameters: FresnelParameters;
  41386. private _emissiveFresnelParameters;
  41387. /**
  41388. * Define the emissive fresnel parameters of the material.
  41389. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41390. */
  41391. emissiveFresnelParameters: FresnelParameters;
  41392. private _useReflectionFresnelFromSpecular;
  41393. /**
  41394. * If true automatically deducts the fresnels values from the material specularity.
  41395. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41396. */
  41397. useReflectionFresnelFromSpecular: boolean;
  41398. private _useGlossinessFromSpecularMapAlpha;
  41399. /**
  41400. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  41401. */
  41402. useGlossinessFromSpecularMapAlpha: boolean;
  41403. private _maxSimultaneousLights;
  41404. /**
  41405. * Defines the maximum number of lights that can be used in the material
  41406. */
  41407. maxSimultaneousLights: number;
  41408. private _invertNormalMapX;
  41409. /**
  41410. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  41411. */
  41412. invertNormalMapX: boolean;
  41413. private _invertNormalMapY;
  41414. /**
  41415. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  41416. */
  41417. invertNormalMapY: boolean;
  41418. private _twoSidedLighting;
  41419. /**
  41420. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  41421. */
  41422. twoSidedLighting: boolean;
  41423. /**
  41424. * Default configuration related to image processing available in the standard Material.
  41425. */
  41426. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  41427. /**
  41428. * Gets the image processing configuration used either in this material.
  41429. */
  41430. /**
  41431. * Sets the Default image processing configuration used either in the this material.
  41432. *
  41433. * If sets to null, the scene one is in use.
  41434. */
  41435. imageProcessingConfiguration: ImageProcessingConfiguration;
  41436. /**
  41437. * Keep track of the image processing observer to allow dispose and replace.
  41438. */
  41439. private _imageProcessingObserver;
  41440. /**
  41441. * Attaches a new image processing configuration to the Standard Material.
  41442. * @param configuration
  41443. */
  41444. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  41445. /**
  41446. * Gets wether the color curves effect is enabled.
  41447. */
  41448. /**
  41449. * Sets wether the color curves effect is enabled.
  41450. */
  41451. cameraColorCurvesEnabled: boolean;
  41452. /**
  41453. * Gets wether the color grading effect is enabled.
  41454. */
  41455. /**
  41456. * Gets wether the color grading effect is enabled.
  41457. */
  41458. cameraColorGradingEnabled: boolean;
  41459. /**
  41460. * Gets wether tonemapping is enabled or not.
  41461. */
  41462. /**
  41463. * Sets wether tonemapping is enabled or not
  41464. */
  41465. cameraToneMappingEnabled: boolean;
  41466. /**
  41467. * The camera exposure used on this material.
  41468. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  41469. * This corresponds to a photographic exposure.
  41470. */
  41471. /**
  41472. * The camera exposure used on this material.
  41473. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  41474. * This corresponds to a photographic exposure.
  41475. */
  41476. cameraExposure: number;
  41477. /**
  41478. * Gets The camera contrast used on this material.
  41479. */
  41480. /**
  41481. * Sets The camera contrast used on this material.
  41482. */
  41483. cameraContrast: number;
  41484. /**
  41485. * Gets the Color Grading 2D Lookup Texture.
  41486. */
  41487. /**
  41488. * Sets the Color Grading 2D Lookup Texture.
  41489. */
  41490. cameraColorGradingTexture: Nullable<BaseTexture>;
  41491. /**
  41492. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  41493. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  41494. * 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;
  41495. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  41496. */
  41497. /**
  41498. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  41499. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  41500. * 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;
  41501. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  41502. */
  41503. cameraColorCurves: Nullable<ColorCurves>;
  41504. /**
  41505. * Custom callback helping to override the default shader used in the material.
  41506. */
  41507. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  41508. protected _renderTargets: SmartArray<RenderTargetTexture>;
  41509. protected _worldViewProjectionMatrix: Matrix;
  41510. protected _globalAmbientColor: Color3;
  41511. protected _useLogarithmicDepth: boolean;
  41512. /**
  41513. * Instantiates a new standard material.
  41514. * This is the default material used in Babylon. It is the best trade off between quality
  41515. * and performances.
  41516. * @see http://doc.babylonjs.com/babylon101/materials
  41517. * @param name Define the name of the material in the scene
  41518. * @param scene Define the scene the material belong to
  41519. */
  41520. constructor(name: string, scene: Scene);
  41521. /**
  41522. * Gets a boolean indicating that current material needs to register RTT
  41523. */
  41524. readonly hasRenderTargetTextures: boolean;
  41525. /**
  41526. * Gets the current class name of the material e.g. "StandardMaterial"
  41527. * Mainly use in serialization.
  41528. * @returns the class name
  41529. */
  41530. getClassName(): string;
  41531. /**
  41532. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  41533. * You can try switching to logarithmic depth.
  41534. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  41535. */
  41536. useLogarithmicDepth: boolean;
  41537. /**
  41538. * Specifies if the material will require alpha blending
  41539. * @returns a boolean specifying if alpha blending is needed
  41540. */
  41541. needAlphaBlending(): boolean;
  41542. /**
  41543. * Specifies if this material should be rendered in alpha test mode
  41544. * @returns a boolean specifying if an alpha test is needed.
  41545. */
  41546. needAlphaTesting(): boolean;
  41547. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  41548. /**
  41549. * Get the texture used for alpha test purpose.
  41550. * @returns the diffuse texture in case of the standard material.
  41551. */
  41552. getAlphaTestTexture(): Nullable<BaseTexture>;
  41553. /**
  41554. * Get if the submesh is ready to be used and all its information available.
  41555. * Child classes can use it to update shaders
  41556. * @param mesh defines the mesh to check
  41557. * @param subMesh defines which submesh to check
  41558. * @param useInstances specifies that instances should be used
  41559. * @returns a boolean indicating that the submesh is ready or not
  41560. */
  41561. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  41562. /**
  41563. * Builds the material UBO layouts.
  41564. * Used internally during the effect preparation.
  41565. */
  41566. buildUniformLayout(): void;
  41567. /**
  41568. * Unbinds the material from the mesh
  41569. */
  41570. unbind(): void;
  41571. /**
  41572. * Binds the submesh to this material by preparing the effect and shader to draw
  41573. * @param world defines the world transformation matrix
  41574. * @param mesh defines the mesh containing the submesh
  41575. * @param subMesh defines the submesh to bind the material to
  41576. */
  41577. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  41578. /**
  41579. * Get the list of animatables in the material.
  41580. * @returns the list of animatables object used in the material
  41581. */
  41582. getAnimatables(): IAnimatable[];
  41583. /**
  41584. * Gets the active textures from the material
  41585. * @returns an array of textures
  41586. */
  41587. getActiveTextures(): BaseTexture[];
  41588. /**
  41589. * Specifies if the material uses a texture
  41590. * @param texture defines the texture to check against the material
  41591. * @returns a boolean specifying if the material uses the texture
  41592. */
  41593. hasTexture(texture: BaseTexture): boolean;
  41594. /**
  41595. * Disposes the material
  41596. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  41597. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  41598. */
  41599. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  41600. /**
  41601. * Makes a duplicate of the material, and gives it a new name
  41602. * @param name defines the new name for the duplicated material
  41603. * @returns the cloned material
  41604. */
  41605. clone(name: string): StandardMaterial;
  41606. /**
  41607. * Serializes this material in a JSON representation
  41608. * @returns the serialized material object
  41609. */
  41610. serialize(): any;
  41611. /**
  41612. * Creates a standard material from parsed material data
  41613. * @param source defines the JSON representation of the material
  41614. * @param scene defines the hosting scene
  41615. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  41616. * @returns a new standard material
  41617. */
  41618. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  41619. /**
  41620. * Are diffuse textures enabled in the application.
  41621. */
  41622. static DiffuseTextureEnabled: boolean;
  41623. /**
  41624. * Are ambient textures enabled in the application.
  41625. */
  41626. static AmbientTextureEnabled: boolean;
  41627. /**
  41628. * Are opacity textures enabled in the application.
  41629. */
  41630. static OpacityTextureEnabled: boolean;
  41631. /**
  41632. * Are reflection textures enabled in the application.
  41633. */
  41634. static ReflectionTextureEnabled: boolean;
  41635. /**
  41636. * Are emissive textures enabled in the application.
  41637. */
  41638. static EmissiveTextureEnabled: boolean;
  41639. /**
  41640. * Are specular textures enabled in the application.
  41641. */
  41642. static SpecularTextureEnabled: boolean;
  41643. /**
  41644. * Are bump textures enabled in the application.
  41645. */
  41646. static BumpTextureEnabled: boolean;
  41647. /**
  41648. * Are lightmap textures enabled in the application.
  41649. */
  41650. static LightmapTextureEnabled: boolean;
  41651. /**
  41652. * Are refraction textures enabled in the application.
  41653. */
  41654. static RefractionTextureEnabled: boolean;
  41655. /**
  41656. * Are color grading textures enabled in the application.
  41657. */
  41658. static ColorGradingTextureEnabled: boolean;
  41659. /**
  41660. * Are fresnels enabled in the application.
  41661. */
  41662. static FresnelEnabled: boolean;
  41663. }
  41664. }
  41665. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  41666. import { Scene } from "babylonjs/scene";
  41667. import { Texture } from "babylonjs/Materials/Textures/texture";
  41668. /**
  41669. * A class extending Texture allowing drawing on a texture
  41670. * @see http://doc.babylonjs.com/how_to/dynamictexture
  41671. */
  41672. export class DynamicTexture extends Texture {
  41673. private _generateMipMaps;
  41674. private _canvas;
  41675. private _context;
  41676. private _engine;
  41677. /**
  41678. * Creates a DynamicTexture
  41679. * @param name defines the name of the texture
  41680. * @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
  41681. * @param scene defines the scene where you want the texture
  41682. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  41683. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  41684. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  41685. */
  41686. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  41687. /**
  41688. * Get the current class name of the texture useful for serialization or dynamic coding.
  41689. * @returns "DynamicTexture"
  41690. */
  41691. getClassName(): string;
  41692. /**
  41693. * Gets the current state of canRescale
  41694. */
  41695. readonly canRescale: boolean;
  41696. private _recreate;
  41697. /**
  41698. * Scales the texture
  41699. * @param ratio the scale factor to apply to both width and height
  41700. */
  41701. scale(ratio: number): void;
  41702. /**
  41703. * Resizes the texture
  41704. * @param width the new width
  41705. * @param height the new height
  41706. */
  41707. scaleTo(width: number, height: number): void;
  41708. /**
  41709. * Gets the context of the canvas used by the texture
  41710. * @returns the canvas context of the dynamic texture
  41711. */
  41712. getContext(): CanvasRenderingContext2D;
  41713. /**
  41714. * Clears the texture
  41715. */
  41716. clear(): void;
  41717. /**
  41718. * Updates the texture
  41719. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  41720. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  41721. */
  41722. update(invertY?: boolean, premulAlpha?: boolean): void;
  41723. /**
  41724. * Draws text onto the texture
  41725. * @param text defines the text to be drawn
  41726. * @param x defines the placement of the text from the left
  41727. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  41728. * @param font defines the font to be used with font-style, font-size, font-name
  41729. * @param color defines the color used for the text
  41730. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  41731. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  41732. * @param update defines whether texture is immediately update (default is true)
  41733. */
  41734. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  41735. /**
  41736. * Clones the texture
  41737. * @returns the clone of the texture.
  41738. */
  41739. clone(): DynamicTexture;
  41740. /**
  41741. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  41742. * @returns a serialized dynamic texture object
  41743. */
  41744. serialize(): any;
  41745. /** @hidden */
  41746. _rebuild(): void;
  41747. }
  41748. }
  41749. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  41750. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41751. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41752. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41753. /** @hidden */
  41754. export var imageProcessingPixelShader: {
  41755. name: string;
  41756. shader: string;
  41757. };
  41758. }
  41759. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  41760. import { Nullable } from "babylonjs/types";
  41761. import { Color4 } from "babylonjs/Maths/math.color";
  41762. import { Camera } from "babylonjs/Cameras/camera";
  41763. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41764. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41765. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  41766. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41767. import { Engine } from "babylonjs/Engines/engine";
  41768. import "babylonjs/Shaders/imageProcessing.fragment";
  41769. import "babylonjs/Shaders/postprocess.vertex";
  41770. /**
  41771. * ImageProcessingPostProcess
  41772. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  41773. */
  41774. export class ImageProcessingPostProcess extends PostProcess {
  41775. /**
  41776. * Default configuration related to image processing available in the PBR Material.
  41777. */
  41778. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  41779. /**
  41780. * Gets the image processing configuration used either in this material.
  41781. */
  41782. /**
  41783. * Sets the Default image processing configuration used either in the this material.
  41784. *
  41785. * If sets to null, the scene one is in use.
  41786. */
  41787. imageProcessingConfiguration: ImageProcessingConfiguration;
  41788. /**
  41789. * Keep track of the image processing observer to allow dispose and replace.
  41790. */
  41791. private _imageProcessingObserver;
  41792. /**
  41793. * Attaches a new image processing configuration to the PBR Material.
  41794. * @param configuration
  41795. */
  41796. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  41797. /**
  41798. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  41799. */
  41800. /**
  41801. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  41802. */
  41803. colorCurves: Nullable<ColorCurves>;
  41804. /**
  41805. * Gets wether the color curves effect is enabled.
  41806. */
  41807. /**
  41808. * Sets wether the color curves effect is enabled.
  41809. */
  41810. colorCurvesEnabled: boolean;
  41811. /**
  41812. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  41813. */
  41814. /**
  41815. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  41816. */
  41817. colorGradingTexture: Nullable<BaseTexture>;
  41818. /**
  41819. * Gets wether the color grading effect is enabled.
  41820. */
  41821. /**
  41822. * Gets wether the color grading effect is enabled.
  41823. */
  41824. colorGradingEnabled: boolean;
  41825. /**
  41826. * Gets exposure used in the effect.
  41827. */
  41828. /**
  41829. * Sets exposure used in the effect.
  41830. */
  41831. exposure: number;
  41832. /**
  41833. * Gets wether tonemapping is enabled or not.
  41834. */
  41835. /**
  41836. * Sets wether tonemapping is enabled or not
  41837. */
  41838. toneMappingEnabled: boolean;
  41839. /**
  41840. * Gets the type of tone mapping effect.
  41841. */
  41842. /**
  41843. * Sets the type of tone mapping effect.
  41844. */
  41845. toneMappingType: number;
  41846. /**
  41847. * Gets contrast used in the effect.
  41848. */
  41849. /**
  41850. * Sets contrast used in the effect.
  41851. */
  41852. contrast: number;
  41853. /**
  41854. * Gets Vignette stretch size.
  41855. */
  41856. /**
  41857. * Sets Vignette stretch size.
  41858. */
  41859. vignetteStretch: number;
  41860. /**
  41861. * Gets Vignette centre X Offset.
  41862. */
  41863. /**
  41864. * Sets Vignette centre X Offset.
  41865. */
  41866. vignetteCentreX: number;
  41867. /**
  41868. * Gets Vignette centre Y Offset.
  41869. */
  41870. /**
  41871. * Sets Vignette centre Y Offset.
  41872. */
  41873. vignetteCentreY: number;
  41874. /**
  41875. * Gets Vignette weight or intensity of the vignette effect.
  41876. */
  41877. /**
  41878. * Sets Vignette weight or intensity of the vignette effect.
  41879. */
  41880. vignetteWeight: number;
  41881. /**
  41882. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  41883. * if vignetteEnabled is set to true.
  41884. */
  41885. /**
  41886. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  41887. * if vignetteEnabled is set to true.
  41888. */
  41889. vignetteColor: Color4;
  41890. /**
  41891. * Gets Camera field of view used by the Vignette effect.
  41892. */
  41893. /**
  41894. * Sets Camera field of view used by the Vignette effect.
  41895. */
  41896. vignetteCameraFov: number;
  41897. /**
  41898. * Gets the vignette blend mode allowing different kind of effect.
  41899. */
  41900. /**
  41901. * Sets the vignette blend mode allowing different kind of effect.
  41902. */
  41903. vignetteBlendMode: number;
  41904. /**
  41905. * Gets wether the vignette effect is enabled.
  41906. */
  41907. /**
  41908. * Sets wether the vignette effect is enabled.
  41909. */
  41910. vignetteEnabled: boolean;
  41911. private _fromLinearSpace;
  41912. /**
  41913. * Gets wether the input of the processing is in Gamma or Linear Space.
  41914. */
  41915. /**
  41916. * Sets wether the input of the processing is in Gamma or Linear Space.
  41917. */
  41918. fromLinearSpace: boolean;
  41919. /**
  41920. * Defines cache preventing GC.
  41921. */
  41922. private _defines;
  41923. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  41924. /**
  41925. * "ImageProcessingPostProcess"
  41926. * @returns "ImageProcessingPostProcess"
  41927. */
  41928. getClassName(): string;
  41929. protected _updateParameters(): void;
  41930. dispose(camera?: Camera): void;
  41931. }
  41932. }
  41933. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  41934. import { Scene } from "babylonjs/scene";
  41935. import { Color3 } from "babylonjs/Maths/math.color";
  41936. import { Mesh } from "babylonjs/Meshes/mesh";
  41937. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  41938. import { Nullable } from "babylonjs/types";
  41939. /**
  41940. * Class containing static functions to help procedurally build meshes
  41941. */
  41942. export class GroundBuilder {
  41943. /**
  41944. * Creates a ground mesh
  41945. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  41946. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  41947. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  41948. * @param name defines the name of the mesh
  41949. * @param options defines the options used to create the mesh
  41950. * @param scene defines the hosting scene
  41951. * @returns the ground mesh
  41952. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  41953. */
  41954. static CreateGround(name: string, options: {
  41955. width?: number;
  41956. height?: number;
  41957. subdivisions?: number;
  41958. subdivisionsX?: number;
  41959. subdivisionsY?: number;
  41960. updatable?: boolean;
  41961. }, scene: any): Mesh;
  41962. /**
  41963. * Creates a tiled ground mesh
  41964. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  41965. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  41966. * * 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
  41967. * * 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
  41968. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  41969. * @param name defines the name of the mesh
  41970. * @param options defines the options used to create the mesh
  41971. * @param scene defines the hosting scene
  41972. * @returns the tiled ground mesh
  41973. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  41974. */
  41975. static CreateTiledGround(name: string, options: {
  41976. xmin: number;
  41977. zmin: number;
  41978. xmax: number;
  41979. zmax: number;
  41980. subdivisions?: {
  41981. w: number;
  41982. h: number;
  41983. };
  41984. precision?: {
  41985. w: number;
  41986. h: number;
  41987. };
  41988. updatable?: boolean;
  41989. }, scene?: Nullable<Scene>): Mesh;
  41990. /**
  41991. * Creates a ground mesh from a height map
  41992. * * The parameter `url` sets the URL of the height map image resource.
  41993. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  41994. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  41995. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  41996. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  41997. * * 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.
  41998. * * 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).
  41999. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42000. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42001. * @param name defines the name of the mesh
  42002. * @param url defines the url to the height map
  42003. * @param options defines the options used to create the mesh
  42004. * @param scene defines the hosting scene
  42005. * @returns the ground mesh
  42006. * @see https://doc.babylonjs.com/babylon101/height_map
  42007. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42008. */
  42009. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42010. width?: number;
  42011. height?: number;
  42012. subdivisions?: number;
  42013. minHeight?: number;
  42014. maxHeight?: number;
  42015. colorFilter?: Color3;
  42016. alphaFilter?: number;
  42017. updatable?: boolean;
  42018. onReady?: (mesh: GroundMesh) => void;
  42019. }, scene?: Nullable<Scene>): GroundMesh;
  42020. }
  42021. }
  42022. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42023. import { Vector4 } from "babylonjs/Maths/math.vector";
  42024. import { Mesh } from "babylonjs/Meshes/mesh";
  42025. /**
  42026. * Class containing static functions to help procedurally build meshes
  42027. */
  42028. export class TorusBuilder {
  42029. /**
  42030. * Creates a torus mesh
  42031. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42032. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42033. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42034. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42035. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42036. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42037. * @param name defines the name of the mesh
  42038. * @param options defines the options used to create the mesh
  42039. * @param scene defines the hosting scene
  42040. * @returns the torus mesh
  42041. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42042. */
  42043. static CreateTorus(name: string, options: {
  42044. diameter?: number;
  42045. thickness?: number;
  42046. tessellation?: number;
  42047. updatable?: boolean;
  42048. sideOrientation?: number;
  42049. frontUVs?: Vector4;
  42050. backUVs?: Vector4;
  42051. }, scene: any): Mesh;
  42052. }
  42053. }
  42054. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42055. import { Vector4 } from "babylonjs/Maths/math.vector";
  42056. import { Color4 } from "babylonjs/Maths/math.color";
  42057. import { Mesh } from "babylonjs/Meshes/mesh";
  42058. /**
  42059. * Class containing static functions to help procedurally build meshes
  42060. */
  42061. export class CylinderBuilder {
  42062. /**
  42063. * Creates a cylinder or a cone mesh
  42064. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42065. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42066. * * 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.
  42067. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42068. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42069. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42070. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42071. * * 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).
  42072. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42073. * * 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).
  42074. * * 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
  42075. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42076. * * 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
  42077. * * 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.
  42078. * * If `enclose` is false, a ring surface is one element.
  42079. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42080. * * 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
  42081. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42082. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42083. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42084. * @param name defines the name of the mesh
  42085. * @param options defines the options used to create the mesh
  42086. * @param scene defines the hosting scene
  42087. * @returns the cylinder mesh
  42088. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42089. */
  42090. static CreateCylinder(name: string, options: {
  42091. height?: number;
  42092. diameterTop?: number;
  42093. diameterBottom?: number;
  42094. diameter?: number;
  42095. tessellation?: number;
  42096. subdivisions?: number;
  42097. arc?: number;
  42098. faceColors?: Color4[];
  42099. faceUV?: Vector4[];
  42100. updatable?: boolean;
  42101. hasRings?: boolean;
  42102. enclose?: boolean;
  42103. cap?: number;
  42104. sideOrientation?: number;
  42105. frontUVs?: Vector4;
  42106. backUVs?: Vector4;
  42107. }, scene: any): Mesh;
  42108. }
  42109. }
  42110. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42111. import { Observable } from "babylonjs/Misc/observable";
  42112. import { Nullable } from "babylonjs/types";
  42113. import { Camera } from "babylonjs/Cameras/camera";
  42114. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42115. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42116. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42117. import { Scene } from "babylonjs/scene";
  42118. import { Vector3 } from "babylonjs/Maths/math.vector";
  42119. import { Color3 } from "babylonjs/Maths/math.color";
  42120. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42121. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42122. import { Mesh } from "babylonjs/Meshes/mesh";
  42123. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42124. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42125. import "babylonjs/Meshes/Builders/groundBuilder";
  42126. import "babylonjs/Meshes/Builders/torusBuilder";
  42127. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42128. import "babylonjs/Gamepads/gamepadSceneComponent";
  42129. import "babylonjs/Animations/animatable";
  42130. /**
  42131. * Options to modify the vr teleportation behavior.
  42132. */
  42133. export interface VRTeleportationOptions {
  42134. /**
  42135. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42136. */
  42137. floorMeshName?: string;
  42138. /**
  42139. * A list of meshes to be used as the teleportation floor. (default: empty)
  42140. */
  42141. floorMeshes?: Mesh[];
  42142. }
  42143. /**
  42144. * Options to modify the vr experience helper's behavior.
  42145. */
  42146. export interface VRExperienceHelperOptions extends WebVROptions {
  42147. /**
  42148. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  42149. */
  42150. createDeviceOrientationCamera?: boolean;
  42151. /**
  42152. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  42153. */
  42154. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  42155. /**
  42156. * Uses the main button on the controller to toggle the laser casted. (default: true)
  42157. */
  42158. laserToggle?: boolean;
  42159. /**
  42160. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  42161. */
  42162. floorMeshes?: Mesh[];
  42163. /**
  42164. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  42165. */
  42166. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  42167. }
  42168. /**
  42169. * Event containing information after VR has been entered
  42170. */
  42171. export class OnAfterEnteringVRObservableEvent {
  42172. /**
  42173. * If entering vr was successful
  42174. */
  42175. success: boolean;
  42176. }
  42177. /**
  42178. * Helps to quickly add VR support to an existing scene.
  42179. * See http://doc.babylonjs.com/how_to/webvr_helper
  42180. */
  42181. export class VRExperienceHelper {
  42182. /** Options to modify the vr experience helper's behavior. */
  42183. webVROptions: VRExperienceHelperOptions;
  42184. private _scene;
  42185. private _position;
  42186. private _btnVR;
  42187. private _btnVRDisplayed;
  42188. private _webVRsupported;
  42189. private _webVRready;
  42190. private _webVRrequesting;
  42191. private _webVRpresenting;
  42192. private _hasEnteredVR;
  42193. private _fullscreenVRpresenting;
  42194. private _canvas;
  42195. private _webVRCamera;
  42196. private _vrDeviceOrientationCamera;
  42197. private _deviceOrientationCamera;
  42198. private _existingCamera;
  42199. private _onKeyDown;
  42200. private _onVrDisplayPresentChange;
  42201. private _onVRDisplayChanged;
  42202. private _onVRRequestPresentStart;
  42203. private _onVRRequestPresentComplete;
  42204. /**
  42205. * 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)
  42206. */
  42207. enableGazeEvenWhenNoPointerLock: boolean;
  42208. /**
  42209. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  42210. */
  42211. exitVROnDoubleTap: boolean;
  42212. /**
  42213. * Observable raised right before entering VR.
  42214. */
  42215. onEnteringVRObservable: Observable<VRExperienceHelper>;
  42216. /**
  42217. * Observable raised when entering VR has completed.
  42218. */
  42219. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  42220. /**
  42221. * Observable raised when exiting VR.
  42222. */
  42223. onExitingVRObservable: Observable<VRExperienceHelper>;
  42224. /**
  42225. * Observable raised when controller mesh is loaded.
  42226. */
  42227. onControllerMeshLoadedObservable: Observable<WebVRController>;
  42228. /** Return this.onEnteringVRObservable
  42229. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  42230. */
  42231. readonly onEnteringVR: Observable<VRExperienceHelper>;
  42232. /** Return this.onExitingVRObservable
  42233. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  42234. */
  42235. readonly onExitingVR: Observable<VRExperienceHelper>;
  42236. /** Return this.onControllerMeshLoadedObservable
  42237. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  42238. */
  42239. readonly onControllerMeshLoaded: Observable<WebVRController>;
  42240. private _rayLength;
  42241. private _useCustomVRButton;
  42242. private _teleportationRequested;
  42243. private _teleportActive;
  42244. private _floorMeshName;
  42245. private _floorMeshesCollection;
  42246. private _rotationAllowed;
  42247. private _teleportBackwardsVector;
  42248. private _teleportationTarget;
  42249. private _isDefaultTeleportationTarget;
  42250. private _postProcessMove;
  42251. private _teleportationFillColor;
  42252. private _teleportationBorderColor;
  42253. private _rotationAngle;
  42254. private _haloCenter;
  42255. private _cameraGazer;
  42256. private _padSensibilityUp;
  42257. private _padSensibilityDown;
  42258. private _leftController;
  42259. private _rightController;
  42260. /**
  42261. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  42262. */
  42263. onNewMeshSelected: Observable<AbstractMesh>;
  42264. /**
  42265. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  42266. */
  42267. onNewMeshPicked: Observable<PickingInfo>;
  42268. private _circleEase;
  42269. /**
  42270. * Observable raised before camera teleportation
  42271. */
  42272. onBeforeCameraTeleport: Observable<Vector3>;
  42273. /**
  42274. * Observable raised after camera teleportation
  42275. */
  42276. onAfterCameraTeleport: Observable<Vector3>;
  42277. /**
  42278. * Observable raised when current selected mesh gets unselected
  42279. */
  42280. onSelectedMeshUnselected: Observable<AbstractMesh>;
  42281. private _raySelectionPredicate;
  42282. /**
  42283. * To be optionaly changed by user to define custom ray selection
  42284. */
  42285. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  42286. /**
  42287. * To be optionaly changed by user to define custom selection logic (after ray selection)
  42288. */
  42289. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  42290. /**
  42291. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  42292. */
  42293. teleportationEnabled: boolean;
  42294. private _defaultHeight;
  42295. private _teleportationInitialized;
  42296. private _interactionsEnabled;
  42297. private _interactionsRequested;
  42298. private _displayGaze;
  42299. private _displayLaserPointer;
  42300. /**
  42301. * The mesh used to display where the user is going to teleport.
  42302. */
  42303. /**
  42304. * Sets the mesh to be used to display where the user is going to teleport.
  42305. */
  42306. teleportationTarget: Mesh;
  42307. /**
  42308. * 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
  42309. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  42310. * See http://doc.babylonjs.com/resources/baking_transformations
  42311. */
  42312. gazeTrackerMesh: Mesh;
  42313. /**
  42314. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  42315. */
  42316. updateGazeTrackerScale: boolean;
  42317. /**
  42318. * If the gaze trackers color should be updated when selecting meshes
  42319. */
  42320. updateGazeTrackerColor: boolean;
  42321. /**
  42322. * The gaze tracking mesh corresponding to the left controller
  42323. */
  42324. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  42325. /**
  42326. * The gaze tracking mesh corresponding to the right controller
  42327. */
  42328. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  42329. /**
  42330. * If the ray of the gaze should be displayed.
  42331. */
  42332. /**
  42333. * Sets if the ray of the gaze should be displayed.
  42334. */
  42335. displayGaze: boolean;
  42336. /**
  42337. * If the ray of the LaserPointer should be displayed.
  42338. */
  42339. /**
  42340. * Sets if the ray of the LaserPointer should be displayed.
  42341. */
  42342. displayLaserPointer: boolean;
  42343. /**
  42344. * The deviceOrientationCamera used as the camera when not in VR.
  42345. */
  42346. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  42347. /**
  42348. * Based on the current WebVR support, returns the current VR camera used.
  42349. */
  42350. readonly currentVRCamera: Nullable<Camera>;
  42351. /**
  42352. * The webVRCamera which is used when in VR.
  42353. */
  42354. readonly webVRCamera: WebVRFreeCamera;
  42355. /**
  42356. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  42357. */
  42358. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  42359. /**
  42360. * The html button that is used to trigger entering into VR.
  42361. */
  42362. readonly vrButton: Nullable<HTMLButtonElement>;
  42363. private readonly _teleportationRequestInitiated;
  42364. /**
  42365. * Defines wether or not Pointer lock should be requested when switching to
  42366. * full screen.
  42367. */
  42368. requestPointerLockOnFullScreen: boolean;
  42369. /**
  42370. * Instantiates a VRExperienceHelper.
  42371. * Helps to quickly add VR support to an existing scene.
  42372. * @param scene The scene the VRExperienceHelper belongs to.
  42373. * @param webVROptions Options to modify the vr experience helper's behavior.
  42374. */
  42375. constructor(scene: Scene,
  42376. /** Options to modify the vr experience helper's behavior. */
  42377. webVROptions?: VRExperienceHelperOptions);
  42378. private _onDefaultMeshLoaded;
  42379. private _onResize;
  42380. private _onFullscreenChange;
  42381. /**
  42382. * Gets a value indicating if we are currently in VR mode.
  42383. */
  42384. readonly isInVRMode: boolean;
  42385. private onVrDisplayPresentChange;
  42386. private onVRDisplayChanged;
  42387. private moveButtonToBottomRight;
  42388. private displayVRButton;
  42389. private updateButtonVisibility;
  42390. private _cachedAngularSensibility;
  42391. /**
  42392. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  42393. * Otherwise, will use the fullscreen API.
  42394. */
  42395. enterVR(): void;
  42396. /**
  42397. * Attempt to exit VR, or fullscreen.
  42398. */
  42399. exitVR(): void;
  42400. /**
  42401. * The position of the vr experience helper.
  42402. */
  42403. /**
  42404. * Sets the position of the vr experience helper.
  42405. */
  42406. position: Vector3;
  42407. /**
  42408. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  42409. */
  42410. enableInteractions(): void;
  42411. private readonly _noControllerIsActive;
  42412. private beforeRender;
  42413. private _isTeleportationFloor;
  42414. /**
  42415. * Adds a floor mesh to be used for teleportation.
  42416. * @param floorMesh the mesh to be used for teleportation.
  42417. */
  42418. addFloorMesh(floorMesh: Mesh): void;
  42419. /**
  42420. * Removes a floor mesh from being used for teleportation.
  42421. * @param floorMesh the mesh to be removed.
  42422. */
  42423. removeFloorMesh(floorMesh: Mesh): void;
  42424. /**
  42425. * Enables interactions and teleportation using the VR controllers and gaze.
  42426. * @param vrTeleportationOptions options to modify teleportation behavior.
  42427. */
  42428. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  42429. private _onNewGamepadConnected;
  42430. private _tryEnableInteractionOnController;
  42431. private _onNewGamepadDisconnected;
  42432. private _enableInteractionOnController;
  42433. private _checkTeleportWithRay;
  42434. private _checkRotate;
  42435. private _checkTeleportBackwards;
  42436. private _enableTeleportationOnController;
  42437. private _createTeleportationCircles;
  42438. private _displayTeleportationTarget;
  42439. private _hideTeleportationTarget;
  42440. private _rotateCamera;
  42441. private _moveTeleportationSelectorTo;
  42442. private _workingVector;
  42443. private _workingQuaternion;
  42444. private _workingMatrix;
  42445. /**
  42446. * Teleports the users feet to the desired location
  42447. * @param location The location where the user's feet should be placed
  42448. */
  42449. teleportCamera(location: Vector3): void;
  42450. private _convertNormalToDirectionOfRay;
  42451. private _castRayAndSelectObject;
  42452. private _notifySelectedMeshUnselected;
  42453. /**
  42454. * Sets the color of the laser ray from the vr controllers.
  42455. * @param color new color for the ray.
  42456. */
  42457. changeLaserColor(color: Color3): void;
  42458. /**
  42459. * Sets the color of the ray from the vr headsets gaze.
  42460. * @param color new color for the ray.
  42461. */
  42462. changeGazeColor(color: Color3): void;
  42463. /**
  42464. * Exits VR and disposes of the vr experience helper
  42465. */
  42466. dispose(): void;
  42467. /**
  42468. * Gets the name of the VRExperienceHelper class
  42469. * @returns "VRExperienceHelper"
  42470. */
  42471. getClassName(): string;
  42472. }
  42473. }
  42474. declare module "babylonjs/Cameras/VR/index" {
  42475. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  42476. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  42477. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42478. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  42479. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  42480. export * from "babylonjs/Cameras/VR/webVRCamera";
  42481. }
  42482. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  42483. import { Observable } from "babylonjs/Misc/observable";
  42484. import { Nullable } from "babylonjs/types";
  42485. import { IDisposable, Scene } from "babylonjs/scene";
  42486. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  42487. /**
  42488. * Manages an XRSession to work with Babylon's engine
  42489. * @see https://doc.babylonjs.com/how_to/webxr
  42490. */
  42491. export class WebXRSessionManager implements IDisposable {
  42492. private scene;
  42493. /**
  42494. * Fires every time a new xrFrame arrives which can be used to update the camera
  42495. */
  42496. onXRFrameObservable: Observable<any>;
  42497. /**
  42498. * Fires when the xr session is ended either by the device or manually done
  42499. */
  42500. onXRSessionEnded: Observable<any>;
  42501. /**
  42502. * Underlying xr session
  42503. */
  42504. session: XRSession;
  42505. /**
  42506. * Type of reference space used when creating the session
  42507. */
  42508. referenceSpace: XRReferenceSpace;
  42509. /** @hidden */
  42510. _sessionRenderTargetTexture: Nullable<RenderTargetTexture>;
  42511. /**
  42512. * Current XR frame
  42513. */
  42514. currentFrame: Nullable<XRFrame>;
  42515. private _xrNavigator;
  42516. private baseLayer;
  42517. /**
  42518. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  42519. * @param scene The scene which the session should be created for
  42520. */
  42521. constructor(scene: Scene);
  42522. /**
  42523. * Initializes the manager
  42524. * After initialization enterXR can be called to start an XR session
  42525. * @returns Promise which resolves after it is initialized
  42526. */
  42527. initializeAsync(): Promise<void>;
  42528. /**
  42529. * Initializes an xr session
  42530. * @param xrSessionMode mode to initialize
  42531. * @returns a promise which will resolve once the session has been initialized
  42532. */
  42533. initializeSessionAsync(xrSessionMode: XRSessionMode): any;
  42534. /**
  42535. * Sets the reference space on the xr session
  42536. * @param referenceSpace space to set
  42537. * @returns a promise that will resolve once the reference space has been set
  42538. */
  42539. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  42540. /**
  42541. * Updates the render state of the session
  42542. * @param state state to set
  42543. * @returns a promise that resolves once the render state has been updated
  42544. */
  42545. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  42546. /**
  42547. * Starts rendering to the xr layer
  42548. * @returns a promise that will resolve once rendering has started
  42549. */
  42550. startRenderingToXRAsync(): Promise<void>;
  42551. /**
  42552. * Stops the xrSession and restores the renderloop
  42553. * @returns Promise which resolves after it exits XR
  42554. */
  42555. exitXRAsync(): Promise<unknown>;
  42556. /**
  42557. * Checks if a session would be supported for the creation options specified
  42558. * @param sessionMode session mode to check if supported eg. immersive-vr
  42559. * @returns true if supported
  42560. */
  42561. supportsSessionAsync(sessionMode: XRSessionMode): any;
  42562. /**
  42563. * @hidden
  42564. * Converts the render layer of xrSession to a render target
  42565. * @param session session to create render target for
  42566. * @param scene scene the new render target should be created for
  42567. */
  42568. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  42569. /**
  42570. * Disposes of the session manager
  42571. */
  42572. dispose(): void;
  42573. }
  42574. }
  42575. declare module "babylonjs/Cameras/XR/webXRCamera" {
  42576. import { Scene } from "babylonjs/scene";
  42577. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  42578. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  42579. /**
  42580. * WebXR Camera which holds the views for the xrSession
  42581. * @see https://doc.babylonjs.com/how_to/webxr
  42582. */
  42583. export class WebXRCamera extends FreeCamera {
  42584. private static _TmpMatrix;
  42585. /**
  42586. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  42587. * @param name the name of the camera
  42588. * @param scene the scene to add the camera to
  42589. */
  42590. constructor(name: string, scene: Scene);
  42591. private _updateNumberOfRigCameras;
  42592. /** @hidden */
  42593. _updateForDualEyeDebugging(pupilDistance?: number): void;
  42594. /**
  42595. * Updates the cameras position from the current pose information of the XR session
  42596. * @param xrSessionManager the session containing pose information
  42597. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  42598. */
  42599. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  42600. }
  42601. }
  42602. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  42603. import { Nullable } from "babylonjs/types";
  42604. import { IDisposable } from "babylonjs/scene";
  42605. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  42606. /**
  42607. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  42608. */
  42609. export class WebXRManagedOutputCanvas implements IDisposable {
  42610. private helper;
  42611. private _canvas;
  42612. /**
  42613. * xrpresent context of the canvas which can be used to display/mirror xr content
  42614. */
  42615. canvasContext: WebGLRenderingContext;
  42616. /**
  42617. * xr layer for the canvas
  42618. */
  42619. xrLayer: Nullable<XRWebGLLayer>;
  42620. /**
  42621. * Initializes the xr layer for the session
  42622. * @param xrSession xr session
  42623. * @returns a promise that will resolve once the XR Layer has been created
  42624. */
  42625. initializeXRLayerAsync(xrSession: any): any;
  42626. /**
  42627. * Initializes the canvas to be added/removed upon entering/exiting xr
  42628. * @param helper the xr experience helper used to trigger adding/removing of the canvas
  42629. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  42630. */
  42631. constructor(helper: WebXRExperienceHelper, canvas?: HTMLCanvasElement);
  42632. /**
  42633. * Disposes of the object
  42634. */
  42635. dispose(): void;
  42636. private _setManagedOutputCanvas;
  42637. private _addCanvas;
  42638. private _removeCanvas;
  42639. }
  42640. }
  42641. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  42642. import { Observable } from "babylonjs/Misc/observable";
  42643. import { IDisposable, Scene } from "babylonjs/scene";
  42644. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  42645. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42646. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  42647. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  42648. import { WebXRManagedOutputCanvas } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  42649. /**
  42650. * States of the webXR experience
  42651. */
  42652. export enum WebXRState {
  42653. /**
  42654. * Transitioning to being in XR mode
  42655. */
  42656. ENTERING_XR = 0,
  42657. /**
  42658. * Transitioning to non XR mode
  42659. */
  42660. EXITING_XR = 1,
  42661. /**
  42662. * In XR mode and presenting
  42663. */
  42664. IN_XR = 2,
  42665. /**
  42666. * Not entered XR mode
  42667. */
  42668. NOT_IN_XR = 3
  42669. }
  42670. /**
  42671. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  42672. * @see https://doc.babylonjs.com/how_to/webxr
  42673. */
  42674. export class WebXRExperienceHelper implements IDisposable {
  42675. private scene;
  42676. /**
  42677. * 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
  42678. */
  42679. container: AbstractMesh;
  42680. /**
  42681. * Camera used to render xr content
  42682. */
  42683. camera: WebXRCamera;
  42684. /**
  42685. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  42686. */
  42687. state: WebXRState;
  42688. private _setState;
  42689. private static _TmpVector;
  42690. /**
  42691. * Fires when the state of the experience helper has changed
  42692. */
  42693. onStateChangedObservable: Observable<WebXRState>;
  42694. /** Session manager used to keep track of xr session */
  42695. sessionManager: WebXRSessionManager;
  42696. private _nonVRCamera;
  42697. private _originalSceneAutoClear;
  42698. private _supported;
  42699. /**
  42700. * Creates the experience helper
  42701. * @param scene the scene to attach the experience helper to
  42702. * @returns a promise for the experience helper
  42703. */
  42704. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  42705. /**
  42706. * Creates a WebXRExperienceHelper
  42707. * @param scene The scene the helper should be created in
  42708. */
  42709. private constructor();
  42710. /**
  42711. * Exits XR mode and returns the scene to its original state
  42712. * @returns promise that resolves after xr mode has exited
  42713. */
  42714. exitXRAsync(): Promise<unknown>;
  42715. /**
  42716. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  42717. * @param sessionCreationOptions options for the XR session
  42718. * @param referenceSpaceType frame of reference of the XR session
  42719. * @param outputCanvas the output canvas that will be used to enter XR mode
  42720. * @returns promise that resolves after xr mode has entered
  42721. */
  42722. enterXRAsync(sessionCreationOptions: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, outputCanvas: WebXRManagedOutputCanvas): any;
  42723. /**
  42724. * Updates the global position of the camera by moving the camera's container
  42725. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  42726. * @param position The desired global position of the camera
  42727. */
  42728. setPositionOfCameraUsingContainer(position: Vector3): void;
  42729. /**
  42730. * Rotates the xr camera by rotating the camera's container around the camera's position
  42731. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  42732. * @param rotation the desired quaternion rotation to apply to the camera
  42733. */
  42734. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  42735. /**
  42736. * Disposes of the experience helper
  42737. */
  42738. dispose(): void;
  42739. }
  42740. }
  42741. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  42742. import { Nullable } from "babylonjs/types";
  42743. import { Observable } from "babylonjs/Misc/observable";
  42744. import { IDisposable, Scene } from "babylonjs/scene";
  42745. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  42746. import { WebXRManagedOutputCanvas } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  42747. /**
  42748. * Button which can be used to enter a different mode of XR
  42749. */
  42750. export class WebXREnterExitUIButton {
  42751. /** button element */
  42752. element: HTMLElement;
  42753. /** XR initialization options for the button */
  42754. sessionMode: XRSessionMode;
  42755. /** Reference space type */
  42756. referenceSpaceType: XRReferenceSpaceType;
  42757. /**
  42758. * Creates a WebXREnterExitUIButton
  42759. * @param element button element
  42760. * @param sessionMode XR initialization session mode
  42761. * @param referenceSpaceType the type of reference space to be used
  42762. */
  42763. constructor(
  42764. /** button element */
  42765. element: HTMLElement,
  42766. /** XR initialization options for the button */
  42767. sessionMode: XRSessionMode,
  42768. /** Reference space type */
  42769. referenceSpaceType: XRReferenceSpaceType);
  42770. /**
  42771. * Overwritable function which can be used to update the button's visuals when the state changes
  42772. * @param activeButton the current active button in the UI
  42773. */
  42774. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  42775. }
  42776. /**
  42777. * Options to create the webXR UI
  42778. */
  42779. export class WebXREnterExitUIOptions {
  42780. /**
  42781. * Context to enter xr with
  42782. */
  42783. webXRManagedOutputCanvas?: Nullable<WebXRManagedOutputCanvas>;
  42784. /**
  42785. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  42786. */
  42787. customButtons?: Array<WebXREnterExitUIButton>;
  42788. }
  42789. /**
  42790. * UI to allow the user to enter/exit XR mode
  42791. */
  42792. export class WebXREnterExitUI implements IDisposable {
  42793. private scene;
  42794. private _overlay;
  42795. private _buttons;
  42796. private _activeButton;
  42797. /**
  42798. * Fired every time the active button is changed.
  42799. *
  42800. * When xr is entered via a button that launches xr that button will be the callback parameter
  42801. *
  42802. * When exiting xr the callback parameter will be null)
  42803. */
  42804. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  42805. /**
  42806. * Creates UI to allow the user to enter/exit XR mode
  42807. * @param scene the scene to add the ui to
  42808. * @param helper the xr experience helper to enter/exit xr with
  42809. * @param options options to configure the UI
  42810. * @returns the created ui
  42811. */
  42812. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  42813. private constructor();
  42814. private _updateButtons;
  42815. /**
  42816. * Disposes of the object
  42817. */
  42818. dispose(): void;
  42819. }
  42820. }
  42821. declare module "babylonjs/Cameras/XR/webXRController" {
  42822. import { Nullable } from "babylonjs/types";
  42823. import { Observable } from "babylonjs/Misc/observable";
  42824. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42825. import { Ray } from "babylonjs/Culling/ray";
  42826. import { Scene } from "babylonjs/scene";
  42827. /**
  42828. * Represents an XR input
  42829. */
  42830. export class WebXRController {
  42831. private scene;
  42832. /** The underlying input source for the controller */
  42833. inputSource: XRInputSource;
  42834. private parentContainer;
  42835. /**
  42836. * 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
  42837. */
  42838. grip?: AbstractMesh;
  42839. /**
  42840. * Pointer which can be used to select objects or attach a visible laser to
  42841. */
  42842. pointer: AbstractMesh;
  42843. /**
  42844. * Event that fires when the controller is removed/disposed
  42845. */
  42846. onDisposeObservable: Observable<{}>;
  42847. private _tmpMatrix;
  42848. private _tmpQuaternion;
  42849. private _tmpVector;
  42850. /**
  42851. * Creates the controller
  42852. * @see https://doc.babylonjs.com/how_to/webxr
  42853. * @param scene the scene which the controller should be associated to
  42854. * @param inputSource the underlying input source for the controller
  42855. * @param parentContainer parent that the controller meshes should be children of
  42856. */
  42857. constructor(scene: Scene,
  42858. /** The underlying input source for the controller */
  42859. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  42860. /**
  42861. * Updates the controller pose based on the given XRFrame
  42862. * @param xrFrame xr frame to update the pose with
  42863. * @param referenceSpace reference space to use
  42864. */
  42865. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  42866. /**
  42867. * Gets a world space ray coming from the controller
  42868. * @param result the resulting ray
  42869. */
  42870. getWorldPointerRayToRef(result: Ray): void;
  42871. /**
  42872. * Disposes of the object
  42873. */
  42874. dispose(): void;
  42875. }
  42876. }
  42877. declare module "babylonjs/Cameras/XR/webXRInput" {
  42878. import { Observable } from "babylonjs/Misc/observable";
  42879. import { IDisposable } from "babylonjs/scene";
  42880. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  42881. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  42882. /**
  42883. * XR input used to track XR inputs such as controllers/rays
  42884. */
  42885. export class WebXRInput implements IDisposable {
  42886. /**
  42887. * Base experience the input listens to
  42888. */
  42889. baseExperience: WebXRExperienceHelper;
  42890. /**
  42891. * XR controllers being tracked
  42892. */
  42893. controllers: Array<WebXRController>;
  42894. private _frameObserver;
  42895. private _stateObserver;
  42896. /**
  42897. * Event when a controller has been connected/added
  42898. */
  42899. onControllerAddedObservable: Observable<WebXRController>;
  42900. /**
  42901. * Event when a controller has been removed/disconnected
  42902. */
  42903. onControllerRemovedObservable: Observable<WebXRController>;
  42904. /**
  42905. * Initializes the WebXRInput
  42906. * @param baseExperience experience helper which the input should be created for
  42907. */
  42908. constructor(
  42909. /**
  42910. * Base experience the input listens to
  42911. */
  42912. baseExperience: WebXRExperienceHelper);
  42913. private _onInputSourcesChange;
  42914. private _addAndRemoveControllers;
  42915. /**
  42916. * Disposes of the object
  42917. */
  42918. dispose(): void;
  42919. }
  42920. }
  42921. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  42922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42923. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  42924. /**
  42925. * Enables teleportation
  42926. */
  42927. export class WebXRControllerTeleportation {
  42928. private _teleportationFillColor;
  42929. private _teleportationBorderColor;
  42930. private _tmpRay;
  42931. private _tmpVector;
  42932. /**
  42933. * Creates a WebXRControllerTeleportation
  42934. * @param input input manager to add teleportation to
  42935. * @param floorMeshes floormeshes which can be teleported to
  42936. */
  42937. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  42938. }
  42939. }
  42940. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  42941. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  42942. /**
  42943. * Handles pointer input automatically for the pointer of XR controllers
  42944. */
  42945. export class WebXRControllerPointerSelection {
  42946. private static _idCounter;
  42947. private _tmpRay;
  42948. /**
  42949. * Creates a WebXRControllerPointerSelection
  42950. * @param input input manager to setup pointer selection
  42951. */
  42952. constructor(input: WebXRInput);
  42953. private _convertNormalToDirectionOfRay;
  42954. private _updatePointerDistance;
  42955. }
  42956. }
  42957. declare module "babylonjs/Loading/sceneLoader" {
  42958. import { Observable } from "babylonjs/Misc/observable";
  42959. import { Nullable } from "babylonjs/types";
  42960. import { Scene } from "babylonjs/scene";
  42961. import { Engine } from "babylonjs/Engines/engine";
  42962. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42963. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42964. import { AssetContainer } from "babylonjs/assetContainer";
  42965. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42966. import { Skeleton } from "babylonjs/Bones/skeleton";
  42967. /**
  42968. * Class used to represent data loading progression
  42969. */
  42970. export class SceneLoaderProgressEvent {
  42971. /** defines if data length to load can be evaluated */
  42972. readonly lengthComputable: boolean;
  42973. /** defines the loaded data length */
  42974. readonly loaded: number;
  42975. /** defines the data length to load */
  42976. readonly total: number;
  42977. /**
  42978. * Create a new progress event
  42979. * @param lengthComputable defines if data length to load can be evaluated
  42980. * @param loaded defines the loaded data length
  42981. * @param total defines the data length to load
  42982. */
  42983. constructor(
  42984. /** defines if data length to load can be evaluated */
  42985. lengthComputable: boolean,
  42986. /** defines the loaded data length */
  42987. loaded: number,
  42988. /** defines the data length to load */
  42989. total: number);
  42990. /**
  42991. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  42992. * @param event defines the source event
  42993. * @returns a new SceneLoaderProgressEvent
  42994. */
  42995. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  42996. }
  42997. /**
  42998. * Interface used by SceneLoader plugins to define supported file extensions
  42999. */
  43000. export interface ISceneLoaderPluginExtensions {
  43001. /**
  43002. * Defines the list of supported extensions
  43003. */
  43004. [extension: string]: {
  43005. isBinary: boolean;
  43006. };
  43007. }
  43008. /**
  43009. * Interface used by SceneLoader plugin factory
  43010. */
  43011. export interface ISceneLoaderPluginFactory {
  43012. /**
  43013. * Defines the name of the factory
  43014. */
  43015. name: string;
  43016. /**
  43017. * Function called to create a new plugin
  43018. * @return the new plugin
  43019. */
  43020. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43021. /**
  43022. * Boolean indicating if the plugin can direct load specific data
  43023. */
  43024. canDirectLoad?: (data: string) => boolean;
  43025. }
  43026. /**
  43027. * Interface used to define a SceneLoader plugin
  43028. */
  43029. export interface ISceneLoaderPlugin {
  43030. /**
  43031. * The friendly name of this plugin.
  43032. */
  43033. name: string;
  43034. /**
  43035. * The file extensions supported by this plugin.
  43036. */
  43037. extensions: string | ISceneLoaderPluginExtensions;
  43038. /**
  43039. * Import meshes into a scene.
  43040. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43041. * @param scene The scene to import into
  43042. * @param data The data to import
  43043. * @param rootUrl The root url for scene and resources
  43044. * @param meshes The meshes array to import into
  43045. * @param particleSystems The particle systems array to import into
  43046. * @param skeletons The skeletons array to import into
  43047. * @param onError The callback when import fails
  43048. * @returns True if successful or false otherwise
  43049. */
  43050. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  43051. /**
  43052. * Load into a scene.
  43053. * @param scene The scene to load into
  43054. * @param data The data to import
  43055. * @param rootUrl The root url for scene and resources
  43056. * @param onError The callback when import fails
  43057. * @returns true if successful or false otherwise
  43058. */
  43059. load(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  43060. /**
  43061. * The callback that returns true if the data can be directly loaded.
  43062. */
  43063. canDirectLoad?: (data: string) => boolean;
  43064. /**
  43065. * The callback that allows custom handling of the root url based on the response url.
  43066. */
  43067. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  43068. /**
  43069. * Load into an asset container.
  43070. * @param scene The scene to load into
  43071. * @param data The data to import
  43072. * @param rootUrl The root url for scene and resources
  43073. * @param onError The callback when import fails
  43074. * @returns The loaded asset container
  43075. */
  43076. loadAssetContainer(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  43077. }
  43078. /**
  43079. * Interface used to define an async SceneLoader plugin
  43080. */
  43081. export interface ISceneLoaderPluginAsync {
  43082. /**
  43083. * The friendly name of this plugin.
  43084. */
  43085. name: string;
  43086. /**
  43087. * The file extensions supported by this plugin.
  43088. */
  43089. extensions: string | ISceneLoaderPluginExtensions;
  43090. /**
  43091. * Import meshes into a scene.
  43092. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43093. * @param scene The scene to import into
  43094. * @param data The data to import
  43095. * @param rootUrl The root url for scene and resources
  43096. * @param onProgress The callback when the load progresses
  43097. * @param fileName Defines the name of the file to load
  43098. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  43099. */
  43100. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  43101. meshes: AbstractMesh[];
  43102. particleSystems: IParticleSystem[];
  43103. skeletons: Skeleton[];
  43104. animationGroups: AnimationGroup[];
  43105. }>;
  43106. /**
  43107. * Load into a scene.
  43108. * @param scene The scene to load into
  43109. * @param data The data to import
  43110. * @param rootUrl The root url for scene and resources
  43111. * @param onProgress The callback when the load progresses
  43112. * @param fileName Defines the name of the file to load
  43113. * @returns Nothing
  43114. */
  43115. loadAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  43116. /**
  43117. * The callback that returns true if the data can be directly loaded.
  43118. */
  43119. canDirectLoad?: (data: string) => boolean;
  43120. /**
  43121. * The callback that allows custom handling of the root url based on the response url.
  43122. */
  43123. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  43124. /**
  43125. * Load into an asset container.
  43126. * @param scene The scene to load into
  43127. * @param data The data to import
  43128. * @param rootUrl The root url for scene and resources
  43129. * @param onProgress The callback when the load progresses
  43130. * @param fileName Defines the name of the file to load
  43131. * @returns The loaded asset container
  43132. */
  43133. loadAssetContainerAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  43134. }
  43135. /**
  43136. * Class used to load scene from various file formats using registered plugins
  43137. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  43138. */
  43139. export class SceneLoader {
  43140. /**
  43141. * No logging while loading
  43142. */
  43143. static readonly NO_LOGGING: number;
  43144. /**
  43145. * Minimal logging while loading
  43146. */
  43147. static readonly MINIMAL_LOGGING: number;
  43148. /**
  43149. * Summary logging while loading
  43150. */
  43151. static readonly SUMMARY_LOGGING: number;
  43152. /**
  43153. * Detailled logging while loading
  43154. */
  43155. static readonly DETAILED_LOGGING: number;
  43156. /**
  43157. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  43158. */
  43159. static ForceFullSceneLoadingForIncremental: boolean;
  43160. /**
  43161. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  43162. */
  43163. static ShowLoadingScreen: boolean;
  43164. /**
  43165. * Defines the current logging level (while loading the scene)
  43166. * @ignorenaming
  43167. */
  43168. static loggingLevel: number;
  43169. /**
  43170. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  43171. */
  43172. static CleanBoneMatrixWeights: boolean;
  43173. /**
  43174. * Event raised when a plugin is used to load a scene
  43175. */
  43176. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43177. private static _registeredPlugins;
  43178. private static _getDefaultPlugin;
  43179. private static _getPluginForExtension;
  43180. private static _getPluginForDirectLoad;
  43181. private static _getPluginForFilename;
  43182. private static _getDirectLoad;
  43183. private static _loadData;
  43184. private static _getFileInfo;
  43185. /**
  43186. * Gets a plugin that can load the given extension
  43187. * @param extension defines the extension to load
  43188. * @returns a plugin or null if none works
  43189. */
  43190. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  43191. /**
  43192. * Gets a boolean indicating that the given extension can be loaded
  43193. * @param extension defines the extension to load
  43194. * @returns true if the extension is supported
  43195. */
  43196. static IsPluginForExtensionAvailable(extension: string): boolean;
  43197. /**
  43198. * Adds a new plugin to the list of registered plugins
  43199. * @param plugin defines the plugin to add
  43200. */
  43201. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  43202. /**
  43203. * Import meshes into a scene
  43204. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43205. * @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)
  43206. * @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)
  43207. * @param scene the instance of BABYLON.Scene to append to
  43208. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  43209. * @param onProgress a callback with a progress event for each file being loaded
  43210. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43211. * @param pluginExtension the extension used to determine the plugin
  43212. * @returns The loaded plugin
  43213. */
  43214. 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>;
  43215. /**
  43216. * Import meshes into a scene
  43217. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43218. * @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)
  43219. * @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)
  43220. * @param scene the instance of BABYLON.Scene to append to
  43221. * @param onProgress a callback with a progress event for each file being loaded
  43222. * @param pluginExtension the extension used to determine the plugin
  43223. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  43224. */
  43225. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  43226. meshes: AbstractMesh[];
  43227. particleSystems: IParticleSystem[];
  43228. skeletons: Skeleton[];
  43229. animationGroups: AnimationGroup[];
  43230. }>;
  43231. /**
  43232. * Load a scene
  43233. * @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)
  43234. * @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)
  43235. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43236. * @param onSuccess a callback with the scene when import succeeds
  43237. * @param onProgress a callback with a progress event for each file being loaded
  43238. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43239. * @param pluginExtension the extension used to determine the plugin
  43240. * @returns The loaded plugin
  43241. */
  43242. 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>;
  43243. /**
  43244. * Load a scene
  43245. * @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)
  43246. * @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)
  43247. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43248. * @param onProgress a callback with a progress event for each file being loaded
  43249. * @param pluginExtension the extension used to determine the plugin
  43250. * @returns The loaded scene
  43251. */
  43252. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43253. /**
  43254. * Append a scene
  43255. * @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)
  43256. * @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)
  43257. * @param scene is the instance of BABYLON.Scene to append to
  43258. * @param onSuccess a callback with the scene when import succeeds
  43259. * @param onProgress a callback with a progress event for each file being loaded
  43260. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43261. * @param pluginExtension the extension used to determine the plugin
  43262. * @returns The loaded plugin
  43263. */
  43264. 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>;
  43265. /**
  43266. * Append a scene
  43267. * @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)
  43268. * @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)
  43269. * @param scene is the instance of BABYLON.Scene to append to
  43270. * @param onProgress a callback with a progress event for each file being loaded
  43271. * @param pluginExtension the extension used to determine the plugin
  43272. * @returns The given scene
  43273. */
  43274. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43275. /**
  43276. * Load a scene into an asset container
  43277. * @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)
  43278. * @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)
  43279. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  43280. * @param onSuccess a callback with the scene when import succeeds
  43281. * @param onProgress a callback with a progress event for each file being loaded
  43282. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43283. * @param pluginExtension the extension used to determine the plugin
  43284. * @returns The loaded plugin
  43285. */
  43286. 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>;
  43287. /**
  43288. * Load a scene into an asset container
  43289. * @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)
  43290. * @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)
  43291. * @param scene is the instance of Scene to append to
  43292. * @param onProgress a callback with a progress event for each file being loaded
  43293. * @param pluginExtension the extension used to determine the plugin
  43294. * @returns The loaded asset container
  43295. */
  43296. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  43297. }
  43298. }
  43299. declare module "babylonjs/Gamepads/Controllers/genericController" {
  43300. import { Scene } from "babylonjs/scene";
  43301. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43302. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43303. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43304. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43305. /**
  43306. * Generic Controller
  43307. */
  43308. export class GenericController extends WebVRController {
  43309. /**
  43310. * Base Url for the controller model.
  43311. */
  43312. static readonly MODEL_BASE_URL: string;
  43313. /**
  43314. * File name for the controller model.
  43315. */
  43316. static readonly MODEL_FILENAME: string;
  43317. /**
  43318. * Creates a new GenericController from a gamepad
  43319. * @param vrGamepad the gamepad that the controller should be created from
  43320. */
  43321. constructor(vrGamepad: any);
  43322. /**
  43323. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43324. * @param scene scene in which to add meshes
  43325. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43326. */
  43327. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43328. /**
  43329. * Called once for each button that changed state since the last frame
  43330. * @param buttonIdx Which button index changed
  43331. * @param state New state of the button
  43332. * @param changes Which properties on the state changed since last frame
  43333. */
  43334. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43335. }
  43336. }
  43337. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  43338. import { Observable } from "babylonjs/Misc/observable";
  43339. import { Scene } from "babylonjs/scene";
  43340. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43341. import { Ray } from "babylonjs/Culling/ray";
  43342. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43343. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43344. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43345. /**
  43346. * Defines the WindowsMotionController object that the state of the windows motion controller
  43347. */
  43348. export class WindowsMotionController extends WebVRController {
  43349. /**
  43350. * The base url used to load the left and right controller models
  43351. */
  43352. static MODEL_BASE_URL: string;
  43353. /**
  43354. * The name of the left controller model file
  43355. */
  43356. static MODEL_LEFT_FILENAME: string;
  43357. /**
  43358. * The name of the right controller model file
  43359. */
  43360. static MODEL_RIGHT_FILENAME: string;
  43361. /**
  43362. * The controller name prefix for this controller type
  43363. */
  43364. static readonly GAMEPAD_ID_PREFIX: string;
  43365. /**
  43366. * The controller id pattern for this controller type
  43367. */
  43368. private static readonly GAMEPAD_ID_PATTERN;
  43369. private _loadedMeshInfo;
  43370. private readonly _mapping;
  43371. /**
  43372. * Fired when the trackpad on this controller is clicked
  43373. */
  43374. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  43375. /**
  43376. * Fired when the trackpad on this controller is modified
  43377. */
  43378. onTrackpadValuesChangedObservable: Observable<StickValues>;
  43379. /**
  43380. * The current x and y values of this controller's trackpad
  43381. */
  43382. trackpad: StickValues;
  43383. /**
  43384. * Creates a new WindowsMotionController from a gamepad
  43385. * @param vrGamepad the gamepad that the controller should be created from
  43386. */
  43387. constructor(vrGamepad: any);
  43388. /**
  43389. * Fired when the trigger on this controller is modified
  43390. */
  43391. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43392. /**
  43393. * Fired when the menu button on this controller is modified
  43394. */
  43395. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43396. /**
  43397. * Fired when the grip button on this controller is modified
  43398. */
  43399. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43400. /**
  43401. * Fired when the thumbstick button on this controller is modified
  43402. */
  43403. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43404. /**
  43405. * Fired when the touchpad button on this controller is modified
  43406. */
  43407. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43408. /**
  43409. * Fired when the touchpad values on this controller are modified
  43410. */
  43411. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  43412. private _updateTrackpad;
  43413. /**
  43414. * Called once per frame by the engine.
  43415. */
  43416. update(): void;
  43417. /**
  43418. * Called once for each button that changed state since the last frame
  43419. * @param buttonIdx Which button index changed
  43420. * @param state New state of the button
  43421. * @param changes Which properties on the state changed since last frame
  43422. */
  43423. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43424. /**
  43425. * Moves the buttons on the controller mesh based on their current state
  43426. * @param buttonName the name of the button to move
  43427. * @param buttonValue the value of the button which determines the buttons new position
  43428. */
  43429. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  43430. /**
  43431. * Moves the axis on the controller mesh based on its current state
  43432. * @param axis the index of the axis
  43433. * @param axisValue the value of the axis which determines the meshes new position
  43434. * @hidden
  43435. */
  43436. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  43437. /**
  43438. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43439. * @param scene scene in which to add meshes
  43440. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43441. */
  43442. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  43443. /**
  43444. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  43445. * can be transformed by button presses and axes values, based on this._mapping.
  43446. *
  43447. * @param scene scene in which the meshes exist
  43448. * @param meshes list of meshes that make up the controller model to process
  43449. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  43450. */
  43451. private processModel;
  43452. private createMeshInfo;
  43453. /**
  43454. * Gets the ray of the controller in the direction the controller is pointing
  43455. * @param length the length the resulting ray should be
  43456. * @returns a ray in the direction the controller is pointing
  43457. */
  43458. getForwardRay(length?: number): Ray;
  43459. /**
  43460. * Disposes of the controller
  43461. */
  43462. dispose(): void;
  43463. }
  43464. }
  43465. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  43466. import { Observable } from "babylonjs/Misc/observable";
  43467. import { Scene } from "babylonjs/scene";
  43468. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43469. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43470. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43471. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43472. /**
  43473. * Oculus Touch Controller
  43474. */
  43475. export class OculusTouchController extends WebVRController {
  43476. /**
  43477. * Base Url for the controller model.
  43478. */
  43479. static MODEL_BASE_URL: string;
  43480. /**
  43481. * File name for the left controller model.
  43482. */
  43483. static MODEL_LEFT_FILENAME: string;
  43484. /**
  43485. * File name for the right controller model.
  43486. */
  43487. static MODEL_RIGHT_FILENAME: string;
  43488. /**
  43489. * Base Url for the Quest controller model.
  43490. */
  43491. static QUEST_MODEL_BASE_URL: string;
  43492. /**
  43493. * @hidden
  43494. * If the controllers are running on a device that needs the updated Quest controller models
  43495. */
  43496. static _IsQuest: boolean;
  43497. /**
  43498. * Fired when the secondary trigger on this controller is modified
  43499. */
  43500. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  43501. /**
  43502. * Fired when the thumb rest on this controller is modified
  43503. */
  43504. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  43505. /**
  43506. * Creates a new OculusTouchController from a gamepad
  43507. * @param vrGamepad the gamepad that the controller should be created from
  43508. */
  43509. constructor(vrGamepad: any);
  43510. /**
  43511. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43512. * @param scene scene in which to add meshes
  43513. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43514. */
  43515. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43516. /**
  43517. * Fired when the A button on this controller is modified
  43518. */
  43519. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43520. /**
  43521. * Fired when the B button on this controller is modified
  43522. */
  43523. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43524. /**
  43525. * Fired when the X button on this controller is modified
  43526. */
  43527. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43528. /**
  43529. * Fired when the Y button on this controller is modified
  43530. */
  43531. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43532. /**
  43533. * Called once for each button that changed state since the last frame
  43534. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  43535. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  43536. * 2) secondary trigger (same)
  43537. * 3) A (right) X (left), touch, pressed = value
  43538. * 4) B / Y
  43539. * 5) thumb rest
  43540. * @param buttonIdx Which button index changed
  43541. * @param state New state of the button
  43542. * @param changes Which properties on the state changed since last frame
  43543. */
  43544. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43545. }
  43546. }
  43547. declare module "babylonjs/Gamepads/Controllers/viveController" {
  43548. import { Scene } from "babylonjs/scene";
  43549. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43550. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43551. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43552. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43553. import { Observable } from "babylonjs/Misc/observable";
  43554. /**
  43555. * Vive Controller
  43556. */
  43557. export class ViveController extends WebVRController {
  43558. /**
  43559. * Base Url for the controller model.
  43560. */
  43561. static MODEL_BASE_URL: string;
  43562. /**
  43563. * File name for the controller model.
  43564. */
  43565. static MODEL_FILENAME: string;
  43566. /**
  43567. * Creates a new ViveController from a gamepad
  43568. * @param vrGamepad the gamepad that the controller should be created from
  43569. */
  43570. constructor(vrGamepad: any);
  43571. /**
  43572. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43573. * @param scene scene in which to add meshes
  43574. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43575. */
  43576. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43577. /**
  43578. * Fired when the left button on this controller is modified
  43579. */
  43580. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43581. /**
  43582. * Fired when the right button on this controller is modified
  43583. */
  43584. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43585. /**
  43586. * Fired when the menu button on this controller is modified
  43587. */
  43588. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43589. /**
  43590. * Called once for each button that changed state since the last frame
  43591. * Vive mapping:
  43592. * 0: touchpad
  43593. * 1: trigger
  43594. * 2: left AND right buttons
  43595. * 3: menu button
  43596. * @param buttonIdx Which button index changed
  43597. * @param state New state of the button
  43598. * @param changes Which properties on the state changed since last frame
  43599. */
  43600. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43601. }
  43602. }
  43603. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  43604. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43605. /**
  43606. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  43607. */
  43608. export class WebXRControllerModelLoader {
  43609. /**
  43610. * Creates the WebXRControllerModelLoader
  43611. * @param input xr input that creates the controllers
  43612. */
  43613. constructor(input: WebXRInput);
  43614. }
  43615. }
  43616. declare module "babylonjs/Cameras/XR/index" {
  43617. export * from "babylonjs/Cameras/XR/webXRCamera";
  43618. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  43619. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43620. export * from "babylonjs/Cameras/XR/webXRInput";
  43621. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  43622. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  43623. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  43624. export * from "babylonjs/Cameras/XR/webXRController";
  43625. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  43626. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  43627. }
  43628. declare module "babylonjs/Cameras/RigModes/index" {
  43629. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  43630. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  43631. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  43632. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  43633. }
  43634. declare module "babylonjs/Cameras/index" {
  43635. export * from "babylonjs/Cameras/Inputs/index";
  43636. export * from "babylonjs/Cameras/cameraInputsManager";
  43637. export * from "babylonjs/Cameras/camera";
  43638. export * from "babylonjs/Cameras/targetCamera";
  43639. export * from "babylonjs/Cameras/freeCamera";
  43640. export * from "babylonjs/Cameras/freeCameraInputsManager";
  43641. export * from "babylonjs/Cameras/touchCamera";
  43642. export * from "babylonjs/Cameras/arcRotateCamera";
  43643. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  43644. export * from "babylonjs/Cameras/deviceOrientationCamera";
  43645. export * from "babylonjs/Cameras/flyCamera";
  43646. export * from "babylonjs/Cameras/flyCameraInputsManager";
  43647. export * from "babylonjs/Cameras/followCamera";
  43648. export * from "babylonjs/Cameras/gamepadCamera";
  43649. export * from "babylonjs/Cameras/Stereoscopic/index";
  43650. export * from "babylonjs/Cameras/universalCamera";
  43651. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  43652. export * from "babylonjs/Cameras/VR/index";
  43653. export * from "babylonjs/Cameras/XR/index";
  43654. export * from "babylonjs/Cameras/RigModes/index";
  43655. }
  43656. declare module "babylonjs/Collisions/index" {
  43657. export * from "babylonjs/Collisions/collider";
  43658. export * from "babylonjs/Collisions/collisionCoordinator";
  43659. export * from "babylonjs/Collisions/pickingInfo";
  43660. export * from "babylonjs/Collisions/intersectionInfo";
  43661. export * from "babylonjs/Collisions/meshCollisionData";
  43662. }
  43663. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  43664. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  43665. import { Vector3 } from "babylonjs/Maths/math.vector";
  43666. import { Ray } from "babylonjs/Culling/ray";
  43667. import { Plane } from "babylonjs/Maths/math.plane";
  43668. /**
  43669. * Contains an array of blocks representing the octree
  43670. */
  43671. export interface IOctreeContainer<T> {
  43672. /**
  43673. * Blocks within the octree
  43674. */
  43675. blocks: Array<OctreeBlock<T>>;
  43676. }
  43677. /**
  43678. * Class used to store a cell in an octree
  43679. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43680. */
  43681. export class OctreeBlock<T> {
  43682. /**
  43683. * Gets the content of the current block
  43684. */
  43685. entries: T[];
  43686. /**
  43687. * Gets the list of block children
  43688. */
  43689. blocks: Array<OctreeBlock<T>>;
  43690. private _depth;
  43691. private _maxDepth;
  43692. private _capacity;
  43693. private _minPoint;
  43694. private _maxPoint;
  43695. private _boundingVectors;
  43696. private _creationFunc;
  43697. /**
  43698. * Creates a new block
  43699. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  43700. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  43701. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  43702. * @param depth defines the current depth of this block in the octree
  43703. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  43704. * @param creationFunc defines a callback to call when an element is added to the block
  43705. */
  43706. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  43707. /**
  43708. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  43709. */
  43710. readonly capacity: number;
  43711. /**
  43712. * Gets the minimum vector (in world space) of the block's bounding box
  43713. */
  43714. readonly minPoint: Vector3;
  43715. /**
  43716. * Gets the maximum vector (in world space) of the block's bounding box
  43717. */
  43718. readonly maxPoint: Vector3;
  43719. /**
  43720. * Add a new element to this block
  43721. * @param entry defines the element to add
  43722. */
  43723. addEntry(entry: T): void;
  43724. /**
  43725. * Remove an element from this block
  43726. * @param entry defines the element to remove
  43727. */
  43728. removeEntry(entry: T): void;
  43729. /**
  43730. * Add an array of elements to this block
  43731. * @param entries defines the array of elements to add
  43732. */
  43733. addEntries(entries: T[]): void;
  43734. /**
  43735. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  43736. * @param frustumPlanes defines the frustum planes to test
  43737. * @param selection defines the array to store current content if selection is positive
  43738. * @param allowDuplicate defines if the selection array can contains duplicated entries
  43739. */
  43740. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  43741. /**
  43742. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  43743. * @param sphereCenter defines the bounding sphere center
  43744. * @param sphereRadius defines the bounding sphere radius
  43745. * @param selection defines the array to store current content if selection is positive
  43746. * @param allowDuplicate defines if the selection array can contains duplicated entries
  43747. */
  43748. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  43749. /**
  43750. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  43751. * @param ray defines the ray to test with
  43752. * @param selection defines the array to store current content if selection is positive
  43753. */
  43754. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  43755. /**
  43756. * Subdivide the content into child blocks (this block will then be empty)
  43757. */
  43758. createInnerBlocks(): void;
  43759. /**
  43760. * @hidden
  43761. */
  43762. 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;
  43763. }
  43764. }
  43765. declare module "babylonjs/Culling/Octrees/octree" {
  43766. import { SmartArray } from "babylonjs/Misc/smartArray";
  43767. import { Vector3 } from "babylonjs/Maths/math.vector";
  43768. import { SubMesh } from "babylonjs/Meshes/subMesh";
  43769. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43770. import { Ray } from "babylonjs/Culling/ray";
  43771. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  43772. import { Plane } from "babylonjs/Maths/math.plane";
  43773. /**
  43774. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  43775. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43776. */
  43777. export class Octree<T> {
  43778. /** 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.) */
  43779. maxDepth: number;
  43780. /**
  43781. * Blocks within the octree containing objects
  43782. */
  43783. blocks: Array<OctreeBlock<T>>;
  43784. /**
  43785. * Content stored in the octree
  43786. */
  43787. dynamicContent: T[];
  43788. private _maxBlockCapacity;
  43789. private _selectionContent;
  43790. private _creationFunc;
  43791. /**
  43792. * Creates a octree
  43793. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43794. * @param creationFunc function to be used to instatiate the octree
  43795. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  43796. * @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.)
  43797. */
  43798. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  43799. /** 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.) */
  43800. maxDepth?: number);
  43801. /**
  43802. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  43803. * @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);
  43804. * @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);
  43805. * @param entries meshes to be added to the octree blocks
  43806. */
  43807. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  43808. /**
  43809. * Adds a mesh to the octree
  43810. * @param entry Mesh to add to the octree
  43811. */
  43812. addMesh(entry: T): void;
  43813. /**
  43814. * Remove an element from the octree
  43815. * @param entry defines the element to remove
  43816. */
  43817. removeMesh(entry: T): void;
  43818. /**
  43819. * Selects an array of meshes within the frustum
  43820. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  43821. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  43822. * @returns array of meshes within the frustum
  43823. */
  43824. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  43825. /**
  43826. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  43827. * @param sphereCenter defines the bounding sphere center
  43828. * @param sphereRadius defines the bounding sphere radius
  43829. * @param allowDuplicate defines if the selection array can contains duplicated entries
  43830. * @returns an array of objects that intersect the sphere
  43831. */
  43832. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  43833. /**
  43834. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  43835. * @param ray defines the ray to test with
  43836. * @returns array of intersected objects
  43837. */
  43838. intersectsRay(ray: Ray): SmartArray<T>;
  43839. /**
  43840. * Adds a mesh into the octree block if it intersects the block
  43841. */
  43842. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  43843. /**
  43844. * Adds a submesh into the octree block if it intersects the block
  43845. */
  43846. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  43847. }
  43848. }
  43849. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  43850. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  43851. import { Scene } from "babylonjs/scene";
  43852. import { SubMesh } from "babylonjs/Meshes/subMesh";
  43853. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43854. import { Ray } from "babylonjs/Culling/ray";
  43855. import { Octree } from "babylonjs/Culling/Octrees/octree";
  43856. import { Collider } from "babylonjs/Collisions/collider";
  43857. module "babylonjs/scene" {
  43858. interface Scene {
  43859. /**
  43860. * @hidden
  43861. * Backing Filed
  43862. */
  43863. _selectionOctree: Octree<AbstractMesh>;
  43864. /**
  43865. * Gets the octree used to boost mesh selection (picking)
  43866. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43867. */
  43868. selectionOctree: Octree<AbstractMesh>;
  43869. /**
  43870. * Creates or updates the octree used to boost selection (picking)
  43871. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43872. * @param maxCapacity defines the maximum capacity per leaf
  43873. * @param maxDepth defines the maximum depth of the octree
  43874. * @returns an octree of AbstractMesh
  43875. */
  43876. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  43877. }
  43878. }
  43879. module "babylonjs/Meshes/abstractMesh" {
  43880. interface AbstractMesh {
  43881. /**
  43882. * @hidden
  43883. * Backing Field
  43884. */
  43885. _submeshesOctree: Octree<SubMesh>;
  43886. /**
  43887. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  43888. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  43889. * @param maxCapacity defines the maximum size of each block (64 by default)
  43890. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  43891. * @returns the new octree
  43892. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  43893. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  43894. */
  43895. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  43896. }
  43897. }
  43898. /**
  43899. * Defines the octree scene component responsible to manage any octrees
  43900. * in a given scene.
  43901. */
  43902. export class OctreeSceneComponent {
  43903. /**
  43904. * The component name help to identify the component in the list of scene components.
  43905. */
  43906. readonly name: string;
  43907. /**
  43908. * The scene the component belongs to.
  43909. */
  43910. scene: Scene;
  43911. /**
  43912. * Indicates if the meshes have been checked to make sure they are isEnabled()
  43913. */
  43914. readonly checksIsEnabled: boolean;
  43915. /**
  43916. * Creates a new instance of the component for the given scene
  43917. * @param scene Defines the scene to register the component in
  43918. */
  43919. constructor(scene: Scene);
  43920. /**
  43921. * Registers the component in a given scene
  43922. */
  43923. register(): void;
  43924. /**
  43925. * Return the list of active meshes
  43926. * @returns the list of active meshes
  43927. */
  43928. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  43929. /**
  43930. * Return the list of active sub meshes
  43931. * @param mesh The mesh to get the candidates sub meshes from
  43932. * @returns the list of active sub meshes
  43933. */
  43934. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  43935. private _tempRay;
  43936. /**
  43937. * Return the list of sub meshes intersecting with a given local ray
  43938. * @param mesh defines the mesh to find the submesh for
  43939. * @param localRay defines the ray in local space
  43940. * @returns the list of intersecting sub meshes
  43941. */
  43942. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  43943. /**
  43944. * Return the list of sub meshes colliding with a collider
  43945. * @param mesh defines the mesh to find the submesh for
  43946. * @param collider defines the collider to evaluate the collision against
  43947. * @returns the list of colliding sub meshes
  43948. */
  43949. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  43950. /**
  43951. * Rebuilds the elements related to this component in case of
  43952. * context lost for instance.
  43953. */
  43954. rebuild(): void;
  43955. /**
  43956. * Disposes the component and the associated ressources.
  43957. */
  43958. dispose(): void;
  43959. }
  43960. }
  43961. declare module "babylonjs/Culling/Octrees/index" {
  43962. export * from "babylonjs/Culling/Octrees/octree";
  43963. export * from "babylonjs/Culling/Octrees/octreeBlock";
  43964. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  43965. }
  43966. declare module "babylonjs/Culling/index" {
  43967. export * from "babylonjs/Culling/boundingBox";
  43968. export * from "babylonjs/Culling/boundingInfo";
  43969. export * from "babylonjs/Culling/boundingSphere";
  43970. export * from "babylonjs/Culling/Octrees/index";
  43971. export * from "babylonjs/Culling/ray";
  43972. }
  43973. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  43974. import { IDisposable, Scene } from "babylonjs/scene";
  43975. import { Nullable } from "babylonjs/types";
  43976. import { Observable } from "babylonjs/Misc/observable";
  43977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43978. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  43979. import { Camera } from "babylonjs/Cameras/camera";
  43980. /**
  43981. * Renders a layer on top of an existing scene
  43982. */
  43983. export class UtilityLayerRenderer implements IDisposable {
  43984. /** the original scene that will be rendered on top of */
  43985. originalScene: Scene;
  43986. private _pointerCaptures;
  43987. private _lastPointerEvents;
  43988. private static _DefaultUtilityLayer;
  43989. private static _DefaultKeepDepthUtilityLayer;
  43990. private _sharedGizmoLight;
  43991. private _renderCamera;
  43992. /**
  43993. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  43994. * @returns the camera that is used when rendering the utility layer
  43995. */
  43996. getRenderCamera(): Nullable<Camera>;
  43997. /**
  43998. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  43999. * @param cam the camera that should be used when rendering the utility layer
  44000. */
  44001. setRenderCamera(cam: Nullable<Camera>): void;
  44002. /**
  44003. * @hidden
  44004. * Light which used by gizmos to get light shading
  44005. */
  44006. _getSharedGizmoLight(): HemisphericLight;
  44007. /**
  44008. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  44009. */
  44010. pickUtilitySceneFirst: boolean;
  44011. /**
  44012. * 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)
  44013. */
  44014. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  44015. /**
  44016. * 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)
  44017. */
  44018. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  44019. /**
  44020. * The scene that is rendered on top of the original scene
  44021. */
  44022. utilityLayerScene: Scene;
  44023. /**
  44024. * If the utility layer should automatically be rendered on top of existing scene
  44025. */
  44026. shouldRender: boolean;
  44027. /**
  44028. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  44029. */
  44030. onlyCheckPointerDownEvents: boolean;
  44031. /**
  44032. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  44033. */
  44034. processAllEvents: boolean;
  44035. /**
  44036. * Observable raised when the pointer move from the utility layer scene to the main scene
  44037. */
  44038. onPointerOutObservable: Observable<number>;
  44039. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  44040. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  44041. private _afterRenderObserver;
  44042. private _sceneDisposeObserver;
  44043. private _originalPointerObserver;
  44044. /**
  44045. * Instantiates a UtilityLayerRenderer
  44046. * @param originalScene the original scene that will be rendered on top of
  44047. * @param handleEvents boolean indicating if the utility layer should handle events
  44048. */
  44049. constructor(
  44050. /** the original scene that will be rendered on top of */
  44051. originalScene: Scene, handleEvents?: boolean);
  44052. private _notifyObservers;
  44053. /**
  44054. * Renders the utility layers scene on top of the original scene
  44055. */
  44056. render(): void;
  44057. /**
  44058. * Disposes of the renderer
  44059. */
  44060. dispose(): void;
  44061. private _updateCamera;
  44062. }
  44063. }
  44064. declare module "babylonjs/Gizmos/gizmo" {
  44065. import { Nullable } from "babylonjs/types";
  44066. import { IDisposable } from "babylonjs/scene";
  44067. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44068. import { Mesh } from "babylonjs/Meshes/mesh";
  44069. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44070. /**
  44071. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  44072. */
  44073. export class Gizmo implements IDisposable {
  44074. /** The utility layer the gizmo will be added to */
  44075. gizmoLayer: UtilityLayerRenderer;
  44076. /**
  44077. * The root mesh of the gizmo
  44078. */
  44079. _rootMesh: Mesh;
  44080. private _attachedMesh;
  44081. /**
  44082. * Ratio for the scale of the gizmo (Default: 1)
  44083. */
  44084. scaleRatio: number;
  44085. /**
  44086. * If a custom mesh has been set (Default: false)
  44087. */
  44088. protected _customMeshSet: boolean;
  44089. /**
  44090. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  44091. * * When set, interactions will be enabled
  44092. */
  44093. attachedMesh: Nullable<AbstractMesh>;
  44094. /**
  44095. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  44096. * @param mesh The mesh to replace the default mesh of the gizmo
  44097. */
  44098. setCustomMesh(mesh: Mesh): void;
  44099. /**
  44100. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  44101. */
  44102. updateGizmoRotationToMatchAttachedMesh: boolean;
  44103. /**
  44104. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  44105. */
  44106. updateGizmoPositionToMatchAttachedMesh: boolean;
  44107. /**
  44108. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  44109. */
  44110. updateScale: boolean;
  44111. protected _interactionsEnabled: boolean;
  44112. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44113. private _beforeRenderObserver;
  44114. private _tempVector;
  44115. /**
  44116. * Creates a gizmo
  44117. * @param gizmoLayer The utility layer the gizmo will be added to
  44118. */
  44119. constructor(
  44120. /** The utility layer the gizmo will be added to */
  44121. gizmoLayer?: UtilityLayerRenderer);
  44122. /**
  44123. * Updates the gizmo to match the attached mesh's position/rotation
  44124. */
  44125. protected _update(): void;
  44126. /**
  44127. * Disposes of the gizmo
  44128. */
  44129. dispose(): void;
  44130. }
  44131. }
  44132. declare module "babylonjs/Gizmos/planeDragGizmo" {
  44133. import { Observable } from "babylonjs/Misc/observable";
  44134. import { Nullable } from "babylonjs/types";
  44135. import { Vector3 } from "babylonjs/Maths/math.vector";
  44136. import { Color3 } from "babylonjs/Maths/math.color";
  44137. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44138. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44139. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44140. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44141. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44142. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44143. import { Scene } from "babylonjs/scene";
  44144. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44145. /**
  44146. * Single plane drag gizmo
  44147. */
  44148. export class PlaneDragGizmo extends Gizmo {
  44149. /**
  44150. * Drag behavior responsible for the gizmos dragging interactions
  44151. */
  44152. dragBehavior: PointerDragBehavior;
  44153. private _pointerObserver;
  44154. /**
  44155. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44156. */
  44157. snapDistance: number;
  44158. /**
  44159. * Event that fires each time the gizmo snaps to a new location.
  44160. * * snapDistance is the the change in distance
  44161. */
  44162. onSnapObservable: Observable<{
  44163. snapDistance: number;
  44164. }>;
  44165. private _plane;
  44166. private _coloredMaterial;
  44167. private _hoverMaterial;
  44168. private _isEnabled;
  44169. private _parent;
  44170. /** @hidden */
  44171. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  44172. /** @hidden */
  44173. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44174. /**
  44175. * Creates a PlaneDragGizmo
  44176. * @param gizmoLayer The utility layer the gizmo will be added to
  44177. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  44178. * @param color The color of the gizmo
  44179. */
  44180. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44181. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44182. /**
  44183. * If the gizmo is enabled
  44184. */
  44185. isEnabled: boolean;
  44186. /**
  44187. * Disposes of the gizmo
  44188. */
  44189. dispose(): void;
  44190. }
  44191. }
  44192. declare module "babylonjs/Gizmos/positionGizmo" {
  44193. import { Observable } from "babylonjs/Misc/observable";
  44194. import { Nullable } from "babylonjs/types";
  44195. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44196. import { Mesh } from "babylonjs/Meshes/mesh";
  44197. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44198. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  44199. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  44200. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44201. /**
  44202. * Gizmo that enables dragging a mesh along 3 axis
  44203. */
  44204. export class PositionGizmo extends Gizmo {
  44205. /**
  44206. * Internal gizmo used for interactions on the x axis
  44207. */
  44208. xGizmo: AxisDragGizmo;
  44209. /**
  44210. * Internal gizmo used for interactions on the y axis
  44211. */
  44212. yGizmo: AxisDragGizmo;
  44213. /**
  44214. * Internal gizmo used for interactions on the z axis
  44215. */
  44216. zGizmo: AxisDragGizmo;
  44217. /**
  44218. * Internal gizmo used for interactions on the yz plane
  44219. */
  44220. xPlaneGizmo: PlaneDragGizmo;
  44221. /**
  44222. * Internal gizmo used for interactions on the xz plane
  44223. */
  44224. yPlaneGizmo: PlaneDragGizmo;
  44225. /**
  44226. * Internal gizmo used for interactions on the xy plane
  44227. */
  44228. zPlaneGizmo: PlaneDragGizmo;
  44229. /**
  44230. * private variables
  44231. */
  44232. private _meshAttached;
  44233. private _updateGizmoRotationToMatchAttachedMesh;
  44234. private _snapDistance;
  44235. private _scaleRatio;
  44236. /** Fires an event when any of it's sub gizmos are dragged */
  44237. onDragStartObservable: Observable<unknown>;
  44238. /** Fires an event when any of it's sub gizmos are released from dragging */
  44239. onDragEndObservable: Observable<unknown>;
  44240. /**
  44241. * If set to true, planar drag is enabled
  44242. */
  44243. private _planarGizmoEnabled;
  44244. attachedMesh: Nullable<AbstractMesh>;
  44245. /**
  44246. * Creates a PositionGizmo
  44247. * @param gizmoLayer The utility layer the gizmo will be added to
  44248. */
  44249. constructor(gizmoLayer?: UtilityLayerRenderer);
  44250. /**
  44251. * If the planar drag gizmo is enabled
  44252. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  44253. */
  44254. planarGizmoEnabled: boolean;
  44255. updateGizmoRotationToMatchAttachedMesh: boolean;
  44256. /**
  44257. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44258. */
  44259. snapDistance: number;
  44260. /**
  44261. * Ratio for the scale of the gizmo (Default: 1)
  44262. */
  44263. scaleRatio: number;
  44264. /**
  44265. * Disposes of the gizmo
  44266. */
  44267. dispose(): void;
  44268. /**
  44269. * CustomMeshes are not supported by this gizmo
  44270. * @param mesh The mesh to replace the default mesh of the gizmo
  44271. */
  44272. setCustomMesh(mesh: Mesh): void;
  44273. }
  44274. }
  44275. declare module "babylonjs/Gizmos/axisDragGizmo" {
  44276. import { Observable } from "babylonjs/Misc/observable";
  44277. import { Nullable } from "babylonjs/types";
  44278. import { Vector3 } from "babylonjs/Maths/math.vector";
  44279. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44280. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44281. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44282. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44283. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44284. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44285. import { Scene } from "babylonjs/scene";
  44286. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44287. import { Color3 } from "babylonjs/Maths/math.color";
  44288. /**
  44289. * Single axis drag gizmo
  44290. */
  44291. export class AxisDragGizmo extends Gizmo {
  44292. /**
  44293. * Drag behavior responsible for the gizmos dragging interactions
  44294. */
  44295. dragBehavior: PointerDragBehavior;
  44296. private _pointerObserver;
  44297. /**
  44298. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44299. */
  44300. snapDistance: number;
  44301. /**
  44302. * Event that fires each time the gizmo snaps to a new location.
  44303. * * snapDistance is the the change in distance
  44304. */
  44305. onSnapObservable: Observable<{
  44306. snapDistance: number;
  44307. }>;
  44308. private _isEnabled;
  44309. private _parent;
  44310. private _arrow;
  44311. private _coloredMaterial;
  44312. private _hoverMaterial;
  44313. /** @hidden */
  44314. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  44315. /** @hidden */
  44316. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44317. /**
  44318. * Creates an AxisDragGizmo
  44319. * @param gizmoLayer The utility layer the gizmo will be added to
  44320. * @param dragAxis The axis which the gizmo will be able to drag on
  44321. * @param color The color of the gizmo
  44322. */
  44323. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44324. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44325. /**
  44326. * If the gizmo is enabled
  44327. */
  44328. isEnabled: boolean;
  44329. /**
  44330. * Disposes of the gizmo
  44331. */
  44332. dispose(): void;
  44333. }
  44334. }
  44335. declare module "babylonjs/Debug/axesViewer" {
  44336. import { Vector3 } from "babylonjs/Maths/math.vector";
  44337. import { Nullable } from "babylonjs/types";
  44338. import { Scene } from "babylonjs/scene";
  44339. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44340. /**
  44341. * The Axes viewer will show 3 axes in a specific point in space
  44342. */
  44343. export class AxesViewer {
  44344. private _xAxis;
  44345. private _yAxis;
  44346. private _zAxis;
  44347. private _scaleLinesFactor;
  44348. private _instanced;
  44349. /**
  44350. * Gets the hosting scene
  44351. */
  44352. scene: Scene;
  44353. /**
  44354. * Gets or sets a number used to scale line length
  44355. */
  44356. scaleLines: number;
  44357. /** Gets the node hierarchy used to render x-axis */
  44358. readonly xAxis: TransformNode;
  44359. /** Gets the node hierarchy used to render y-axis */
  44360. readonly yAxis: TransformNode;
  44361. /** Gets the node hierarchy used to render z-axis */
  44362. readonly zAxis: TransformNode;
  44363. /**
  44364. * Creates a new AxesViewer
  44365. * @param scene defines the hosting scene
  44366. * @param scaleLines defines a number used to scale line length (1 by default)
  44367. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  44368. * @param xAxis defines the node hierarchy used to render the x-axis
  44369. * @param yAxis defines the node hierarchy used to render the y-axis
  44370. * @param zAxis defines the node hierarchy used to render the z-axis
  44371. */
  44372. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  44373. /**
  44374. * Force the viewer to update
  44375. * @param position defines the position of the viewer
  44376. * @param xaxis defines the x axis of the viewer
  44377. * @param yaxis defines the y axis of the viewer
  44378. * @param zaxis defines the z axis of the viewer
  44379. */
  44380. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  44381. /**
  44382. * Creates an instance of this axes viewer.
  44383. * @returns a new axes viewer with instanced meshes
  44384. */
  44385. createInstance(): AxesViewer;
  44386. /** Releases resources */
  44387. dispose(): void;
  44388. private static _SetRenderingGroupId;
  44389. }
  44390. }
  44391. declare module "babylonjs/Debug/boneAxesViewer" {
  44392. import { Nullable } from "babylonjs/types";
  44393. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  44394. import { Vector3 } from "babylonjs/Maths/math.vector";
  44395. import { Mesh } from "babylonjs/Meshes/mesh";
  44396. import { Bone } from "babylonjs/Bones/bone";
  44397. import { Scene } from "babylonjs/scene";
  44398. /**
  44399. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  44400. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  44401. */
  44402. export class BoneAxesViewer extends AxesViewer {
  44403. /**
  44404. * Gets or sets the target mesh where to display the axes viewer
  44405. */
  44406. mesh: Nullable<Mesh>;
  44407. /**
  44408. * Gets or sets the target bone where to display the axes viewer
  44409. */
  44410. bone: Nullable<Bone>;
  44411. /** Gets current position */
  44412. pos: Vector3;
  44413. /** Gets direction of X axis */
  44414. xaxis: Vector3;
  44415. /** Gets direction of Y axis */
  44416. yaxis: Vector3;
  44417. /** Gets direction of Z axis */
  44418. zaxis: Vector3;
  44419. /**
  44420. * Creates a new BoneAxesViewer
  44421. * @param scene defines the hosting scene
  44422. * @param bone defines the target bone
  44423. * @param mesh defines the target mesh
  44424. * @param scaleLines defines a scaling factor for line length (1 by default)
  44425. */
  44426. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  44427. /**
  44428. * Force the viewer to update
  44429. */
  44430. update(): void;
  44431. /** Releases resources */
  44432. dispose(): void;
  44433. }
  44434. }
  44435. declare module "babylonjs/Debug/debugLayer" {
  44436. import { Scene } from "babylonjs/scene";
  44437. /**
  44438. * Interface used to define scene explorer extensibility option
  44439. */
  44440. export interface IExplorerExtensibilityOption {
  44441. /**
  44442. * Define the option label
  44443. */
  44444. label: string;
  44445. /**
  44446. * Defines the action to execute on click
  44447. */
  44448. action: (entity: any) => void;
  44449. }
  44450. /**
  44451. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  44452. */
  44453. export interface IExplorerExtensibilityGroup {
  44454. /**
  44455. * Defines a predicate to test if a given type mut be extended
  44456. */
  44457. predicate: (entity: any) => boolean;
  44458. /**
  44459. * Gets the list of options added to a type
  44460. */
  44461. entries: IExplorerExtensibilityOption[];
  44462. }
  44463. /**
  44464. * Interface used to define the options to use to create the Inspector
  44465. */
  44466. export interface IInspectorOptions {
  44467. /**
  44468. * Display in overlay mode (default: false)
  44469. */
  44470. overlay?: boolean;
  44471. /**
  44472. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  44473. */
  44474. globalRoot?: HTMLElement;
  44475. /**
  44476. * Display the Scene explorer
  44477. */
  44478. showExplorer?: boolean;
  44479. /**
  44480. * Display the property inspector
  44481. */
  44482. showInspector?: boolean;
  44483. /**
  44484. * Display in embed mode (both panes on the right)
  44485. */
  44486. embedMode?: boolean;
  44487. /**
  44488. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  44489. */
  44490. handleResize?: boolean;
  44491. /**
  44492. * Allow the panes to popup (default: true)
  44493. */
  44494. enablePopup?: boolean;
  44495. /**
  44496. * Allow the panes to be closed by users (default: true)
  44497. */
  44498. enableClose?: boolean;
  44499. /**
  44500. * Optional list of extensibility entries
  44501. */
  44502. explorerExtensibility?: IExplorerExtensibilityGroup[];
  44503. /**
  44504. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  44505. */
  44506. inspectorURL?: string;
  44507. }
  44508. module "babylonjs/scene" {
  44509. interface Scene {
  44510. /**
  44511. * @hidden
  44512. * Backing field
  44513. */
  44514. _debugLayer: DebugLayer;
  44515. /**
  44516. * Gets the debug layer (aka Inspector) associated with the scene
  44517. * @see http://doc.babylonjs.com/features/playground_debuglayer
  44518. */
  44519. debugLayer: DebugLayer;
  44520. }
  44521. }
  44522. /**
  44523. * The debug layer (aka Inspector) is the go to tool in order to better understand
  44524. * what is happening in your scene
  44525. * @see http://doc.babylonjs.com/features/playground_debuglayer
  44526. */
  44527. export class DebugLayer {
  44528. /**
  44529. * Define the url to get the inspector script from.
  44530. * By default it uses the babylonjs CDN.
  44531. * @ignoreNaming
  44532. */
  44533. static InspectorURL: string;
  44534. private _scene;
  44535. private BJSINSPECTOR;
  44536. private _onPropertyChangedObservable?;
  44537. /**
  44538. * Observable triggered when a property is changed through the inspector.
  44539. */
  44540. readonly onPropertyChangedObservable: any;
  44541. /**
  44542. * Instantiates a new debug layer.
  44543. * The debug layer (aka Inspector) is the go to tool in order to better understand
  44544. * what is happening in your scene
  44545. * @see http://doc.babylonjs.com/features/playground_debuglayer
  44546. * @param scene Defines the scene to inspect
  44547. */
  44548. constructor(scene: Scene);
  44549. /** Creates the inspector window. */
  44550. private _createInspector;
  44551. /**
  44552. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  44553. * @param entity defines the entity to select
  44554. * @param lineContainerTitle defines the specific block to highlight
  44555. */
  44556. select(entity: any, lineContainerTitle?: string): void;
  44557. /** Get the inspector from bundle or global */
  44558. private _getGlobalInspector;
  44559. /**
  44560. * Get if the inspector is visible or not.
  44561. * @returns true if visible otherwise, false
  44562. */
  44563. isVisible(): boolean;
  44564. /**
  44565. * Hide the inspector and close its window.
  44566. */
  44567. hide(): void;
  44568. /**
  44569. * Launch the debugLayer.
  44570. * @param config Define the configuration of the inspector
  44571. * @return a promise fulfilled when the debug layer is visible
  44572. */
  44573. show(config?: IInspectorOptions): Promise<DebugLayer>;
  44574. }
  44575. }
  44576. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  44577. import { Nullable } from "babylonjs/types";
  44578. import { Scene } from "babylonjs/scene";
  44579. import { Vector4 } from "babylonjs/Maths/math.vector";
  44580. import { Color4 } from "babylonjs/Maths/math.color";
  44581. import { Mesh } from "babylonjs/Meshes/mesh";
  44582. /**
  44583. * Class containing static functions to help procedurally build meshes
  44584. */
  44585. export class BoxBuilder {
  44586. /**
  44587. * Creates a box mesh
  44588. * * The parameter `size` sets the size (float) of each box side (default 1)
  44589. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  44590. * * 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)
  44591. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  44592. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44593. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44594. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44595. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  44596. * @param name defines the name of the mesh
  44597. * @param options defines the options used to create the mesh
  44598. * @param scene defines the hosting scene
  44599. * @returns the box mesh
  44600. */
  44601. static CreateBox(name: string, options: {
  44602. size?: number;
  44603. width?: number;
  44604. height?: number;
  44605. depth?: number;
  44606. faceUV?: Vector4[];
  44607. faceColors?: Color4[];
  44608. sideOrientation?: number;
  44609. frontUVs?: Vector4;
  44610. backUVs?: Vector4;
  44611. wrap?: boolean;
  44612. topBaseAt?: number;
  44613. bottomBaseAt?: number;
  44614. updatable?: boolean;
  44615. }, scene?: Nullable<Scene>): Mesh;
  44616. }
  44617. }
  44618. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  44619. import { Vector4 } from "babylonjs/Maths/math.vector";
  44620. import { Mesh } from "babylonjs/Meshes/mesh";
  44621. /**
  44622. * Class containing static functions to help procedurally build meshes
  44623. */
  44624. export class SphereBuilder {
  44625. /**
  44626. * Creates a sphere mesh
  44627. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  44628. * * 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`)
  44629. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  44630. * * 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
  44631. * * 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)
  44632. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44633. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44634. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44635. * @param name defines the name of the mesh
  44636. * @param options defines the options used to create the mesh
  44637. * @param scene defines the hosting scene
  44638. * @returns the sphere mesh
  44639. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  44640. */
  44641. static CreateSphere(name: string, options: {
  44642. segments?: number;
  44643. diameter?: number;
  44644. diameterX?: number;
  44645. diameterY?: number;
  44646. diameterZ?: number;
  44647. arc?: number;
  44648. slice?: number;
  44649. sideOrientation?: number;
  44650. frontUVs?: Vector4;
  44651. backUVs?: Vector4;
  44652. updatable?: boolean;
  44653. }, scene: any): Mesh;
  44654. }
  44655. }
  44656. declare module "babylonjs/Debug/physicsViewer" {
  44657. import { Nullable } from "babylonjs/types";
  44658. import { Scene } from "babylonjs/scene";
  44659. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44660. import { Mesh } from "babylonjs/Meshes/mesh";
  44661. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  44662. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  44663. /**
  44664. * Used to show the physics impostor around the specific mesh
  44665. */
  44666. export class PhysicsViewer {
  44667. /** @hidden */
  44668. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  44669. /** @hidden */
  44670. protected _meshes: Array<Nullable<AbstractMesh>>;
  44671. /** @hidden */
  44672. protected _scene: Nullable<Scene>;
  44673. /** @hidden */
  44674. protected _numMeshes: number;
  44675. /** @hidden */
  44676. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  44677. private _renderFunction;
  44678. private _utilityLayer;
  44679. private _debugBoxMesh;
  44680. private _debugSphereMesh;
  44681. private _debugCylinderMesh;
  44682. private _debugMaterial;
  44683. private _debugMeshMeshes;
  44684. /**
  44685. * Creates a new PhysicsViewer
  44686. * @param scene defines the hosting scene
  44687. */
  44688. constructor(scene: Scene);
  44689. /** @hidden */
  44690. protected _updateDebugMeshes(): void;
  44691. /**
  44692. * Renders a specified physic impostor
  44693. * @param impostor defines the impostor to render
  44694. * @param targetMesh defines the mesh represented by the impostor
  44695. * @returns the new debug mesh used to render the impostor
  44696. */
  44697. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  44698. /**
  44699. * Hides a specified physic impostor
  44700. * @param impostor defines the impostor to hide
  44701. */
  44702. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  44703. private _getDebugMaterial;
  44704. private _getDebugBoxMesh;
  44705. private _getDebugSphereMesh;
  44706. private _getDebugCylinderMesh;
  44707. private _getDebugMeshMesh;
  44708. private _getDebugMesh;
  44709. /** Releases all resources */
  44710. dispose(): void;
  44711. }
  44712. }
  44713. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  44714. import { Vector3 } from "babylonjs/Maths/math.vector";
  44715. import { Color4 } from "babylonjs/Maths/math.color";
  44716. import { Nullable } from "babylonjs/types";
  44717. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  44718. import { Scene } from "babylonjs/scene";
  44719. /**
  44720. * Class containing static functions to help procedurally build meshes
  44721. */
  44722. export class LinesBuilder {
  44723. /**
  44724. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  44725. * * 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
  44726. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  44727. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  44728. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  44729. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  44730. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  44731. * * 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
  44732. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  44733. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44734. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  44735. * @param name defines the name of the new line system
  44736. * @param options defines the options used to create the line system
  44737. * @param scene defines the hosting scene
  44738. * @returns a new line system mesh
  44739. */
  44740. static CreateLineSystem(name: string, options: {
  44741. lines: Vector3[][];
  44742. updatable?: boolean;
  44743. instance?: Nullable<LinesMesh>;
  44744. colors?: Nullable<Color4[][]>;
  44745. useVertexAlpha?: boolean;
  44746. }, scene: Nullable<Scene>): LinesMesh;
  44747. /**
  44748. * Creates a line mesh
  44749. * 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
  44750. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  44751. * * The parameter `points` is an array successive Vector3
  44752. * * 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
  44753. * * The optional parameter `colors` is an array of successive Color4, one per line point
  44754. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  44755. * * When updating an instance, remember that only point positions can change, not the number of points
  44756. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44757. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  44758. * @param name defines the name of the new line system
  44759. * @param options defines the options used to create the line system
  44760. * @param scene defines the hosting scene
  44761. * @returns a new line mesh
  44762. */
  44763. static CreateLines(name: string, options: {
  44764. points: Vector3[];
  44765. updatable?: boolean;
  44766. instance?: Nullable<LinesMesh>;
  44767. colors?: Color4[];
  44768. useVertexAlpha?: boolean;
  44769. }, scene?: Nullable<Scene>): LinesMesh;
  44770. /**
  44771. * Creates a dashed line mesh
  44772. * * 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
  44773. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  44774. * * The parameter `points` is an array successive Vector3
  44775. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  44776. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  44777. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  44778. * * 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
  44779. * * When updating an instance, remember that only point positions can change, not the number of points
  44780. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44781. * @param name defines the name of the mesh
  44782. * @param options defines the options used to create the mesh
  44783. * @param scene defines the hosting scene
  44784. * @returns the dashed line mesh
  44785. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  44786. */
  44787. static CreateDashedLines(name: string, options: {
  44788. points: Vector3[];
  44789. dashSize?: number;
  44790. gapSize?: number;
  44791. dashNb?: number;
  44792. updatable?: boolean;
  44793. instance?: LinesMesh;
  44794. }, scene?: Nullable<Scene>): LinesMesh;
  44795. }
  44796. }
  44797. declare module "babylonjs/Debug/rayHelper" {
  44798. import { Nullable } from "babylonjs/types";
  44799. import { Ray } from "babylonjs/Culling/ray";
  44800. import { Vector3 } from "babylonjs/Maths/math.vector";
  44801. import { Color3 } from "babylonjs/Maths/math.color";
  44802. import { Scene } from "babylonjs/scene";
  44803. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44804. import "babylonjs/Meshes/Builders/linesBuilder";
  44805. /**
  44806. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  44807. * in order to better appreciate the issue one might have.
  44808. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  44809. */
  44810. export class RayHelper {
  44811. /**
  44812. * Defines the ray we are currently tryin to visualize.
  44813. */
  44814. ray: Nullable<Ray>;
  44815. private _renderPoints;
  44816. private _renderLine;
  44817. private _renderFunction;
  44818. private _scene;
  44819. private _updateToMeshFunction;
  44820. private _attachedToMesh;
  44821. private _meshSpaceDirection;
  44822. private _meshSpaceOrigin;
  44823. /**
  44824. * Helper function to create a colored helper in a scene in one line.
  44825. * @param ray Defines the ray we are currently tryin to visualize
  44826. * @param scene Defines the scene the ray is used in
  44827. * @param color Defines the color we want to see the ray in
  44828. * @returns The newly created ray helper.
  44829. */
  44830. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  44831. /**
  44832. * Instantiate a new ray helper.
  44833. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  44834. * in order to better appreciate the issue one might have.
  44835. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  44836. * @param ray Defines the ray we are currently tryin to visualize
  44837. */
  44838. constructor(ray: Ray);
  44839. /**
  44840. * Shows the ray we are willing to debug.
  44841. * @param scene Defines the scene the ray needs to be rendered in
  44842. * @param color Defines the color the ray needs to be rendered in
  44843. */
  44844. show(scene: Scene, color?: Color3): void;
  44845. /**
  44846. * Hides the ray we are debugging.
  44847. */
  44848. hide(): void;
  44849. private _render;
  44850. /**
  44851. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  44852. * @param mesh Defines the mesh we want the helper attached to
  44853. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  44854. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  44855. * @param length Defines the length of the ray
  44856. */
  44857. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  44858. /**
  44859. * Detach the ray helper from the mesh it has previously been attached to.
  44860. */
  44861. detachFromMesh(): void;
  44862. private _updateToMesh;
  44863. /**
  44864. * Dispose the helper and release its associated resources.
  44865. */
  44866. dispose(): void;
  44867. }
  44868. }
  44869. declare module "babylonjs/Debug/skeletonViewer" {
  44870. import { Color3 } from "babylonjs/Maths/math.color";
  44871. import { Scene } from "babylonjs/scene";
  44872. import { Nullable } from "babylonjs/types";
  44873. import { Skeleton } from "babylonjs/Bones/skeleton";
  44874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44875. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  44876. /**
  44877. * Class used to render a debug view of a given skeleton
  44878. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  44879. */
  44880. export class SkeletonViewer {
  44881. /** defines the skeleton to render */
  44882. skeleton: Skeleton;
  44883. /** defines the mesh attached to the skeleton */
  44884. mesh: AbstractMesh;
  44885. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  44886. autoUpdateBonesMatrices: boolean;
  44887. /** defines the rendering group id to use with the viewer */
  44888. renderingGroupId: number;
  44889. /** Gets or sets the color used to render the skeleton */
  44890. color: Color3;
  44891. private _scene;
  44892. private _debugLines;
  44893. private _debugMesh;
  44894. private _isEnabled;
  44895. private _renderFunction;
  44896. private _utilityLayer;
  44897. /**
  44898. * Returns the mesh used to render the bones
  44899. */
  44900. readonly debugMesh: Nullable<LinesMesh>;
  44901. /**
  44902. * Creates a new SkeletonViewer
  44903. * @param skeleton defines the skeleton to render
  44904. * @param mesh defines the mesh attached to the skeleton
  44905. * @param scene defines the hosting scene
  44906. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  44907. * @param renderingGroupId defines the rendering group id to use with the viewer
  44908. */
  44909. constructor(
  44910. /** defines the skeleton to render */
  44911. skeleton: Skeleton,
  44912. /** defines the mesh attached to the skeleton */
  44913. mesh: AbstractMesh, scene: Scene,
  44914. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  44915. autoUpdateBonesMatrices?: boolean,
  44916. /** defines the rendering group id to use with the viewer */
  44917. renderingGroupId?: number);
  44918. /** Gets or sets a boolean indicating if the viewer is enabled */
  44919. isEnabled: boolean;
  44920. private _getBonePosition;
  44921. private _getLinesForBonesWithLength;
  44922. private _getLinesForBonesNoLength;
  44923. /** Update the viewer to sync with current skeleton state */
  44924. update(): void;
  44925. /** Release associated resources */
  44926. dispose(): void;
  44927. }
  44928. }
  44929. declare module "babylonjs/Debug/index" {
  44930. export * from "babylonjs/Debug/axesViewer";
  44931. export * from "babylonjs/Debug/boneAxesViewer";
  44932. export * from "babylonjs/Debug/debugLayer";
  44933. export * from "babylonjs/Debug/physicsViewer";
  44934. export * from "babylonjs/Debug/rayHelper";
  44935. export * from "babylonjs/Debug/skeletonViewer";
  44936. }
  44937. declare module "babylonjs/Engines/nullEngine" {
  44938. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  44939. import { Scene } from "babylonjs/scene";
  44940. import { Engine } from "babylonjs/Engines/engine";
  44941. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  44942. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  44943. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  44944. import { Effect } from "babylonjs/Materials/effect";
  44945. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  44946. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  44947. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  44948. /**
  44949. * Options to create the null engine
  44950. */
  44951. export class NullEngineOptions {
  44952. /**
  44953. * Render width (Default: 512)
  44954. */
  44955. renderWidth: number;
  44956. /**
  44957. * Render height (Default: 256)
  44958. */
  44959. renderHeight: number;
  44960. /**
  44961. * Texture size (Default: 512)
  44962. */
  44963. textureSize: number;
  44964. /**
  44965. * If delta time between frames should be constant
  44966. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  44967. */
  44968. deterministicLockstep: boolean;
  44969. /**
  44970. * Maximum about of steps between frames (Default: 4)
  44971. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  44972. */
  44973. lockstepMaxSteps: number;
  44974. }
  44975. /**
  44976. * The null engine class provides support for headless version of babylon.js.
  44977. * This can be used in server side scenario or for testing purposes
  44978. */
  44979. export class NullEngine extends Engine {
  44980. private _options;
  44981. /**
  44982. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  44983. */
  44984. isDeterministicLockStep(): boolean;
  44985. /** @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep */
  44986. getLockstepMaxSteps(): number;
  44987. /**
  44988. * Sets hardware scaling, used to save performance if needed
  44989. * @see https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  44990. */
  44991. getHardwareScalingLevel(): number;
  44992. constructor(options?: NullEngineOptions);
  44993. createVertexBuffer(vertices: FloatArray): DataBuffer;
  44994. createIndexBuffer(indices: IndicesArray): DataBuffer;
  44995. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  44996. getRenderWidth(useScreen?: boolean): number;
  44997. getRenderHeight(useScreen?: boolean): number;
  44998. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  44999. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  45000. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  45001. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  45002. bindSamplers(effect: Effect): void;
  45003. enableEffect(effect: Effect): void;
  45004. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  45005. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  45006. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  45007. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  45008. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  45009. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  45010. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  45011. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  45012. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  45013. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  45014. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  45015. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  45016. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  45017. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  45018. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45019. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45020. setFloat(uniform: WebGLUniformLocation, value: number): void;
  45021. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  45022. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  45023. setBool(uniform: WebGLUniformLocation, bool: number): void;
  45024. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  45025. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  45026. bindBuffers(vertexBuffers: {
  45027. [key: string]: VertexBuffer;
  45028. }, indexBuffer: DataBuffer, effect: Effect): void;
  45029. wipeCaches(bruteForce?: boolean): void;
  45030. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  45031. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  45032. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  45033. /** @hidden */
  45034. _createTexture(): WebGLTexture;
  45035. /** @hidden */
  45036. _releaseTexture(texture: InternalTexture): void;
  45037. 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;
  45038. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  45039. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  45040. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  45041. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  45042. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  45043. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  45044. areAllEffectsReady(): boolean;
  45045. /**
  45046. * @hidden
  45047. * Get the current error code of the webGL context
  45048. * @returns the error code
  45049. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  45050. */
  45051. getError(): number;
  45052. /** @hidden */
  45053. _getUnpackAlignement(): number;
  45054. /** @hidden */
  45055. _unpackFlipY(value: boolean): void;
  45056. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  45057. /**
  45058. * Updates a dynamic vertex buffer.
  45059. * @param vertexBuffer the vertex buffer to update
  45060. * @param data the data used to update the vertex buffer
  45061. * @param byteOffset the byte offset of the data (optional)
  45062. * @param byteLength the byte length of the data (optional)
  45063. */
  45064. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  45065. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  45066. /** @hidden */
  45067. _bindTexture(channel: number, texture: InternalTexture): void;
  45068. /** @hidden */
  45069. _releaseBuffer(buffer: DataBuffer): boolean;
  45070. releaseEffects(): void;
  45071. displayLoadingUI(): void;
  45072. hideLoadingUI(): void;
  45073. /** @hidden */
  45074. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45075. /** @hidden */
  45076. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45077. /** @hidden */
  45078. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45079. /** @hidden */
  45080. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  45081. }
  45082. }
  45083. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  45084. import { Nullable, int } from "babylonjs/types";
  45085. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  45086. /** @hidden */
  45087. export class _OcclusionDataStorage {
  45088. /** @hidden */
  45089. occlusionInternalRetryCounter: number;
  45090. /** @hidden */
  45091. isOcclusionQueryInProgress: boolean;
  45092. /** @hidden */
  45093. isOccluded: boolean;
  45094. /** @hidden */
  45095. occlusionRetryCount: number;
  45096. /** @hidden */
  45097. occlusionType: number;
  45098. /** @hidden */
  45099. occlusionQueryAlgorithmType: number;
  45100. }
  45101. module "babylonjs/Engines/engine" {
  45102. interface Engine {
  45103. /**
  45104. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  45105. * @return the new query
  45106. */
  45107. createQuery(): WebGLQuery;
  45108. /**
  45109. * Delete and release a webGL query
  45110. * @param query defines the query to delete
  45111. * @return the current engine
  45112. */
  45113. deleteQuery(query: WebGLQuery): Engine;
  45114. /**
  45115. * Check if a given query has resolved and got its value
  45116. * @param query defines the query to check
  45117. * @returns true if the query got its value
  45118. */
  45119. isQueryResultAvailable(query: WebGLQuery): boolean;
  45120. /**
  45121. * Gets the value of a given query
  45122. * @param query defines the query to check
  45123. * @returns the value of the query
  45124. */
  45125. getQueryResult(query: WebGLQuery): number;
  45126. /**
  45127. * Initiates an occlusion query
  45128. * @param algorithmType defines the algorithm to use
  45129. * @param query defines the query to use
  45130. * @returns the current engine
  45131. * @see http://doc.babylonjs.com/features/occlusionquery
  45132. */
  45133. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  45134. /**
  45135. * Ends an occlusion query
  45136. * @see http://doc.babylonjs.com/features/occlusionquery
  45137. * @param algorithmType defines the algorithm to use
  45138. * @returns the current engine
  45139. */
  45140. endOcclusionQuery(algorithmType: number): Engine;
  45141. /**
  45142. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  45143. * Please note that only one query can be issued at a time
  45144. * @returns a time token used to track the time span
  45145. */
  45146. startTimeQuery(): Nullable<_TimeToken>;
  45147. /**
  45148. * Ends a time query
  45149. * @param token defines the token used to measure the time span
  45150. * @returns the time spent (in ns)
  45151. */
  45152. endTimeQuery(token: _TimeToken): int;
  45153. /** @hidden */
  45154. _currentNonTimestampToken: Nullable<_TimeToken>;
  45155. /** @hidden */
  45156. _createTimeQuery(): WebGLQuery;
  45157. /** @hidden */
  45158. _deleteTimeQuery(query: WebGLQuery): void;
  45159. /** @hidden */
  45160. _getGlAlgorithmType(algorithmType: number): number;
  45161. /** @hidden */
  45162. _getTimeQueryResult(query: WebGLQuery): any;
  45163. /** @hidden */
  45164. _getTimeQueryAvailability(query: WebGLQuery): any;
  45165. }
  45166. }
  45167. module "babylonjs/Meshes/abstractMesh" {
  45168. interface AbstractMesh {
  45169. /**
  45170. * Backing filed
  45171. * @hidden
  45172. */
  45173. __occlusionDataStorage: _OcclusionDataStorage;
  45174. /**
  45175. * Access property
  45176. * @hidden
  45177. */
  45178. _occlusionDataStorage: _OcclusionDataStorage;
  45179. /**
  45180. * 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.
  45181. * The default value is -1 which means don't break the query and wait till the result
  45182. * @see http://doc.babylonjs.com/features/occlusionquery
  45183. */
  45184. occlusionRetryCount: number;
  45185. /**
  45186. * 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:
  45187. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  45188. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  45189. * * 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.
  45190. * @see http://doc.babylonjs.com/features/occlusionquery
  45191. */
  45192. occlusionType: number;
  45193. /**
  45194. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  45195. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  45196. * * 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.
  45197. * @see http://doc.babylonjs.com/features/occlusionquery
  45198. */
  45199. occlusionQueryAlgorithmType: number;
  45200. /**
  45201. * 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
  45202. * @see http://doc.babylonjs.com/features/occlusionquery
  45203. */
  45204. isOccluded: boolean;
  45205. /**
  45206. * Flag to check the progress status of the query
  45207. * @see http://doc.babylonjs.com/features/occlusionquery
  45208. */
  45209. isOcclusionQueryInProgress: boolean;
  45210. }
  45211. }
  45212. }
  45213. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  45214. import { Nullable } from "babylonjs/types";
  45215. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45216. /** @hidden */
  45217. export var _forceTransformFeedbackToBundle: boolean;
  45218. module "babylonjs/Engines/engine" {
  45219. interface Engine {
  45220. /**
  45221. * Creates a webGL transform feedback object
  45222. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  45223. * @returns the webGL transform feedback object
  45224. */
  45225. createTransformFeedback(): WebGLTransformFeedback;
  45226. /**
  45227. * Delete a webGL transform feedback object
  45228. * @param value defines the webGL transform feedback object to delete
  45229. */
  45230. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  45231. /**
  45232. * Bind a webGL transform feedback object to the webgl context
  45233. * @param value defines the webGL transform feedback object to bind
  45234. */
  45235. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  45236. /**
  45237. * Begins a transform feedback operation
  45238. * @param usePoints defines if points or triangles must be used
  45239. */
  45240. beginTransformFeedback(usePoints: boolean): void;
  45241. /**
  45242. * Ends a transform feedback operation
  45243. */
  45244. endTransformFeedback(): void;
  45245. /**
  45246. * Specify the varyings to use with transform feedback
  45247. * @param program defines the associated webGL program
  45248. * @param value defines the list of strings representing the varying names
  45249. */
  45250. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  45251. /**
  45252. * Bind a webGL buffer for a transform feedback operation
  45253. * @param value defines the webGL buffer to bind
  45254. */
  45255. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  45256. }
  45257. }
  45258. }
  45259. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  45260. import { Scene } from "babylonjs/scene";
  45261. import { Engine } from "babylonjs/Engines/engine";
  45262. import { Texture } from "babylonjs/Materials/Textures/texture";
  45263. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  45264. import "babylonjs/Engines/Extensions/engine.multiRender";
  45265. /**
  45266. * Creation options of the multi render target texture.
  45267. */
  45268. export interface IMultiRenderTargetOptions {
  45269. /**
  45270. * Define if the texture needs to create mip maps after render.
  45271. */
  45272. generateMipMaps?: boolean;
  45273. /**
  45274. * Define the types of all the draw buffers we want to create
  45275. */
  45276. types?: number[];
  45277. /**
  45278. * Define the sampling modes of all the draw buffers we want to create
  45279. */
  45280. samplingModes?: number[];
  45281. /**
  45282. * Define if a depth buffer is required
  45283. */
  45284. generateDepthBuffer?: boolean;
  45285. /**
  45286. * Define if a stencil buffer is required
  45287. */
  45288. generateStencilBuffer?: boolean;
  45289. /**
  45290. * Define if a depth texture is required instead of a depth buffer
  45291. */
  45292. generateDepthTexture?: boolean;
  45293. /**
  45294. * Define the number of desired draw buffers
  45295. */
  45296. textureCount?: number;
  45297. /**
  45298. * Define if aspect ratio should be adapted to the texture or stay the scene one
  45299. */
  45300. doNotChangeAspectRatio?: boolean;
  45301. /**
  45302. * Define the default type of the buffers we are creating
  45303. */
  45304. defaultType?: number;
  45305. }
  45306. /**
  45307. * A multi render target, like a render target provides the ability to render to a texture.
  45308. * Unlike the render target, it can render to several draw buffers in one draw.
  45309. * This is specially interesting in deferred rendering or for any effects requiring more than
  45310. * just one color from a single pass.
  45311. */
  45312. export class MultiRenderTarget extends RenderTargetTexture {
  45313. private _internalTextures;
  45314. private _textures;
  45315. private _multiRenderTargetOptions;
  45316. /**
  45317. * Get if draw buffers are currently supported by the used hardware and browser.
  45318. */
  45319. readonly isSupported: boolean;
  45320. /**
  45321. * Get the list of textures generated by the multi render target.
  45322. */
  45323. readonly textures: Texture[];
  45324. /**
  45325. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  45326. */
  45327. readonly depthTexture: Texture;
  45328. /**
  45329. * Set the wrapping mode on U of all the textures we are rendering to.
  45330. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  45331. */
  45332. wrapU: number;
  45333. /**
  45334. * Set the wrapping mode on V of all the textures we are rendering to.
  45335. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  45336. */
  45337. wrapV: number;
  45338. /**
  45339. * Instantiate a new multi render target texture.
  45340. * A multi render target, like a render target provides the ability to render to a texture.
  45341. * Unlike the render target, it can render to several draw buffers in one draw.
  45342. * This is specially interesting in deferred rendering or for any effects requiring more than
  45343. * just one color from a single pass.
  45344. * @param name Define the name of the texture
  45345. * @param size Define the size of the buffers to render to
  45346. * @param count Define the number of target we are rendering into
  45347. * @param scene Define the scene the texture belongs to
  45348. * @param options Define the options used to create the multi render target
  45349. */
  45350. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  45351. /** @hidden */
  45352. _rebuild(): void;
  45353. private _createInternalTextures;
  45354. private _createTextures;
  45355. /**
  45356. * Define the number of samples used if MSAA is enabled.
  45357. */
  45358. samples: number;
  45359. /**
  45360. * Resize all the textures in the multi render target.
  45361. * Be carrefull as it will recreate all the data in the new texture.
  45362. * @param size Define the new size
  45363. */
  45364. resize(size: any): void;
  45365. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  45366. /**
  45367. * Dispose the render targets and their associated resources
  45368. */
  45369. dispose(): void;
  45370. /**
  45371. * Release all the underlying texture used as draw buffers.
  45372. */
  45373. releaseInternalTextures(): void;
  45374. }
  45375. }
  45376. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  45377. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45378. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  45379. import { Nullable } from "babylonjs/types";
  45380. module "babylonjs/Engines/engine" {
  45381. interface Engine {
  45382. /**
  45383. * Unbind a list of render target textures from the webGL context
  45384. * This is used only when drawBuffer extension or webGL2 are active
  45385. * @param textures defines the render target textures to unbind
  45386. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  45387. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  45388. */
  45389. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  45390. /**
  45391. * Create a multi render target texture
  45392. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  45393. * @param size defines the size of the texture
  45394. * @param options defines the creation options
  45395. * @returns the cube texture as an InternalTexture
  45396. */
  45397. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  45398. /**
  45399. * Update the sample count for a given multiple render target texture
  45400. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  45401. * @param textures defines the textures to update
  45402. * @param samples defines the sample count to set
  45403. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  45404. */
  45405. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  45406. }
  45407. }
  45408. }
  45409. declare module "babylonjs/Engines/Extensions/index" {
  45410. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  45411. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  45412. export * from "babylonjs/Engines/Extensions/engine.multiview";
  45413. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  45414. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  45415. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  45416. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  45417. export * from "babylonjs/Engines/Extensions/engine.webVR";
  45418. }
  45419. declare module "babylonjs/Engines/index" {
  45420. export * from "babylonjs/Engines/constants";
  45421. export * from "babylonjs/Engines/engine";
  45422. export * from "babylonjs/Engines/engineStore";
  45423. export * from "babylonjs/Engines/nullEngine";
  45424. export * from "babylonjs/Engines/Extensions/index";
  45425. export * from "babylonjs/Engines/IPipelineContext";
  45426. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  45427. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  45428. }
  45429. declare module "babylonjs/Events/clipboardEvents" {
  45430. /**
  45431. * Gather the list of clipboard event types as constants.
  45432. */
  45433. export class ClipboardEventTypes {
  45434. /**
  45435. * The clipboard event is fired when a copy command is active (pressed).
  45436. */
  45437. static readonly COPY: number;
  45438. /**
  45439. * The clipboard event is fired when a cut command is active (pressed).
  45440. */
  45441. static readonly CUT: number;
  45442. /**
  45443. * The clipboard event is fired when a paste command is active (pressed).
  45444. */
  45445. static readonly PASTE: number;
  45446. }
  45447. /**
  45448. * This class is used to store clipboard related info for the onClipboardObservable event.
  45449. */
  45450. export class ClipboardInfo {
  45451. /**
  45452. * Defines the type of event (BABYLON.ClipboardEventTypes)
  45453. */
  45454. type: number;
  45455. /**
  45456. * Defines the related dom event
  45457. */
  45458. event: ClipboardEvent;
  45459. /**
  45460. *Creates an instance of ClipboardInfo.
  45461. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  45462. * @param event Defines the related dom event
  45463. */
  45464. constructor(
  45465. /**
  45466. * Defines the type of event (BABYLON.ClipboardEventTypes)
  45467. */
  45468. type: number,
  45469. /**
  45470. * Defines the related dom event
  45471. */
  45472. event: ClipboardEvent);
  45473. /**
  45474. * Get the clipboard event's type from the keycode.
  45475. * @param keyCode Defines the keyCode for the current keyboard event.
  45476. * @return {number}
  45477. */
  45478. static GetTypeFromCharacter(keyCode: number): number;
  45479. }
  45480. }
  45481. declare module "babylonjs/Events/index" {
  45482. export * from "babylonjs/Events/keyboardEvents";
  45483. export * from "babylonjs/Events/pointerEvents";
  45484. export * from "babylonjs/Events/clipboardEvents";
  45485. }
  45486. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  45487. import { Scene } from "babylonjs/scene";
  45488. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45489. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  45490. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  45491. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  45492. /**
  45493. * Google Daydream controller
  45494. */
  45495. export class DaydreamController extends WebVRController {
  45496. /**
  45497. * Base Url for the controller model.
  45498. */
  45499. static MODEL_BASE_URL: string;
  45500. /**
  45501. * File name for the controller model.
  45502. */
  45503. static MODEL_FILENAME: string;
  45504. /**
  45505. * Gamepad Id prefix used to identify Daydream Controller.
  45506. */
  45507. static readonly GAMEPAD_ID_PREFIX: string;
  45508. /**
  45509. * Creates a new DaydreamController from a gamepad
  45510. * @param vrGamepad the gamepad that the controller should be created from
  45511. */
  45512. constructor(vrGamepad: any);
  45513. /**
  45514. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  45515. * @param scene scene in which to add meshes
  45516. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  45517. */
  45518. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  45519. /**
  45520. * Called once for each button that changed state since the last frame
  45521. * @param buttonIdx Which button index changed
  45522. * @param state New state of the button
  45523. * @param changes Which properties on the state changed since last frame
  45524. */
  45525. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  45526. }
  45527. }
  45528. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  45529. import { Scene } from "babylonjs/scene";
  45530. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45531. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  45532. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  45533. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  45534. /**
  45535. * Gear VR Controller
  45536. */
  45537. export class GearVRController extends WebVRController {
  45538. /**
  45539. * Base Url for the controller model.
  45540. */
  45541. static MODEL_BASE_URL: string;
  45542. /**
  45543. * File name for the controller model.
  45544. */
  45545. static MODEL_FILENAME: string;
  45546. /**
  45547. * Gamepad Id prefix used to identify this controller.
  45548. */
  45549. static readonly GAMEPAD_ID_PREFIX: string;
  45550. private readonly _buttonIndexToObservableNameMap;
  45551. /**
  45552. * Creates a new GearVRController from a gamepad
  45553. * @param vrGamepad the gamepad that the controller should be created from
  45554. */
  45555. constructor(vrGamepad: any);
  45556. /**
  45557. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  45558. * @param scene scene in which to add meshes
  45559. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  45560. */
  45561. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  45562. /**
  45563. * Called once for each button that changed state since the last frame
  45564. * @param buttonIdx Which button index changed
  45565. * @param state New state of the button
  45566. * @param changes Which properties on the state changed since last frame
  45567. */
  45568. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  45569. }
  45570. }
  45571. declare module "babylonjs/Gamepads/Controllers/index" {
  45572. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  45573. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  45574. export * from "babylonjs/Gamepads/Controllers/genericController";
  45575. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  45576. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  45577. export * from "babylonjs/Gamepads/Controllers/viveController";
  45578. export * from "babylonjs/Gamepads/Controllers/webVRController";
  45579. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  45580. }
  45581. declare module "babylonjs/Gamepads/index" {
  45582. export * from "babylonjs/Gamepads/Controllers/index";
  45583. export * from "babylonjs/Gamepads/gamepad";
  45584. export * from "babylonjs/Gamepads/gamepadManager";
  45585. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  45586. export * from "babylonjs/Gamepads/xboxGamepad";
  45587. export * from "babylonjs/Gamepads/dualShockGamepad";
  45588. }
  45589. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  45590. import { Scene } from "babylonjs/scene";
  45591. import { Vector4 } from "babylonjs/Maths/math.vector";
  45592. import { Color4 } from "babylonjs/Maths/math.color";
  45593. import { Mesh } from "babylonjs/Meshes/mesh";
  45594. import { Nullable } from "babylonjs/types";
  45595. /**
  45596. * Class containing static functions to help procedurally build meshes
  45597. */
  45598. export class PolyhedronBuilder {
  45599. /**
  45600. * Creates a polyhedron mesh
  45601. * * 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
  45602. * * The parameter `size` (positive float, default 1) sets the polygon size
  45603. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  45604. * * 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`
  45605. * * 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
  45606. * * 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)`)
  45607. * * 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
  45608. * * 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
  45609. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45610. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45611. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45612. * @param name defines the name of the mesh
  45613. * @param options defines the options used to create the mesh
  45614. * @param scene defines the hosting scene
  45615. * @returns the polyhedron mesh
  45616. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  45617. */
  45618. static CreatePolyhedron(name: string, options: {
  45619. type?: number;
  45620. size?: number;
  45621. sizeX?: number;
  45622. sizeY?: number;
  45623. sizeZ?: number;
  45624. custom?: any;
  45625. faceUV?: Vector4[];
  45626. faceColors?: Color4[];
  45627. flat?: boolean;
  45628. updatable?: boolean;
  45629. sideOrientation?: number;
  45630. frontUVs?: Vector4;
  45631. backUVs?: Vector4;
  45632. }, scene?: Nullable<Scene>): Mesh;
  45633. }
  45634. }
  45635. declare module "babylonjs/Gizmos/scaleGizmo" {
  45636. import { Observable } from "babylonjs/Misc/observable";
  45637. import { Nullable } from "babylonjs/types";
  45638. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45639. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45640. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  45641. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45642. /**
  45643. * Gizmo that enables scaling a mesh along 3 axis
  45644. */
  45645. export class ScaleGizmo extends Gizmo {
  45646. /**
  45647. * Internal gizmo used for interactions on the x axis
  45648. */
  45649. xGizmo: AxisScaleGizmo;
  45650. /**
  45651. * Internal gizmo used for interactions on the y axis
  45652. */
  45653. yGizmo: AxisScaleGizmo;
  45654. /**
  45655. * Internal gizmo used for interactions on the z axis
  45656. */
  45657. zGizmo: AxisScaleGizmo;
  45658. /**
  45659. * Internal gizmo used to scale all axis equally
  45660. */
  45661. uniformScaleGizmo: AxisScaleGizmo;
  45662. private _meshAttached;
  45663. private _updateGizmoRotationToMatchAttachedMesh;
  45664. private _snapDistance;
  45665. private _scaleRatio;
  45666. private _uniformScalingMesh;
  45667. private _octahedron;
  45668. /** Fires an event when any of it's sub gizmos are dragged */
  45669. onDragStartObservable: Observable<unknown>;
  45670. /** Fires an event when any of it's sub gizmos are released from dragging */
  45671. onDragEndObservable: Observable<unknown>;
  45672. attachedMesh: Nullable<AbstractMesh>;
  45673. /**
  45674. * Creates a ScaleGizmo
  45675. * @param gizmoLayer The utility layer the gizmo will be added to
  45676. */
  45677. constructor(gizmoLayer?: UtilityLayerRenderer);
  45678. updateGizmoRotationToMatchAttachedMesh: boolean;
  45679. /**
  45680. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45681. */
  45682. snapDistance: number;
  45683. /**
  45684. * Ratio for the scale of the gizmo (Default: 1)
  45685. */
  45686. scaleRatio: number;
  45687. /**
  45688. * Disposes of the gizmo
  45689. */
  45690. dispose(): void;
  45691. }
  45692. }
  45693. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  45694. import { Observable } from "babylonjs/Misc/observable";
  45695. import { Nullable } from "babylonjs/types";
  45696. import { Vector3 } from "babylonjs/Maths/math.vector";
  45697. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45698. import { Mesh } from "babylonjs/Meshes/mesh";
  45699. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45700. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45701. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45702. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  45703. import { Color3 } from "babylonjs/Maths/math.color";
  45704. /**
  45705. * Single axis scale gizmo
  45706. */
  45707. export class AxisScaleGizmo extends Gizmo {
  45708. /**
  45709. * Drag behavior responsible for the gizmos dragging interactions
  45710. */
  45711. dragBehavior: PointerDragBehavior;
  45712. private _pointerObserver;
  45713. /**
  45714. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45715. */
  45716. snapDistance: number;
  45717. /**
  45718. * Event that fires each time the gizmo snaps to a new location.
  45719. * * snapDistance is the the change in distance
  45720. */
  45721. onSnapObservable: Observable<{
  45722. snapDistance: number;
  45723. }>;
  45724. /**
  45725. * If the scaling operation should be done on all axis (default: false)
  45726. */
  45727. uniformScaling: boolean;
  45728. private _isEnabled;
  45729. private _parent;
  45730. private _arrow;
  45731. private _coloredMaterial;
  45732. private _hoverMaterial;
  45733. /**
  45734. * Creates an AxisScaleGizmo
  45735. * @param gizmoLayer The utility layer the gizmo will be added to
  45736. * @param dragAxis The axis which the gizmo will be able to scale on
  45737. * @param color The color of the gizmo
  45738. */
  45739. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  45740. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45741. /**
  45742. * If the gizmo is enabled
  45743. */
  45744. isEnabled: boolean;
  45745. /**
  45746. * Disposes of the gizmo
  45747. */
  45748. dispose(): void;
  45749. /**
  45750. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  45751. * @param mesh The mesh to replace the default mesh of the gizmo
  45752. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  45753. */
  45754. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  45755. }
  45756. }
  45757. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  45758. import { Observable } from "babylonjs/Misc/observable";
  45759. import { Nullable } from "babylonjs/types";
  45760. import { Vector3 } from "babylonjs/Maths/math.vector";
  45761. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45762. import { Mesh } from "babylonjs/Meshes/mesh";
  45763. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45764. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45765. import { Color3 } from "babylonjs/Maths/math.color";
  45766. import "babylonjs/Meshes/Builders/boxBuilder";
  45767. /**
  45768. * Bounding box gizmo
  45769. */
  45770. export class BoundingBoxGizmo extends Gizmo {
  45771. private _lineBoundingBox;
  45772. private _rotateSpheresParent;
  45773. private _scaleBoxesParent;
  45774. private _boundingDimensions;
  45775. private _renderObserver;
  45776. private _pointerObserver;
  45777. private _scaleDragSpeed;
  45778. private _tmpQuaternion;
  45779. private _tmpVector;
  45780. private _tmpRotationMatrix;
  45781. /**
  45782. * 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)
  45783. */
  45784. ignoreChildren: boolean;
  45785. /**
  45786. * 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)
  45787. */
  45788. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  45789. /**
  45790. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  45791. */
  45792. rotationSphereSize: number;
  45793. /**
  45794. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  45795. */
  45796. scaleBoxSize: number;
  45797. /**
  45798. * 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)
  45799. */
  45800. fixedDragMeshScreenSize: boolean;
  45801. /**
  45802. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  45803. */
  45804. fixedDragMeshScreenSizeDistanceFactor: number;
  45805. /**
  45806. * Fired when a rotation sphere or scale box is dragged
  45807. */
  45808. onDragStartObservable: Observable<{}>;
  45809. /**
  45810. * Fired when a scale box is dragged
  45811. */
  45812. onScaleBoxDragObservable: Observable<{}>;
  45813. /**
  45814. * Fired when a scale box drag is ended
  45815. */
  45816. onScaleBoxDragEndObservable: Observable<{}>;
  45817. /**
  45818. * Fired when a rotation sphere is dragged
  45819. */
  45820. onRotationSphereDragObservable: Observable<{}>;
  45821. /**
  45822. * Fired when a rotation sphere drag is ended
  45823. */
  45824. onRotationSphereDragEndObservable: Observable<{}>;
  45825. /**
  45826. * 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)
  45827. */
  45828. scalePivot: Nullable<Vector3>;
  45829. /**
  45830. * Mesh used as a pivot to rotate the attached mesh
  45831. */
  45832. private _anchorMesh;
  45833. private _existingMeshScale;
  45834. private _dragMesh;
  45835. private pointerDragBehavior;
  45836. private coloredMaterial;
  45837. private hoverColoredMaterial;
  45838. /**
  45839. * Sets the color of the bounding box gizmo
  45840. * @param color the color to set
  45841. */
  45842. setColor(color: Color3): void;
  45843. /**
  45844. * Creates an BoundingBoxGizmo
  45845. * @param gizmoLayer The utility layer the gizmo will be added to
  45846. * @param color The color of the gizmo
  45847. */
  45848. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  45849. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45850. private _selectNode;
  45851. /**
  45852. * Updates the bounding box information for the Gizmo
  45853. */
  45854. updateBoundingBox(): void;
  45855. private _updateRotationSpheres;
  45856. private _updateScaleBoxes;
  45857. /**
  45858. * Enables rotation on the specified axis and disables rotation on the others
  45859. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  45860. */
  45861. setEnabledRotationAxis(axis: string): void;
  45862. /**
  45863. * Enables/disables scaling
  45864. * @param enable if scaling should be enabled
  45865. */
  45866. setEnabledScaling(enable: boolean): void;
  45867. private _updateDummy;
  45868. /**
  45869. * Enables a pointer drag behavior on the bounding box of the gizmo
  45870. */
  45871. enableDragBehavior(): void;
  45872. /**
  45873. * Disposes of the gizmo
  45874. */
  45875. dispose(): void;
  45876. /**
  45877. * 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)
  45878. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  45879. * @returns the bounding box mesh with the passed in mesh as a child
  45880. */
  45881. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  45882. /**
  45883. * CustomMeshes are not supported by this gizmo
  45884. * @param mesh The mesh to replace the default mesh of the gizmo
  45885. */
  45886. setCustomMesh(mesh: Mesh): void;
  45887. }
  45888. }
  45889. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  45890. import { Observable } from "babylonjs/Misc/observable";
  45891. import { Nullable } from "babylonjs/types";
  45892. import { Vector3 } from "babylonjs/Maths/math.vector";
  45893. import { Color3 } from "babylonjs/Maths/math.color";
  45894. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45895. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45896. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45897. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45898. import "babylonjs/Meshes/Builders/linesBuilder";
  45899. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  45900. /**
  45901. * Single plane rotation gizmo
  45902. */
  45903. export class PlaneRotationGizmo extends Gizmo {
  45904. /**
  45905. * Drag behavior responsible for the gizmos dragging interactions
  45906. */
  45907. dragBehavior: PointerDragBehavior;
  45908. private _pointerObserver;
  45909. /**
  45910. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  45911. */
  45912. snapDistance: number;
  45913. /**
  45914. * Event that fires each time the gizmo snaps to a new location.
  45915. * * snapDistance is the the change in distance
  45916. */
  45917. onSnapObservable: Observable<{
  45918. snapDistance: number;
  45919. }>;
  45920. private _isEnabled;
  45921. private _parent;
  45922. /**
  45923. * Creates a PlaneRotationGizmo
  45924. * @param gizmoLayer The utility layer the gizmo will be added to
  45925. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  45926. * @param color The color of the gizmo
  45927. * @param tessellation Amount of tessellation to be used when creating rotation circles
  45928. * @param useEulerRotation Use and update Euler angle instead of quaternion
  45929. */
  45930. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  45931. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45932. /**
  45933. * If the gizmo is enabled
  45934. */
  45935. isEnabled: boolean;
  45936. /**
  45937. * Disposes of the gizmo
  45938. */
  45939. dispose(): void;
  45940. }
  45941. }
  45942. declare module "babylonjs/Gizmos/rotationGizmo" {
  45943. import { Observable } from "babylonjs/Misc/observable";
  45944. import { Nullable } from "babylonjs/types";
  45945. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45946. import { Mesh } from "babylonjs/Meshes/mesh";
  45947. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45948. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  45949. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45950. /**
  45951. * Gizmo that enables rotating a mesh along 3 axis
  45952. */
  45953. export class RotationGizmo extends Gizmo {
  45954. /**
  45955. * Internal gizmo used for interactions on the x axis
  45956. */
  45957. xGizmo: PlaneRotationGizmo;
  45958. /**
  45959. * Internal gizmo used for interactions on the y axis
  45960. */
  45961. yGizmo: PlaneRotationGizmo;
  45962. /**
  45963. * Internal gizmo used for interactions on the z axis
  45964. */
  45965. zGizmo: PlaneRotationGizmo;
  45966. /** Fires an event when any of it's sub gizmos are dragged */
  45967. onDragStartObservable: Observable<unknown>;
  45968. /** Fires an event when any of it's sub gizmos are released from dragging */
  45969. onDragEndObservable: Observable<unknown>;
  45970. private _meshAttached;
  45971. attachedMesh: Nullable<AbstractMesh>;
  45972. /**
  45973. * Creates a RotationGizmo
  45974. * @param gizmoLayer The utility layer the gizmo will be added to
  45975. * @param tessellation Amount of tessellation to be used when creating rotation circles
  45976. * @param useEulerRotation Use and update Euler angle instead of quaternion
  45977. */
  45978. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  45979. updateGizmoRotationToMatchAttachedMesh: boolean;
  45980. /**
  45981. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45982. */
  45983. snapDistance: number;
  45984. /**
  45985. * Ratio for the scale of the gizmo (Default: 1)
  45986. */
  45987. scaleRatio: number;
  45988. /**
  45989. * Disposes of the gizmo
  45990. */
  45991. dispose(): void;
  45992. /**
  45993. * CustomMeshes are not supported by this gizmo
  45994. * @param mesh The mesh to replace the default mesh of the gizmo
  45995. */
  45996. setCustomMesh(mesh: Mesh): void;
  45997. }
  45998. }
  45999. declare module "babylonjs/Gizmos/gizmoManager" {
  46000. import { Observable } from "babylonjs/Misc/observable";
  46001. import { Nullable } from "babylonjs/types";
  46002. import { Scene, IDisposable } from "babylonjs/scene";
  46003. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46004. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46005. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  46006. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  46007. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  46008. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  46009. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  46010. /**
  46011. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  46012. */
  46013. export class GizmoManager implements IDisposable {
  46014. private scene;
  46015. /**
  46016. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  46017. */
  46018. gizmos: {
  46019. positionGizmo: Nullable<PositionGizmo>;
  46020. rotationGizmo: Nullable<RotationGizmo>;
  46021. scaleGizmo: Nullable<ScaleGizmo>;
  46022. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  46023. };
  46024. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  46025. clearGizmoOnEmptyPointerEvent: boolean;
  46026. /** Fires an event when the manager is attached to a mesh */
  46027. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  46028. private _gizmosEnabled;
  46029. private _pointerObserver;
  46030. private _attachedMesh;
  46031. private _boundingBoxColor;
  46032. private _defaultUtilityLayer;
  46033. private _defaultKeepDepthUtilityLayer;
  46034. /**
  46035. * When bounding box gizmo is enabled, this can be used to track drag/end events
  46036. */
  46037. boundingBoxDragBehavior: SixDofDragBehavior;
  46038. /**
  46039. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  46040. */
  46041. attachableMeshes: Nullable<Array<AbstractMesh>>;
  46042. /**
  46043. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  46044. */
  46045. usePointerToAttachGizmos: boolean;
  46046. /**
  46047. * Utility layer that the bounding box gizmo belongs to
  46048. */
  46049. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  46050. /**
  46051. * Utility layer that all gizmos besides bounding box belong to
  46052. */
  46053. readonly utilityLayer: UtilityLayerRenderer;
  46054. /**
  46055. * Instatiates a gizmo manager
  46056. * @param scene the scene to overlay the gizmos on top of
  46057. */
  46058. constructor(scene: Scene);
  46059. /**
  46060. * Attaches a set of gizmos to the specified mesh
  46061. * @param mesh The mesh the gizmo's should be attached to
  46062. */
  46063. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  46064. /**
  46065. * If the position gizmo is enabled
  46066. */
  46067. positionGizmoEnabled: boolean;
  46068. /**
  46069. * If the rotation gizmo is enabled
  46070. */
  46071. rotationGizmoEnabled: boolean;
  46072. /**
  46073. * If the scale gizmo is enabled
  46074. */
  46075. scaleGizmoEnabled: boolean;
  46076. /**
  46077. * If the boundingBox gizmo is enabled
  46078. */
  46079. boundingBoxGizmoEnabled: boolean;
  46080. /**
  46081. * Disposes of the gizmo manager
  46082. */
  46083. dispose(): void;
  46084. }
  46085. }
  46086. declare module "babylonjs/Lights/directionalLight" {
  46087. import { Camera } from "babylonjs/Cameras/camera";
  46088. import { Scene } from "babylonjs/scene";
  46089. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  46090. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46091. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  46092. import { Effect } from "babylonjs/Materials/effect";
  46093. /**
  46094. * A directional light is defined by a direction (what a surprise!).
  46095. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  46096. * 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.
  46097. * Documentation: https://doc.babylonjs.com/babylon101/lights
  46098. */
  46099. export class DirectionalLight extends ShadowLight {
  46100. private _shadowFrustumSize;
  46101. /**
  46102. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  46103. */
  46104. /**
  46105. * Specifies a fix frustum size for the shadow generation.
  46106. */
  46107. shadowFrustumSize: number;
  46108. private _shadowOrthoScale;
  46109. /**
  46110. * Gets the shadow projection scale against the optimal computed one.
  46111. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  46112. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  46113. */
  46114. /**
  46115. * Sets the shadow projection scale against the optimal computed one.
  46116. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  46117. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  46118. */
  46119. shadowOrthoScale: number;
  46120. /**
  46121. * Automatically compute the projection matrix to best fit (including all the casters)
  46122. * on each frame.
  46123. */
  46124. autoUpdateExtends: boolean;
  46125. private _orthoLeft;
  46126. private _orthoRight;
  46127. private _orthoTop;
  46128. private _orthoBottom;
  46129. /**
  46130. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  46131. * The directional light is emitted from everywhere in the given direction.
  46132. * It can cast shadows.
  46133. * Documentation : https://doc.babylonjs.com/babylon101/lights
  46134. * @param name The friendly name of the light
  46135. * @param direction The direction of the light
  46136. * @param scene The scene the light belongs to
  46137. */
  46138. constructor(name: string, direction: Vector3, scene: Scene);
  46139. /**
  46140. * Returns the string "DirectionalLight".
  46141. * @return The class name
  46142. */
  46143. getClassName(): string;
  46144. /**
  46145. * Returns the integer 1.
  46146. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  46147. */
  46148. getTypeID(): number;
  46149. /**
  46150. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  46151. * Returns the DirectionalLight Shadow projection matrix.
  46152. */
  46153. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  46154. /**
  46155. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  46156. * Returns the DirectionalLight Shadow projection matrix.
  46157. */
  46158. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  46159. /**
  46160. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  46161. * Returns the DirectionalLight Shadow projection matrix.
  46162. */
  46163. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  46164. protected _buildUniformLayout(): void;
  46165. /**
  46166. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  46167. * @param effect The effect to update
  46168. * @param lightIndex The index of the light in the effect to update
  46169. * @returns The directional light
  46170. */
  46171. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  46172. /**
  46173. * Gets the minZ used for shadow according to both the scene and the light.
  46174. *
  46175. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  46176. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  46177. * @param activeCamera The camera we are returning the min for
  46178. * @returns the depth min z
  46179. */
  46180. getDepthMinZ(activeCamera: Camera): number;
  46181. /**
  46182. * Gets the maxZ used for shadow according to both the scene and the light.
  46183. *
  46184. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  46185. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  46186. * @param activeCamera The camera we are returning the max for
  46187. * @returns the depth max z
  46188. */
  46189. getDepthMaxZ(activeCamera: Camera): number;
  46190. /**
  46191. * Prepares the list of defines specific to the light type.
  46192. * @param defines the list of defines
  46193. * @param lightIndex defines the index of the light for the effect
  46194. */
  46195. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  46196. }
  46197. }
  46198. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  46199. import { Mesh } from "babylonjs/Meshes/mesh";
  46200. /**
  46201. * Class containing static functions to help procedurally build meshes
  46202. */
  46203. export class HemisphereBuilder {
  46204. /**
  46205. * Creates a hemisphere mesh
  46206. * @param name defines the name of the mesh
  46207. * @param options defines the options used to create the mesh
  46208. * @param scene defines the hosting scene
  46209. * @returns the hemisphere mesh
  46210. */
  46211. static CreateHemisphere(name: string, options: {
  46212. segments?: number;
  46213. diameter?: number;
  46214. sideOrientation?: number;
  46215. }, scene: any): Mesh;
  46216. }
  46217. }
  46218. declare module "babylonjs/Lights/spotLight" {
  46219. import { Nullable } from "babylonjs/types";
  46220. import { Scene } from "babylonjs/scene";
  46221. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  46222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46223. import { Effect } from "babylonjs/Materials/effect";
  46224. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46225. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  46226. /**
  46227. * A spot light is defined by a position, a direction, an angle, and an exponent.
  46228. * These values define a cone of light starting from the position, emitting toward the direction.
  46229. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  46230. * and the exponent defines the speed of the decay of the light with distance (reach).
  46231. * Documentation: https://doc.babylonjs.com/babylon101/lights
  46232. */
  46233. export class SpotLight extends ShadowLight {
  46234. private _angle;
  46235. private _innerAngle;
  46236. private _cosHalfAngle;
  46237. private _lightAngleScale;
  46238. private _lightAngleOffset;
  46239. /**
  46240. * Gets the cone angle of the spot light in Radians.
  46241. */
  46242. /**
  46243. * Sets the cone angle of the spot light in Radians.
  46244. */
  46245. angle: number;
  46246. /**
  46247. * Only used in gltf falloff mode, this defines the angle where
  46248. * the directional falloff will start before cutting at angle which could be seen
  46249. * as outer angle.
  46250. */
  46251. /**
  46252. * Only used in gltf falloff mode, this defines the angle where
  46253. * the directional falloff will start before cutting at angle which could be seen
  46254. * as outer angle.
  46255. */
  46256. innerAngle: number;
  46257. private _shadowAngleScale;
  46258. /**
  46259. * Allows scaling the angle of the light for shadow generation only.
  46260. */
  46261. /**
  46262. * Allows scaling the angle of the light for shadow generation only.
  46263. */
  46264. shadowAngleScale: number;
  46265. /**
  46266. * The light decay speed with the distance from the emission spot.
  46267. */
  46268. exponent: number;
  46269. private _projectionTextureMatrix;
  46270. /**
  46271. * Allows reading the projecton texture
  46272. */
  46273. readonly projectionTextureMatrix: Matrix;
  46274. protected _projectionTextureLightNear: number;
  46275. /**
  46276. * Gets the near clip of the Spotlight for texture projection.
  46277. */
  46278. /**
  46279. * Sets the near clip of the Spotlight for texture projection.
  46280. */
  46281. projectionTextureLightNear: number;
  46282. protected _projectionTextureLightFar: number;
  46283. /**
  46284. * Gets the far clip of the Spotlight for texture projection.
  46285. */
  46286. /**
  46287. * Sets the far clip of the Spotlight for texture projection.
  46288. */
  46289. projectionTextureLightFar: number;
  46290. protected _projectionTextureUpDirection: Vector3;
  46291. /**
  46292. * Gets the Up vector of the Spotlight for texture projection.
  46293. */
  46294. /**
  46295. * Sets the Up vector of the Spotlight for texture projection.
  46296. */
  46297. projectionTextureUpDirection: Vector3;
  46298. private _projectionTexture;
  46299. /**
  46300. * Gets the projection texture of the light.
  46301. */
  46302. /**
  46303. * Sets the projection texture of the light.
  46304. */
  46305. projectionTexture: Nullable<BaseTexture>;
  46306. private _projectionTextureViewLightDirty;
  46307. private _projectionTextureProjectionLightDirty;
  46308. private _projectionTextureDirty;
  46309. private _projectionTextureViewTargetVector;
  46310. private _projectionTextureViewLightMatrix;
  46311. private _projectionTextureProjectionLightMatrix;
  46312. private _projectionTextureScalingMatrix;
  46313. /**
  46314. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  46315. * It can cast shadows.
  46316. * Documentation : https://doc.babylonjs.com/babylon101/lights
  46317. * @param name The light friendly name
  46318. * @param position The position of the spot light in the scene
  46319. * @param direction The direction of the light in the scene
  46320. * @param angle The cone angle of the light in Radians
  46321. * @param exponent The light decay speed with the distance from the emission spot
  46322. * @param scene The scene the lights belongs to
  46323. */
  46324. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  46325. /**
  46326. * Returns the string "SpotLight".
  46327. * @returns the class name
  46328. */
  46329. getClassName(): string;
  46330. /**
  46331. * Returns the integer 2.
  46332. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  46333. */
  46334. getTypeID(): number;
  46335. /**
  46336. * Overrides the direction setter to recompute the projection texture view light Matrix.
  46337. */
  46338. protected _setDirection(value: Vector3): void;
  46339. /**
  46340. * Overrides the position setter to recompute the projection texture view light Matrix.
  46341. */
  46342. protected _setPosition(value: Vector3): void;
  46343. /**
  46344. * 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.
  46345. * Returns the SpotLight.
  46346. */
  46347. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  46348. protected _computeProjectionTextureViewLightMatrix(): void;
  46349. protected _computeProjectionTextureProjectionLightMatrix(): void;
  46350. /**
  46351. * Main function for light texture projection matrix computing.
  46352. */
  46353. protected _computeProjectionTextureMatrix(): void;
  46354. protected _buildUniformLayout(): void;
  46355. private _computeAngleValues;
  46356. /**
  46357. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  46358. * @param effect The effect to update
  46359. * @param lightIndex The index of the light in the effect to update
  46360. * @returns The spot light
  46361. */
  46362. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  46363. /**
  46364. * Disposes the light and the associated resources.
  46365. */
  46366. dispose(): void;
  46367. /**
  46368. * Prepares the list of defines specific to the light type.
  46369. * @param defines the list of defines
  46370. * @param lightIndex defines the index of the light for the effect
  46371. */
  46372. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  46373. }
  46374. }
  46375. declare module "babylonjs/Gizmos/lightGizmo" {
  46376. import { Nullable } from "babylonjs/types";
  46377. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  46378. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  46379. import { Light } from "babylonjs/Lights/light";
  46380. /**
  46381. * Gizmo that enables viewing a light
  46382. */
  46383. export class LightGizmo extends Gizmo {
  46384. private _lightMesh;
  46385. private _material;
  46386. private cachedPosition;
  46387. private cachedForward;
  46388. /**
  46389. * Creates a LightGizmo
  46390. * @param gizmoLayer The utility layer the gizmo will be added to
  46391. */
  46392. constructor(gizmoLayer?: UtilityLayerRenderer);
  46393. private _light;
  46394. /**
  46395. * The light that the gizmo is attached to
  46396. */
  46397. light: Nullable<Light>;
  46398. /**
  46399. * @hidden
  46400. * Updates the gizmo to match the attached mesh's position/rotation
  46401. */
  46402. protected _update(): void;
  46403. private static _Scale;
  46404. /**
  46405. * Creates the lines for a light mesh
  46406. */
  46407. private static _createLightLines;
  46408. /**
  46409. * Disposes of the light gizmo
  46410. */
  46411. dispose(): void;
  46412. private static _CreateHemisphericLightMesh;
  46413. private static _CreatePointLightMesh;
  46414. private static _CreateSpotLightMesh;
  46415. private static _CreateDirectionalLightMesh;
  46416. }
  46417. }
  46418. declare module "babylonjs/Gizmos/index" {
  46419. export * from "babylonjs/Gizmos/axisDragGizmo";
  46420. export * from "babylonjs/Gizmos/axisScaleGizmo";
  46421. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  46422. export * from "babylonjs/Gizmos/gizmo";
  46423. export * from "babylonjs/Gizmos/gizmoManager";
  46424. export * from "babylonjs/Gizmos/planeRotationGizmo";
  46425. export * from "babylonjs/Gizmos/positionGizmo";
  46426. export * from "babylonjs/Gizmos/rotationGizmo";
  46427. export * from "babylonjs/Gizmos/scaleGizmo";
  46428. export * from "babylonjs/Gizmos/lightGizmo";
  46429. export * from "babylonjs/Gizmos/planeDragGizmo";
  46430. }
  46431. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  46432. /** @hidden */
  46433. export var backgroundFragmentDeclaration: {
  46434. name: string;
  46435. shader: string;
  46436. };
  46437. }
  46438. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  46439. /** @hidden */
  46440. export var backgroundUboDeclaration: {
  46441. name: string;
  46442. shader: string;
  46443. };
  46444. }
  46445. declare module "babylonjs/Shaders/background.fragment" {
  46446. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  46447. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  46448. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  46449. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  46450. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  46451. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  46452. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46453. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  46454. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  46455. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  46456. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  46457. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  46458. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  46459. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  46460. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  46461. /** @hidden */
  46462. export var backgroundPixelShader: {
  46463. name: string;
  46464. shader: string;
  46465. };
  46466. }
  46467. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  46468. /** @hidden */
  46469. export var backgroundVertexDeclaration: {
  46470. name: string;
  46471. shader: string;
  46472. };
  46473. }
  46474. declare module "babylonjs/Shaders/background.vertex" {
  46475. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  46476. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  46477. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46478. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  46479. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  46480. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  46481. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  46482. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  46483. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  46484. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  46485. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  46486. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  46487. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  46488. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  46489. /** @hidden */
  46490. export var backgroundVertexShader: {
  46491. name: string;
  46492. shader: string;
  46493. };
  46494. }
  46495. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  46496. import { Nullable, int, float } from "babylonjs/types";
  46497. import { Scene } from "babylonjs/scene";
  46498. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  46499. import { SubMesh } from "babylonjs/Meshes/subMesh";
  46500. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46501. import { Mesh } from "babylonjs/Meshes/mesh";
  46502. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  46503. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  46504. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  46505. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46506. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  46507. import { Color3 } from "babylonjs/Maths/math.color";
  46508. import "babylonjs/Shaders/background.fragment";
  46509. import "babylonjs/Shaders/background.vertex";
  46510. /**
  46511. * Background material used to create an efficient environement around your scene.
  46512. */
  46513. export class BackgroundMaterial extends PushMaterial {
  46514. /**
  46515. * Standard reflectance value at parallel view angle.
  46516. */
  46517. static StandardReflectance0: number;
  46518. /**
  46519. * Standard reflectance value at grazing angle.
  46520. */
  46521. static StandardReflectance90: number;
  46522. protected _primaryColor: Color3;
  46523. /**
  46524. * Key light Color (multiply against the environement texture)
  46525. */
  46526. primaryColor: Color3;
  46527. protected __perceptualColor: Nullable<Color3>;
  46528. /**
  46529. * Experimental Internal Use Only.
  46530. *
  46531. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  46532. * This acts as a helper to set the primary color to a more "human friendly" value.
  46533. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  46534. * output color as close as possible from the chosen value.
  46535. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  46536. * part of lighting setup.)
  46537. */
  46538. _perceptualColor: Nullable<Color3>;
  46539. protected _primaryColorShadowLevel: float;
  46540. /**
  46541. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  46542. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  46543. */
  46544. primaryColorShadowLevel: float;
  46545. protected _primaryColorHighlightLevel: float;
  46546. /**
  46547. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  46548. * The primary color is used at the level chosen to define what the white area would look.
  46549. */
  46550. primaryColorHighlightLevel: float;
  46551. protected _reflectionTexture: Nullable<BaseTexture>;
  46552. /**
  46553. * Reflection Texture used in the material.
  46554. * Should be author in a specific way for the best result (refer to the documentation).
  46555. */
  46556. reflectionTexture: Nullable<BaseTexture>;
  46557. protected _reflectionBlur: float;
  46558. /**
  46559. * Reflection Texture level of blur.
  46560. *
  46561. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  46562. * texture twice.
  46563. */
  46564. reflectionBlur: float;
  46565. protected _diffuseTexture: Nullable<BaseTexture>;
  46566. /**
  46567. * Diffuse Texture used in the material.
  46568. * Should be author in a specific way for the best result (refer to the documentation).
  46569. */
  46570. diffuseTexture: Nullable<BaseTexture>;
  46571. protected _shadowLights: Nullable<IShadowLight[]>;
  46572. /**
  46573. * Specify the list of lights casting shadow on the material.
  46574. * All scene shadow lights will be included if null.
  46575. */
  46576. shadowLights: Nullable<IShadowLight[]>;
  46577. protected _shadowLevel: float;
  46578. /**
  46579. * Helps adjusting the shadow to a softer level if required.
  46580. * 0 means black shadows and 1 means no shadows.
  46581. */
  46582. shadowLevel: float;
  46583. protected _sceneCenter: Vector3;
  46584. /**
  46585. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  46586. * It is usually zero but might be interesting to modify according to your setup.
  46587. */
  46588. sceneCenter: Vector3;
  46589. protected _opacityFresnel: boolean;
  46590. /**
  46591. * This helps specifying that the material is falling off to the sky box at grazing angle.
  46592. * This helps ensuring a nice transition when the camera goes under the ground.
  46593. */
  46594. opacityFresnel: boolean;
  46595. protected _reflectionFresnel: boolean;
  46596. /**
  46597. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  46598. * This helps adding a mirror texture on the ground.
  46599. */
  46600. reflectionFresnel: boolean;
  46601. protected _reflectionFalloffDistance: number;
  46602. /**
  46603. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  46604. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  46605. */
  46606. reflectionFalloffDistance: number;
  46607. protected _reflectionAmount: number;
  46608. /**
  46609. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  46610. */
  46611. reflectionAmount: number;
  46612. protected _reflectionReflectance0: number;
  46613. /**
  46614. * This specifies the weight of the reflection at grazing angle.
  46615. */
  46616. reflectionReflectance0: number;
  46617. protected _reflectionReflectance90: number;
  46618. /**
  46619. * This specifies the weight of the reflection at a perpendicular point of view.
  46620. */
  46621. reflectionReflectance90: number;
  46622. /**
  46623. * Sets the reflection reflectance fresnel values according to the default standard
  46624. * empirically know to work well :-)
  46625. */
  46626. reflectionStandardFresnelWeight: number;
  46627. protected _useRGBColor: boolean;
  46628. /**
  46629. * Helps to directly use the maps channels instead of their level.
  46630. */
  46631. useRGBColor: boolean;
  46632. protected _enableNoise: boolean;
  46633. /**
  46634. * This helps reducing the banding effect that could occur on the background.
  46635. */
  46636. enableNoise: boolean;
  46637. /**
  46638. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  46639. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  46640. * Recommended to be keep at 1.0 except for special cases.
  46641. */
  46642. fovMultiplier: number;
  46643. private _fovMultiplier;
  46644. /**
  46645. * Enable the FOV adjustment feature controlled by fovMultiplier.
  46646. */
  46647. useEquirectangularFOV: boolean;
  46648. private _maxSimultaneousLights;
  46649. /**
  46650. * Number of Simultaneous lights allowed on the material.
  46651. */
  46652. maxSimultaneousLights: int;
  46653. /**
  46654. * Default configuration related to image processing available in the Background Material.
  46655. */
  46656. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  46657. /**
  46658. * Keep track of the image processing observer to allow dispose and replace.
  46659. */
  46660. private _imageProcessingObserver;
  46661. /**
  46662. * Attaches a new image processing configuration to the PBR Material.
  46663. * @param configuration (if null the scene configuration will be use)
  46664. */
  46665. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  46666. /**
  46667. * Gets the image processing configuration used either in this material.
  46668. */
  46669. /**
  46670. * Sets the Default image processing configuration used either in the this material.
  46671. *
  46672. * If sets to null, the scene one is in use.
  46673. */
  46674. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  46675. /**
  46676. * Gets wether the color curves effect is enabled.
  46677. */
  46678. /**
  46679. * Sets wether the color curves effect is enabled.
  46680. */
  46681. cameraColorCurvesEnabled: boolean;
  46682. /**
  46683. * Gets wether the color grading effect is enabled.
  46684. */
  46685. /**
  46686. * Gets wether the color grading effect is enabled.
  46687. */
  46688. cameraColorGradingEnabled: boolean;
  46689. /**
  46690. * Gets wether tonemapping is enabled or not.
  46691. */
  46692. /**
  46693. * Sets wether tonemapping is enabled or not
  46694. */
  46695. cameraToneMappingEnabled: boolean;
  46696. /**
  46697. * The camera exposure used on this material.
  46698. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  46699. * This corresponds to a photographic exposure.
  46700. */
  46701. /**
  46702. * The camera exposure used on this material.
  46703. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  46704. * This corresponds to a photographic exposure.
  46705. */
  46706. cameraExposure: float;
  46707. /**
  46708. * Gets The camera contrast used on this material.
  46709. */
  46710. /**
  46711. * Sets The camera contrast used on this material.
  46712. */
  46713. cameraContrast: float;
  46714. /**
  46715. * Gets the Color Grading 2D Lookup Texture.
  46716. */
  46717. /**
  46718. * Sets the Color Grading 2D Lookup Texture.
  46719. */
  46720. cameraColorGradingTexture: Nullable<BaseTexture>;
  46721. /**
  46722. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  46723. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  46724. * 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;
  46725. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  46726. */
  46727. /**
  46728. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  46729. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  46730. * 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;
  46731. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  46732. */
  46733. cameraColorCurves: Nullable<ColorCurves>;
  46734. /**
  46735. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  46736. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  46737. */
  46738. switchToBGR: boolean;
  46739. private _renderTargets;
  46740. private _reflectionControls;
  46741. private _white;
  46742. private _primaryShadowColor;
  46743. private _primaryHighlightColor;
  46744. /**
  46745. * Instantiates a Background Material in the given scene
  46746. * @param name The friendly name of the material
  46747. * @param scene The scene to add the material to
  46748. */
  46749. constructor(name: string, scene: Scene);
  46750. /**
  46751. * Gets a boolean indicating that current material needs to register RTT
  46752. */
  46753. readonly hasRenderTargetTextures: boolean;
  46754. /**
  46755. * The entire material has been created in order to prevent overdraw.
  46756. * @returns false
  46757. */
  46758. needAlphaTesting(): boolean;
  46759. /**
  46760. * The entire material has been created in order to prevent overdraw.
  46761. * @returns true if blending is enable
  46762. */
  46763. needAlphaBlending(): boolean;
  46764. /**
  46765. * Checks wether the material is ready to be rendered for a given mesh.
  46766. * @param mesh The mesh to render
  46767. * @param subMesh The submesh to check against
  46768. * @param useInstances Specify wether or not the material is used with instances
  46769. * @returns true if all the dependencies are ready (Textures, Effects...)
  46770. */
  46771. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  46772. /**
  46773. * Compute the primary color according to the chosen perceptual color.
  46774. */
  46775. private _computePrimaryColorFromPerceptualColor;
  46776. /**
  46777. * Compute the highlights and shadow colors according to their chosen levels.
  46778. */
  46779. private _computePrimaryColors;
  46780. /**
  46781. * Build the uniform buffer used in the material.
  46782. */
  46783. buildUniformLayout(): void;
  46784. /**
  46785. * Unbind the material.
  46786. */
  46787. unbind(): void;
  46788. /**
  46789. * Bind only the world matrix to the material.
  46790. * @param world The world matrix to bind.
  46791. */
  46792. bindOnlyWorldMatrix(world: Matrix): void;
  46793. /**
  46794. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  46795. * @param world The world matrix to bind.
  46796. * @param subMesh The submesh to bind for.
  46797. */
  46798. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  46799. /**
  46800. * Dispose the material.
  46801. * @param forceDisposeEffect Force disposal of the associated effect.
  46802. * @param forceDisposeTextures Force disposal of the associated textures.
  46803. */
  46804. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  46805. /**
  46806. * Clones the material.
  46807. * @param name The cloned name.
  46808. * @returns The cloned material.
  46809. */
  46810. clone(name: string): BackgroundMaterial;
  46811. /**
  46812. * Serializes the current material to its JSON representation.
  46813. * @returns The JSON representation.
  46814. */
  46815. serialize(): any;
  46816. /**
  46817. * Gets the class name of the material
  46818. * @returns "BackgroundMaterial"
  46819. */
  46820. getClassName(): string;
  46821. /**
  46822. * Parse a JSON input to create back a background material.
  46823. * @param source The JSON data to parse
  46824. * @param scene The scene to create the parsed material in
  46825. * @param rootUrl The root url of the assets the material depends upon
  46826. * @returns the instantiated BackgroundMaterial.
  46827. */
  46828. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  46829. }
  46830. }
  46831. declare module "babylonjs/Helpers/environmentHelper" {
  46832. import { Observable } from "babylonjs/Misc/observable";
  46833. import { Nullable } from "babylonjs/types";
  46834. import { Scene } from "babylonjs/scene";
  46835. import { Vector3 } from "babylonjs/Maths/math.vector";
  46836. import { Color3 } from "babylonjs/Maths/math.color";
  46837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46838. import { Mesh } from "babylonjs/Meshes/mesh";
  46839. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46840. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  46841. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  46842. import "babylonjs/Meshes/Builders/planeBuilder";
  46843. import "babylonjs/Meshes/Builders/boxBuilder";
  46844. /**
  46845. * Represents the different options available during the creation of
  46846. * a Environment helper.
  46847. *
  46848. * This can control the default ground, skybox and image processing setup of your scene.
  46849. */
  46850. export interface IEnvironmentHelperOptions {
  46851. /**
  46852. * Specifies wether or not to create a ground.
  46853. * True by default.
  46854. */
  46855. createGround: boolean;
  46856. /**
  46857. * Specifies the ground size.
  46858. * 15 by default.
  46859. */
  46860. groundSize: number;
  46861. /**
  46862. * The texture used on the ground for the main color.
  46863. * Comes from the BabylonJS CDN by default.
  46864. *
  46865. * Remarks: Can be either a texture or a url.
  46866. */
  46867. groundTexture: string | BaseTexture;
  46868. /**
  46869. * The color mixed in the ground texture by default.
  46870. * BabylonJS clearColor by default.
  46871. */
  46872. groundColor: Color3;
  46873. /**
  46874. * Specifies the ground opacity.
  46875. * 1 by default.
  46876. */
  46877. groundOpacity: number;
  46878. /**
  46879. * Enables the ground to receive shadows.
  46880. * True by default.
  46881. */
  46882. enableGroundShadow: boolean;
  46883. /**
  46884. * Helps preventing the shadow to be fully black on the ground.
  46885. * 0.5 by default.
  46886. */
  46887. groundShadowLevel: number;
  46888. /**
  46889. * Creates a mirror texture attach to the ground.
  46890. * false by default.
  46891. */
  46892. enableGroundMirror: boolean;
  46893. /**
  46894. * Specifies the ground mirror size ratio.
  46895. * 0.3 by default as the default kernel is 64.
  46896. */
  46897. groundMirrorSizeRatio: number;
  46898. /**
  46899. * Specifies the ground mirror blur kernel size.
  46900. * 64 by default.
  46901. */
  46902. groundMirrorBlurKernel: number;
  46903. /**
  46904. * Specifies the ground mirror visibility amount.
  46905. * 1 by default
  46906. */
  46907. groundMirrorAmount: number;
  46908. /**
  46909. * Specifies the ground mirror reflectance weight.
  46910. * This uses the standard weight of the background material to setup the fresnel effect
  46911. * of the mirror.
  46912. * 1 by default.
  46913. */
  46914. groundMirrorFresnelWeight: number;
  46915. /**
  46916. * Specifies the ground mirror Falloff distance.
  46917. * This can helps reducing the size of the reflection.
  46918. * 0 by Default.
  46919. */
  46920. groundMirrorFallOffDistance: number;
  46921. /**
  46922. * Specifies the ground mirror texture type.
  46923. * Unsigned Int by Default.
  46924. */
  46925. groundMirrorTextureType: number;
  46926. /**
  46927. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  46928. * the shown objects.
  46929. */
  46930. groundYBias: number;
  46931. /**
  46932. * Specifies wether or not to create a skybox.
  46933. * True by default.
  46934. */
  46935. createSkybox: boolean;
  46936. /**
  46937. * Specifies the skybox size.
  46938. * 20 by default.
  46939. */
  46940. skyboxSize: number;
  46941. /**
  46942. * The texture used on the skybox for the main color.
  46943. * Comes from the BabylonJS CDN by default.
  46944. *
  46945. * Remarks: Can be either a texture or a url.
  46946. */
  46947. skyboxTexture: string | BaseTexture;
  46948. /**
  46949. * The color mixed in the skybox texture by default.
  46950. * BabylonJS clearColor by default.
  46951. */
  46952. skyboxColor: Color3;
  46953. /**
  46954. * The background rotation around the Y axis of the scene.
  46955. * This helps aligning the key lights of your scene with the background.
  46956. * 0 by default.
  46957. */
  46958. backgroundYRotation: number;
  46959. /**
  46960. * Compute automatically the size of the elements to best fit with the scene.
  46961. */
  46962. sizeAuto: boolean;
  46963. /**
  46964. * Default position of the rootMesh if autoSize is not true.
  46965. */
  46966. rootPosition: Vector3;
  46967. /**
  46968. * Sets up the image processing in the scene.
  46969. * true by default.
  46970. */
  46971. setupImageProcessing: boolean;
  46972. /**
  46973. * The texture used as your environment texture in the scene.
  46974. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  46975. *
  46976. * Remarks: Can be either a texture or a url.
  46977. */
  46978. environmentTexture: string | BaseTexture;
  46979. /**
  46980. * The value of the exposure to apply to the scene.
  46981. * 0.6 by default if setupImageProcessing is true.
  46982. */
  46983. cameraExposure: number;
  46984. /**
  46985. * The value of the contrast to apply to the scene.
  46986. * 1.6 by default if setupImageProcessing is true.
  46987. */
  46988. cameraContrast: number;
  46989. /**
  46990. * Specifies wether or not tonemapping should be enabled in the scene.
  46991. * true by default if setupImageProcessing is true.
  46992. */
  46993. toneMappingEnabled: boolean;
  46994. }
  46995. /**
  46996. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  46997. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  46998. * It also helps with the default setup of your imageProcessing configuration.
  46999. */
  47000. export class EnvironmentHelper {
  47001. /**
  47002. * Default ground texture URL.
  47003. */
  47004. private static _groundTextureCDNUrl;
  47005. /**
  47006. * Default skybox texture URL.
  47007. */
  47008. private static _skyboxTextureCDNUrl;
  47009. /**
  47010. * Default environment texture URL.
  47011. */
  47012. private static _environmentTextureCDNUrl;
  47013. /**
  47014. * Creates the default options for the helper.
  47015. */
  47016. private static _getDefaultOptions;
  47017. private _rootMesh;
  47018. /**
  47019. * Gets the root mesh created by the helper.
  47020. */
  47021. readonly rootMesh: Mesh;
  47022. private _skybox;
  47023. /**
  47024. * Gets the skybox created by the helper.
  47025. */
  47026. readonly skybox: Nullable<Mesh>;
  47027. private _skyboxTexture;
  47028. /**
  47029. * Gets the skybox texture created by the helper.
  47030. */
  47031. readonly skyboxTexture: Nullable<BaseTexture>;
  47032. private _skyboxMaterial;
  47033. /**
  47034. * Gets the skybox material created by the helper.
  47035. */
  47036. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  47037. private _ground;
  47038. /**
  47039. * Gets the ground mesh created by the helper.
  47040. */
  47041. readonly ground: Nullable<Mesh>;
  47042. private _groundTexture;
  47043. /**
  47044. * Gets the ground texture created by the helper.
  47045. */
  47046. readonly groundTexture: Nullable<BaseTexture>;
  47047. private _groundMirror;
  47048. /**
  47049. * Gets the ground mirror created by the helper.
  47050. */
  47051. readonly groundMirror: Nullable<MirrorTexture>;
  47052. /**
  47053. * Gets the ground mirror render list to helps pushing the meshes
  47054. * you wish in the ground reflection.
  47055. */
  47056. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  47057. private _groundMaterial;
  47058. /**
  47059. * Gets the ground material created by the helper.
  47060. */
  47061. readonly groundMaterial: Nullable<BackgroundMaterial>;
  47062. /**
  47063. * Stores the creation options.
  47064. */
  47065. private readonly _scene;
  47066. private _options;
  47067. /**
  47068. * This observable will be notified with any error during the creation of the environment,
  47069. * mainly texture creation errors.
  47070. */
  47071. onErrorObservable: Observable<{
  47072. message?: string;
  47073. exception?: any;
  47074. }>;
  47075. /**
  47076. * constructor
  47077. * @param options Defines the options we want to customize the helper
  47078. * @param scene The scene to add the material to
  47079. */
  47080. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  47081. /**
  47082. * Updates the background according to the new options
  47083. * @param options
  47084. */
  47085. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  47086. /**
  47087. * Sets the primary color of all the available elements.
  47088. * @param color the main color to affect to the ground and the background
  47089. */
  47090. setMainColor(color: Color3): void;
  47091. /**
  47092. * Setup the image processing according to the specified options.
  47093. */
  47094. private _setupImageProcessing;
  47095. /**
  47096. * Setup the environment texture according to the specified options.
  47097. */
  47098. private _setupEnvironmentTexture;
  47099. /**
  47100. * Setup the background according to the specified options.
  47101. */
  47102. private _setupBackground;
  47103. /**
  47104. * Get the scene sizes according to the setup.
  47105. */
  47106. private _getSceneSize;
  47107. /**
  47108. * Setup the ground according to the specified options.
  47109. */
  47110. private _setupGround;
  47111. /**
  47112. * Setup the ground material according to the specified options.
  47113. */
  47114. private _setupGroundMaterial;
  47115. /**
  47116. * Setup the ground diffuse texture according to the specified options.
  47117. */
  47118. private _setupGroundDiffuseTexture;
  47119. /**
  47120. * Setup the ground mirror texture according to the specified options.
  47121. */
  47122. private _setupGroundMirrorTexture;
  47123. /**
  47124. * Setup the ground to receive the mirror texture.
  47125. */
  47126. private _setupMirrorInGroundMaterial;
  47127. /**
  47128. * Setup the skybox according to the specified options.
  47129. */
  47130. private _setupSkybox;
  47131. /**
  47132. * Setup the skybox material according to the specified options.
  47133. */
  47134. private _setupSkyboxMaterial;
  47135. /**
  47136. * Setup the skybox reflection texture according to the specified options.
  47137. */
  47138. private _setupSkyboxReflectionTexture;
  47139. private _errorHandler;
  47140. /**
  47141. * Dispose all the elements created by the Helper.
  47142. */
  47143. dispose(): void;
  47144. }
  47145. }
  47146. declare module "babylonjs/Helpers/photoDome" {
  47147. import { Observable } from "babylonjs/Misc/observable";
  47148. import { Nullable } from "babylonjs/types";
  47149. import { Scene } from "babylonjs/scene";
  47150. import { TransformNode } from "babylonjs/Meshes/transformNode";
  47151. import { Mesh } from "babylonjs/Meshes/mesh";
  47152. import { Texture } from "babylonjs/Materials/Textures/texture";
  47153. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  47154. import "babylonjs/Meshes/Builders/sphereBuilder";
  47155. /**
  47156. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  47157. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  47158. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  47159. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  47160. */
  47161. export class PhotoDome extends TransformNode {
  47162. /**
  47163. * Define the image as a Monoscopic panoramic 360 image.
  47164. */
  47165. static readonly MODE_MONOSCOPIC: number;
  47166. /**
  47167. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  47168. */
  47169. static readonly MODE_TOPBOTTOM: number;
  47170. /**
  47171. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  47172. */
  47173. static readonly MODE_SIDEBYSIDE: number;
  47174. private _useDirectMapping;
  47175. /**
  47176. * The texture being displayed on the sphere
  47177. */
  47178. protected _photoTexture: Texture;
  47179. /**
  47180. * Gets or sets the texture being displayed on the sphere
  47181. */
  47182. photoTexture: Texture;
  47183. /**
  47184. * Observable raised when an error occured while loading the 360 image
  47185. */
  47186. onLoadErrorObservable: Observable<string>;
  47187. /**
  47188. * The skybox material
  47189. */
  47190. protected _material: BackgroundMaterial;
  47191. /**
  47192. * The surface used for the skybox
  47193. */
  47194. protected _mesh: Mesh;
  47195. /**
  47196. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  47197. * Also see the options.resolution property.
  47198. */
  47199. fovMultiplier: number;
  47200. private _imageMode;
  47201. /**
  47202. * Gets or set the current video mode for the video. It can be:
  47203. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  47204. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  47205. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  47206. */
  47207. imageMode: number;
  47208. /**
  47209. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  47210. * @param name Element's name, child elements will append suffixes for their own names.
  47211. * @param urlsOfPhoto defines the url of the photo to display
  47212. * @param options defines an object containing optional or exposed sub element properties
  47213. * @param onError defines a callback called when an error occured while loading the texture
  47214. */
  47215. constructor(name: string, urlOfPhoto: string, options: {
  47216. resolution?: number;
  47217. size?: number;
  47218. useDirectMapping?: boolean;
  47219. faceForward?: boolean;
  47220. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  47221. private _onBeforeCameraRenderObserver;
  47222. private _changeImageMode;
  47223. /**
  47224. * Releases resources associated with this node.
  47225. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  47226. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  47227. */
  47228. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  47229. }
  47230. }
  47231. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  47232. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47233. /** @hidden */
  47234. export var rgbdDecodePixelShader: {
  47235. name: string;
  47236. shader: string;
  47237. };
  47238. }
  47239. declare module "babylonjs/Misc/brdfTextureTools" {
  47240. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47241. import { Scene } from "babylonjs/scene";
  47242. import "babylonjs/Shaders/rgbdDecode.fragment";
  47243. /**
  47244. * Class used to host texture specific utilities
  47245. */
  47246. export class BRDFTextureTools {
  47247. /**
  47248. * Expand the BRDF Texture from RGBD to Half Float if necessary.
  47249. * @param texture the texture to expand.
  47250. */
  47251. private static _ExpandDefaultBRDFTexture;
  47252. /**
  47253. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  47254. * @param scene defines the hosting scene
  47255. * @returns the environment BRDF texture
  47256. */
  47257. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  47258. private static _environmentBRDFBase64Texture;
  47259. }
  47260. }
  47261. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  47262. import { Nullable } from "babylonjs/types";
  47263. import { Color3 } from "babylonjs/Maths/math.color";
  47264. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47265. import { EffectFallbacks } from "babylonjs/Materials/effect";
  47266. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  47267. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  47268. import { Engine } from "babylonjs/Engines/engine";
  47269. import { Scene } from "babylonjs/scene";
  47270. /**
  47271. * @hidden
  47272. */
  47273. export interface IMaterialClearCoatDefines {
  47274. CLEARCOAT: boolean;
  47275. CLEARCOAT_DEFAULTIOR: boolean;
  47276. CLEARCOAT_TEXTURE: boolean;
  47277. CLEARCOAT_TEXTUREDIRECTUV: number;
  47278. CLEARCOAT_BUMP: boolean;
  47279. CLEARCOAT_BUMPDIRECTUV: number;
  47280. CLEARCOAT_TINT: boolean;
  47281. CLEARCOAT_TINT_TEXTURE: boolean;
  47282. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  47283. /** @hidden */
  47284. _areTexturesDirty: boolean;
  47285. }
  47286. /**
  47287. * Define the code related to the clear coat parameters of the pbr material.
  47288. */
  47289. export class PBRClearCoatConfiguration {
  47290. /**
  47291. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  47292. * The default fits with a polyurethane material.
  47293. */
  47294. private static readonly _DefaultIndexOfRefraction;
  47295. private _isEnabled;
  47296. /**
  47297. * Defines if the clear coat is enabled in the material.
  47298. */
  47299. isEnabled: boolean;
  47300. /**
  47301. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  47302. */
  47303. intensity: number;
  47304. /**
  47305. * Defines the clear coat layer roughness.
  47306. */
  47307. roughness: number;
  47308. private _indexOfRefraction;
  47309. /**
  47310. * Defines the index of refraction of the clear coat.
  47311. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  47312. * The default fits with a polyurethane material.
  47313. * Changing the default value is more performance intensive.
  47314. */
  47315. indexOfRefraction: number;
  47316. private _texture;
  47317. /**
  47318. * Stores the clear coat values in a texture.
  47319. */
  47320. texture: Nullable<BaseTexture>;
  47321. private _bumpTexture;
  47322. /**
  47323. * Define the clear coat specific bump texture.
  47324. */
  47325. bumpTexture: Nullable<BaseTexture>;
  47326. private _isTintEnabled;
  47327. /**
  47328. * Defines if the clear coat tint is enabled in the material.
  47329. */
  47330. isTintEnabled: boolean;
  47331. /**
  47332. * Defines the clear coat tint of the material.
  47333. * This is only use if tint is enabled
  47334. */
  47335. tintColor: Color3;
  47336. /**
  47337. * Defines the distance at which the tint color should be found in the
  47338. * clear coat media.
  47339. * This is only use if tint is enabled
  47340. */
  47341. tintColorAtDistance: number;
  47342. /**
  47343. * Defines the clear coat layer thickness.
  47344. * This is only use if tint is enabled
  47345. */
  47346. tintThickness: number;
  47347. private _tintTexture;
  47348. /**
  47349. * Stores the clear tint values in a texture.
  47350. * rgb is tint
  47351. * a is a thickness factor
  47352. */
  47353. tintTexture: Nullable<BaseTexture>;
  47354. /** @hidden */
  47355. private _internalMarkAllSubMeshesAsTexturesDirty;
  47356. /** @hidden */
  47357. _markAllSubMeshesAsTexturesDirty(): void;
  47358. /**
  47359. * Instantiate a new istance of clear coat configuration.
  47360. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  47361. */
  47362. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  47363. /**
  47364. * Gets wehter the submesh is ready to be used or not.
  47365. * @param defines the list of "defines" to update.
  47366. * @param scene defines the scene the material belongs to.
  47367. * @param engine defines the engine the material belongs to.
  47368. * @param disableBumpMap defines wether the material disables bump or not.
  47369. * @returns - boolean indicating that the submesh is ready or not.
  47370. */
  47371. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  47372. /**
  47373. * Checks to see if a texture is used in the material.
  47374. * @param defines the list of "defines" to update.
  47375. * @param scene defines the scene to the material belongs to.
  47376. */
  47377. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  47378. /**
  47379. * Binds the material data.
  47380. * @param uniformBuffer defines the Uniform buffer to fill in.
  47381. * @param scene defines the scene the material belongs to.
  47382. * @param engine defines the engine the material belongs to.
  47383. * @param disableBumpMap defines wether the material disables bump or not.
  47384. * @param isFrozen defines wether the material is frozen or not.
  47385. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  47386. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  47387. */
  47388. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  47389. /**
  47390. * Checks to see if a texture is used in the material.
  47391. * @param texture - Base texture to use.
  47392. * @returns - Boolean specifying if a texture is used in the material.
  47393. */
  47394. hasTexture(texture: BaseTexture): boolean;
  47395. /**
  47396. * Returns an array of the actively used textures.
  47397. * @param activeTextures Array of BaseTextures
  47398. */
  47399. getActiveTextures(activeTextures: BaseTexture[]): void;
  47400. /**
  47401. * Returns the animatable textures.
  47402. * @param animatables Array of animatable textures.
  47403. */
  47404. getAnimatables(animatables: IAnimatable[]): void;
  47405. /**
  47406. * Disposes the resources of the material.
  47407. * @param forceDisposeTextures - Forces the disposal of all textures.
  47408. */
  47409. dispose(forceDisposeTextures?: boolean): void;
  47410. /**
  47411. * Get the current class name of the texture useful for serialization or dynamic coding.
  47412. * @returns "PBRClearCoatConfiguration"
  47413. */
  47414. getClassName(): string;
  47415. /**
  47416. * Add fallbacks to the effect fallbacks list.
  47417. * @param defines defines the Base texture to use.
  47418. * @param fallbacks defines the current fallback list.
  47419. * @param currentRank defines the current fallback rank.
  47420. * @returns the new fallback rank.
  47421. */
  47422. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  47423. /**
  47424. * Add the required uniforms to the current list.
  47425. * @param uniforms defines the current uniform list.
  47426. */
  47427. static AddUniforms(uniforms: string[]): void;
  47428. /**
  47429. * Add the required samplers to the current list.
  47430. * @param samplers defines the current sampler list.
  47431. */
  47432. static AddSamplers(samplers: string[]): void;
  47433. /**
  47434. * Add the required uniforms to the current buffer.
  47435. * @param uniformBuffer defines the current uniform buffer.
  47436. */
  47437. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  47438. /**
  47439. * Makes a duplicate of the current configuration into another one.
  47440. * @param clearCoatConfiguration define the config where to copy the info
  47441. */
  47442. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  47443. /**
  47444. * Serializes this clear coat configuration.
  47445. * @returns - An object with the serialized config.
  47446. */
  47447. serialize(): any;
  47448. /**
  47449. * Parses a anisotropy Configuration from a serialized object.
  47450. * @param source - Serialized object.
  47451. * @param scene Defines the scene we are parsing for
  47452. * @param rootUrl Defines the rootUrl to load from
  47453. */
  47454. parse(source: any, scene: Scene, rootUrl: string): void;
  47455. }
  47456. }
  47457. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  47458. import { EffectFallbacks } from "babylonjs/Materials/effect";
  47459. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  47460. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47461. import { Vector2 } from "babylonjs/Maths/math.vector";
  47462. import { Scene } from "babylonjs/scene";
  47463. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47464. import { Nullable } from "babylonjs/types";
  47465. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  47466. /**
  47467. * @hidden
  47468. */
  47469. export interface IMaterialAnisotropicDefines {
  47470. ANISOTROPIC: boolean;
  47471. ANISOTROPIC_TEXTURE: boolean;
  47472. ANISOTROPIC_TEXTUREDIRECTUV: number;
  47473. MAINUV1: boolean;
  47474. _areTexturesDirty: boolean;
  47475. _needUVs: boolean;
  47476. }
  47477. /**
  47478. * Define the code related to the anisotropic parameters of the pbr material.
  47479. */
  47480. export class PBRAnisotropicConfiguration {
  47481. private _isEnabled;
  47482. /**
  47483. * Defines if the anisotropy is enabled in the material.
  47484. */
  47485. isEnabled: boolean;
  47486. /**
  47487. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  47488. */
  47489. intensity: number;
  47490. /**
  47491. * Defines if the effect is along the tangents, bitangents or in between.
  47492. * By default, the effect is "strectching" the highlights along the tangents.
  47493. */
  47494. direction: Vector2;
  47495. private _texture;
  47496. /**
  47497. * Stores the anisotropy values in a texture.
  47498. * rg is direction (like normal from -1 to 1)
  47499. * b is a intensity
  47500. */
  47501. texture: Nullable<BaseTexture>;
  47502. /** @hidden */
  47503. private _internalMarkAllSubMeshesAsTexturesDirty;
  47504. /** @hidden */
  47505. _markAllSubMeshesAsTexturesDirty(): void;
  47506. /**
  47507. * Instantiate a new istance of anisotropy configuration.
  47508. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  47509. */
  47510. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  47511. /**
  47512. * Specifies that the submesh is ready to be used.
  47513. * @param defines the list of "defines" to update.
  47514. * @param scene defines the scene the material belongs to.
  47515. * @returns - boolean indicating that the submesh is ready or not.
  47516. */
  47517. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  47518. /**
  47519. * Checks to see if a texture is used in the material.
  47520. * @param defines the list of "defines" to update.
  47521. * @param mesh the mesh we are preparing the defines for.
  47522. * @param scene defines the scene the material belongs to.
  47523. */
  47524. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  47525. /**
  47526. * Binds the material data.
  47527. * @param uniformBuffer defines the Uniform buffer to fill in.
  47528. * @param scene defines the scene the material belongs to.
  47529. * @param isFrozen defines wether the material is frozen or not.
  47530. */
  47531. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  47532. /**
  47533. * Checks to see if a texture is used in the material.
  47534. * @param texture - Base texture to use.
  47535. * @returns - Boolean specifying if a texture is used in the material.
  47536. */
  47537. hasTexture(texture: BaseTexture): boolean;
  47538. /**
  47539. * Returns an array of the actively used textures.
  47540. * @param activeTextures Array of BaseTextures
  47541. */
  47542. getActiveTextures(activeTextures: BaseTexture[]): void;
  47543. /**
  47544. * Returns the animatable textures.
  47545. * @param animatables Array of animatable textures.
  47546. */
  47547. getAnimatables(animatables: IAnimatable[]): void;
  47548. /**
  47549. * Disposes the resources of the material.
  47550. * @param forceDisposeTextures - Forces the disposal of all textures.
  47551. */
  47552. dispose(forceDisposeTextures?: boolean): void;
  47553. /**
  47554. * Get the current class name of the texture useful for serialization or dynamic coding.
  47555. * @returns "PBRAnisotropicConfiguration"
  47556. */
  47557. getClassName(): string;
  47558. /**
  47559. * Add fallbacks to the effect fallbacks list.
  47560. * @param defines defines the Base texture to use.
  47561. * @param fallbacks defines the current fallback list.
  47562. * @param currentRank defines the current fallback rank.
  47563. * @returns the new fallback rank.
  47564. */
  47565. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  47566. /**
  47567. * Add the required uniforms to the current list.
  47568. * @param uniforms defines the current uniform list.
  47569. */
  47570. static AddUniforms(uniforms: string[]): void;
  47571. /**
  47572. * Add the required uniforms to the current buffer.
  47573. * @param uniformBuffer defines the current uniform buffer.
  47574. */
  47575. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  47576. /**
  47577. * Add the required samplers to the current list.
  47578. * @param samplers defines the current sampler list.
  47579. */
  47580. static AddSamplers(samplers: string[]): void;
  47581. /**
  47582. * Makes a duplicate of the current configuration into another one.
  47583. * @param anisotropicConfiguration define the config where to copy the info
  47584. */
  47585. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  47586. /**
  47587. * Serializes this anisotropy configuration.
  47588. * @returns - An object with the serialized config.
  47589. */
  47590. serialize(): any;
  47591. /**
  47592. * Parses a anisotropy Configuration from a serialized object.
  47593. * @param source - Serialized object.
  47594. * @param scene Defines the scene we are parsing for
  47595. * @param rootUrl Defines the rootUrl to load from
  47596. */
  47597. parse(source: any, scene: Scene, rootUrl: string): void;
  47598. }
  47599. }
  47600. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  47601. import { Scene } from "babylonjs/scene";
  47602. /**
  47603. * @hidden
  47604. */
  47605. export interface IMaterialBRDFDefines {
  47606. BRDF_V_HEIGHT_CORRELATED: boolean;
  47607. MS_BRDF_ENERGY_CONSERVATION: boolean;
  47608. SPHERICAL_HARMONICS: boolean;
  47609. /** @hidden */
  47610. _areMiscDirty: boolean;
  47611. }
  47612. /**
  47613. * Define the code related to the BRDF parameters of the pbr material.
  47614. */
  47615. export class PBRBRDFConfiguration {
  47616. /**
  47617. * Default value used for the energy conservation.
  47618. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  47619. */
  47620. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  47621. /**
  47622. * Default value used for the Smith Visibility Height Correlated mode.
  47623. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  47624. */
  47625. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  47626. /**
  47627. * Default value used for the IBL diffuse part.
  47628. * This can help switching back to the polynomials mode globally which is a tiny bit
  47629. * less GPU intensive at the drawback of a lower quality.
  47630. */
  47631. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  47632. private _useEnergyConservation;
  47633. /**
  47634. * Defines if the material uses energy conservation.
  47635. */
  47636. useEnergyConservation: boolean;
  47637. private _useSmithVisibilityHeightCorrelated;
  47638. /**
  47639. * LEGACY Mode set to false
  47640. * Defines if the material uses height smith correlated visibility term.
  47641. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  47642. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  47643. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  47644. * Not relying on height correlated will also disable energy conservation.
  47645. */
  47646. useSmithVisibilityHeightCorrelated: boolean;
  47647. private _useSphericalHarmonics;
  47648. /**
  47649. * LEGACY Mode set to false
  47650. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  47651. * diffuse part of the IBL.
  47652. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  47653. * to the ground truth.
  47654. */
  47655. useSphericalHarmonics: boolean;
  47656. /** @hidden */
  47657. private _internalMarkAllSubMeshesAsMiscDirty;
  47658. /** @hidden */
  47659. _markAllSubMeshesAsMiscDirty(): void;
  47660. /**
  47661. * Instantiate a new istance of clear coat configuration.
  47662. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  47663. */
  47664. constructor(markAllSubMeshesAsMiscDirty: () => void);
  47665. /**
  47666. * Checks to see if a texture is used in the material.
  47667. * @param defines the list of "defines" to update.
  47668. */
  47669. prepareDefines(defines: IMaterialBRDFDefines): void;
  47670. /**
  47671. * Get the current class name of the texture useful for serialization or dynamic coding.
  47672. * @returns "PBRClearCoatConfiguration"
  47673. */
  47674. getClassName(): string;
  47675. /**
  47676. * Makes a duplicate of the current configuration into another one.
  47677. * @param brdfConfiguration define the config where to copy the info
  47678. */
  47679. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  47680. /**
  47681. * Serializes this BRDF configuration.
  47682. * @returns - An object with the serialized config.
  47683. */
  47684. serialize(): any;
  47685. /**
  47686. * Parses a anisotropy Configuration from a serialized object.
  47687. * @param source - Serialized object.
  47688. * @param scene Defines the scene we are parsing for
  47689. * @param rootUrl Defines the rootUrl to load from
  47690. */
  47691. parse(source: any, scene: Scene, rootUrl: string): void;
  47692. }
  47693. }
  47694. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  47695. import { EffectFallbacks } from "babylonjs/Materials/effect";
  47696. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  47697. import { Color3 } from "babylonjs/Maths/math.color";
  47698. import { Scene } from "babylonjs/scene";
  47699. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47700. import { Nullable } from "babylonjs/types";
  47701. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  47702. /**
  47703. * @hidden
  47704. */
  47705. export interface IMaterialSheenDefines {
  47706. SHEEN: boolean;
  47707. SHEEN_TEXTURE: boolean;
  47708. SHEEN_TEXTUREDIRECTUV: number;
  47709. SHEEN_LINKWITHALBEDO: boolean;
  47710. /** @hidden */
  47711. _areTexturesDirty: boolean;
  47712. }
  47713. /**
  47714. * Define the code related to the Sheen parameters of the pbr material.
  47715. */
  47716. export class PBRSheenConfiguration {
  47717. private _isEnabled;
  47718. /**
  47719. * Defines if the material uses sheen.
  47720. */
  47721. isEnabled: boolean;
  47722. private _linkSheenWithAlbedo;
  47723. /**
  47724. * Defines if the sheen is linked to the sheen color.
  47725. */
  47726. linkSheenWithAlbedo: boolean;
  47727. /**
  47728. * Defines the sheen intensity.
  47729. */
  47730. intensity: number;
  47731. /**
  47732. * Defines the sheen color.
  47733. */
  47734. color: Color3;
  47735. private _texture;
  47736. /**
  47737. * Stores the sheen tint values in a texture.
  47738. * rgb is tint
  47739. * a is a intensity
  47740. */
  47741. texture: Nullable<BaseTexture>;
  47742. /** @hidden */
  47743. private _internalMarkAllSubMeshesAsTexturesDirty;
  47744. /** @hidden */
  47745. _markAllSubMeshesAsTexturesDirty(): void;
  47746. /**
  47747. * Instantiate a new istance of clear coat configuration.
  47748. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  47749. */
  47750. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  47751. /**
  47752. * Specifies that the submesh is ready to be used.
  47753. * @param defines the list of "defines" to update.
  47754. * @param scene defines the scene the material belongs to.
  47755. * @returns - boolean indicating that the submesh is ready or not.
  47756. */
  47757. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  47758. /**
  47759. * Checks to see if a texture is used in the material.
  47760. * @param defines the list of "defines" to update.
  47761. * @param scene defines the scene the material belongs to.
  47762. */
  47763. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  47764. /**
  47765. * Binds the material data.
  47766. * @param uniformBuffer defines the Uniform buffer to fill in.
  47767. * @param scene defines the scene the material belongs to.
  47768. * @param isFrozen defines wether the material is frozen or not.
  47769. */
  47770. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  47771. /**
  47772. * Checks to see if a texture is used in the material.
  47773. * @param texture - Base texture to use.
  47774. * @returns - Boolean specifying if a texture is used in the material.
  47775. */
  47776. hasTexture(texture: BaseTexture): boolean;
  47777. /**
  47778. * Returns an array of the actively used textures.
  47779. * @param activeTextures Array of BaseTextures
  47780. */
  47781. getActiveTextures(activeTextures: BaseTexture[]): void;
  47782. /**
  47783. * Returns the animatable textures.
  47784. * @param animatables Array of animatable textures.
  47785. */
  47786. getAnimatables(animatables: IAnimatable[]): void;
  47787. /**
  47788. * Disposes the resources of the material.
  47789. * @param forceDisposeTextures - Forces the disposal of all textures.
  47790. */
  47791. dispose(forceDisposeTextures?: boolean): void;
  47792. /**
  47793. * Get the current class name of the texture useful for serialization or dynamic coding.
  47794. * @returns "PBRSheenConfiguration"
  47795. */
  47796. getClassName(): string;
  47797. /**
  47798. * Add fallbacks to the effect fallbacks list.
  47799. * @param defines defines the Base texture to use.
  47800. * @param fallbacks defines the current fallback list.
  47801. * @param currentRank defines the current fallback rank.
  47802. * @returns the new fallback rank.
  47803. */
  47804. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  47805. /**
  47806. * Add the required uniforms to the current list.
  47807. * @param uniforms defines the current uniform list.
  47808. */
  47809. static AddUniforms(uniforms: string[]): void;
  47810. /**
  47811. * Add the required uniforms to the current buffer.
  47812. * @param uniformBuffer defines the current uniform buffer.
  47813. */
  47814. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  47815. /**
  47816. * Add the required samplers to the current list.
  47817. * @param samplers defines the current sampler list.
  47818. */
  47819. static AddSamplers(samplers: string[]): void;
  47820. /**
  47821. * Makes a duplicate of the current configuration into another one.
  47822. * @param sheenConfiguration define the config where to copy the info
  47823. */
  47824. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  47825. /**
  47826. * Serializes this BRDF configuration.
  47827. * @returns - An object with the serialized config.
  47828. */
  47829. serialize(): any;
  47830. /**
  47831. * Parses a anisotropy Configuration from a serialized object.
  47832. * @param source - Serialized object.
  47833. * @param scene Defines the scene we are parsing for
  47834. * @param rootUrl Defines the rootUrl to load from
  47835. */
  47836. parse(source: any, scene: Scene, rootUrl: string): void;
  47837. }
  47838. }
  47839. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  47840. import { Nullable } from "babylonjs/types";
  47841. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  47842. import { Color3 } from "babylonjs/Maths/math.color";
  47843. import { SmartArray } from "babylonjs/Misc/smartArray";
  47844. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47845. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  47846. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  47847. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  47848. import { Engine } from "babylonjs/Engines/engine";
  47849. import { Scene } from "babylonjs/scene";
  47850. /**
  47851. * @hidden
  47852. */
  47853. export interface IMaterialSubSurfaceDefines {
  47854. SUBSURFACE: boolean;
  47855. SS_REFRACTION: boolean;
  47856. SS_TRANSLUCENCY: boolean;
  47857. SS_SCATERRING: boolean;
  47858. SS_THICKNESSANDMASK_TEXTURE: boolean;
  47859. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  47860. SS_REFRACTIONMAP_3D: boolean;
  47861. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  47862. SS_LODINREFRACTIONALPHA: boolean;
  47863. SS_GAMMAREFRACTION: boolean;
  47864. SS_RGBDREFRACTION: boolean;
  47865. SS_LINEARSPECULARREFRACTION: boolean;
  47866. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  47867. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  47868. /** @hidden */
  47869. _areTexturesDirty: boolean;
  47870. }
  47871. /**
  47872. * Define the code related to the sub surface parameters of the pbr material.
  47873. */
  47874. export class PBRSubSurfaceConfiguration {
  47875. private _isRefractionEnabled;
  47876. /**
  47877. * Defines if the refraction is enabled in the material.
  47878. */
  47879. isRefractionEnabled: boolean;
  47880. private _isTranslucencyEnabled;
  47881. /**
  47882. * Defines if the translucency is enabled in the material.
  47883. */
  47884. isTranslucencyEnabled: boolean;
  47885. private _isScatteringEnabled;
  47886. /**
  47887. * Defines the refraction intensity of the material.
  47888. * The refraction when enabled replaces the Diffuse part of the material.
  47889. * The intensity helps transitionning between diffuse and refraction.
  47890. */
  47891. refractionIntensity: number;
  47892. /**
  47893. * Defines the translucency intensity of the material.
  47894. * When translucency has been enabled, this defines how much of the "translucency"
  47895. * is addded to the diffuse part of the material.
  47896. */
  47897. translucencyIntensity: number;
  47898. /**
  47899. * Defines the scattering intensity of the material.
  47900. * When scattering has been enabled, this defines how much of the "scattered light"
  47901. * is addded to the diffuse part of the material.
  47902. */
  47903. scatteringIntensity: number;
  47904. private _thicknessTexture;
  47905. /**
  47906. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  47907. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  47908. * 0 would mean minimumThickness
  47909. * 1 would mean maximumThickness
  47910. * The other channels might be use as a mask to vary the different effects intensity.
  47911. */
  47912. thicknessTexture: Nullable<BaseTexture>;
  47913. private _refractionTexture;
  47914. /**
  47915. * Defines the texture to use for refraction.
  47916. */
  47917. refractionTexture: Nullable<BaseTexture>;
  47918. private _indexOfRefraction;
  47919. /**
  47920. * Defines the index of refraction used in the material.
  47921. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  47922. */
  47923. indexOfRefraction: number;
  47924. private _invertRefractionY;
  47925. /**
  47926. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  47927. */
  47928. invertRefractionY: boolean;
  47929. private _linkRefractionWithTransparency;
  47930. /**
  47931. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  47932. * Materials half opaque for instance using refraction could benefit from this control.
  47933. */
  47934. linkRefractionWithTransparency: boolean;
  47935. /**
  47936. * Defines the minimum thickness stored in the thickness map.
  47937. * If no thickness map is defined, this value will be used to simulate thickness.
  47938. */
  47939. minimumThickness: number;
  47940. /**
  47941. * Defines the maximum thickness stored in the thickness map.
  47942. */
  47943. maximumThickness: number;
  47944. /**
  47945. * Defines the volume tint of the material.
  47946. * This is used for both translucency and scattering.
  47947. */
  47948. tintColor: Color3;
  47949. /**
  47950. * Defines the distance at which the tint color should be found in the media.
  47951. * This is used for refraction only.
  47952. */
  47953. tintColorAtDistance: number;
  47954. /**
  47955. * Defines how far each channel transmit through the media.
  47956. * It is defined as a color to simplify it selection.
  47957. */
  47958. diffusionDistance: Color3;
  47959. private _useMaskFromThicknessTexture;
  47960. /**
  47961. * Stores the intensity of the different subsurface effects in the thickness texture.
  47962. * * the green channel is the translucency intensity.
  47963. * * the blue channel is the scattering intensity.
  47964. * * the alpha channel is the refraction intensity.
  47965. */
  47966. useMaskFromThicknessTexture: boolean;
  47967. /** @hidden */
  47968. private _internalMarkAllSubMeshesAsTexturesDirty;
  47969. /** @hidden */
  47970. _markAllSubMeshesAsTexturesDirty(): void;
  47971. /**
  47972. * Instantiate a new istance of sub surface configuration.
  47973. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  47974. */
  47975. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  47976. /**
  47977. * Gets wehter the submesh is ready to be used or not.
  47978. * @param defines the list of "defines" to update.
  47979. * @param scene defines the scene the material belongs to.
  47980. * @returns - boolean indicating that the submesh is ready or not.
  47981. */
  47982. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  47983. /**
  47984. * Checks to see if a texture is used in the material.
  47985. * @param defines the list of "defines" to update.
  47986. * @param scene defines the scene to the material belongs to.
  47987. */
  47988. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  47989. /**
  47990. * Binds the material data.
  47991. * @param uniformBuffer defines the Uniform buffer to fill in.
  47992. * @param scene defines the scene the material belongs to.
  47993. * @param engine defines the engine the material belongs to.
  47994. * @param isFrozen defines wether the material is frozen or not.
  47995. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  47996. */
  47997. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  47998. /**
  47999. * Unbinds the material from the mesh.
  48000. * @param activeEffect defines the effect that should be unbound from.
  48001. * @returns true if unbound, otherwise false
  48002. */
  48003. unbind(activeEffect: Effect): boolean;
  48004. /**
  48005. * Returns the texture used for refraction or null if none is used.
  48006. * @param scene defines the scene the material belongs to.
  48007. * @returns - Refraction texture if present. If no refraction texture and refraction
  48008. * is linked with transparency, returns environment texture. Otherwise, returns null.
  48009. */
  48010. private _getRefractionTexture;
  48011. /**
  48012. * Returns true if alpha blending should be disabled.
  48013. */
  48014. readonly disableAlphaBlending: boolean;
  48015. /**
  48016. * Fills the list of render target textures.
  48017. * @param renderTargets the list of render targets to update
  48018. */
  48019. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  48020. /**
  48021. * Checks to see if a texture is used in the material.
  48022. * @param texture - Base texture to use.
  48023. * @returns - Boolean specifying if a texture is used in the material.
  48024. */
  48025. hasTexture(texture: BaseTexture): boolean;
  48026. /**
  48027. * Gets a boolean indicating that current material needs to register RTT
  48028. * @returns true if this uses a render target otherwise false.
  48029. */
  48030. hasRenderTargetTextures(): boolean;
  48031. /**
  48032. * Returns an array of the actively used textures.
  48033. * @param activeTextures Array of BaseTextures
  48034. */
  48035. getActiveTextures(activeTextures: BaseTexture[]): void;
  48036. /**
  48037. * Returns the animatable textures.
  48038. * @param animatables Array of animatable textures.
  48039. */
  48040. getAnimatables(animatables: IAnimatable[]): void;
  48041. /**
  48042. * Disposes the resources of the material.
  48043. * @param forceDisposeTextures - Forces the disposal of all textures.
  48044. */
  48045. dispose(forceDisposeTextures?: boolean): void;
  48046. /**
  48047. * Get the current class name of the texture useful for serialization or dynamic coding.
  48048. * @returns "PBRSubSurfaceConfiguration"
  48049. */
  48050. getClassName(): string;
  48051. /**
  48052. * Add fallbacks to the effect fallbacks list.
  48053. * @param defines defines the Base texture to use.
  48054. * @param fallbacks defines the current fallback list.
  48055. * @param currentRank defines the current fallback rank.
  48056. * @returns the new fallback rank.
  48057. */
  48058. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48059. /**
  48060. * Add the required uniforms to the current list.
  48061. * @param uniforms defines the current uniform list.
  48062. */
  48063. static AddUniforms(uniforms: string[]): void;
  48064. /**
  48065. * Add the required samplers to the current list.
  48066. * @param samplers defines the current sampler list.
  48067. */
  48068. static AddSamplers(samplers: string[]): void;
  48069. /**
  48070. * Add the required uniforms to the current buffer.
  48071. * @param uniformBuffer defines the current uniform buffer.
  48072. */
  48073. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48074. /**
  48075. * Makes a duplicate of the current configuration into another one.
  48076. * @param configuration define the config where to copy the info
  48077. */
  48078. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  48079. /**
  48080. * Serializes this Sub Surface configuration.
  48081. * @returns - An object with the serialized config.
  48082. */
  48083. serialize(): any;
  48084. /**
  48085. * Parses a anisotropy Configuration from a serialized object.
  48086. * @param source - Serialized object.
  48087. * @param scene Defines the scene we are parsing for
  48088. * @param rootUrl Defines the rootUrl to load from
  48089. */
  48090. parse(source: any, scene: Scene, rootUrl: string): void;
  48091. }
  48092. }
  48093. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  48094. /** @hidden */
  48095. export var pbrFragmentDeclaration: {
  48096. name: string;
  48097. shader: string;
  48098. };
  48099. }
  48100. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  48101. /** @hidden */
  48102. export var pbrUboDeclaration: {
  48103. name: string;
  48104. shader: string;
  48105. };
  48106. }
  48107. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  48108. /** @hidden */
  48109. export var pbrFragmentExtraDeclaration: {
  48110. name: string;
  48111. shader: string;
  48112. };
  48113. }
  48114. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  48115. /** @hidden */
  48116. export var pbrFragmentSamplersDeclaration: {
  48117. name: string;
  48118. shader: string;
  48119. };
  48120. }
  48121. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  48122. /** @hidden */
  48123. export var pbrHelperFunctions: {
  48124. name: string;
  48125. shader: string;
  48126. };
  48127. }
  48128. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  48129. /** @hidden */
  48130. export var harmonicsFunctions: {
  48131. name: string;
  48132. shader: string;
  48133. };
  48134. }
  48135. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  48136. /** @hidden */
  48137. export var pbrDirectLightingSetupFunctions: {
  48138. name: string;
  48139. shader: string;
  48140. };
  48141. }
  48142. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  48143. /** @hidden */
  48144. export var pbrDirectLightingFalloffFunctions: {
  48145. name: string;
  48146. shader: string;
  48147. };
  48148. }
  48149. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  48150. /** @hidden */
  48151. export var pbrBRDFFunctions: {
  48152. name: string;
  48153. shader: string;
  48154. };
  48155. }
  48156. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  48157. /** @hidden */
  48158. export var pbrDirectLightingFunctions: {
  48159. name: string;
  48160. shader: string;
  48161. };
  48162. }
  48163. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  48164. /** @hidden */
  48165. export var pbrIBLFunctions: {
  48166. name: string;
  48167. shader: string;
  48168. };
  48169. }
  48170. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  48171. /** @hidden */
  48172. export var pbrDebug: {
  48173. name: string;
  48174. shader: string;
  48175. };
  48176. }
  48177. declare module "babylonjs/Shaders/pbr.fragment" {
  48178. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  48179. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  48180. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  48181. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48182. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48183. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  48184. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  48185. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  48186. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  48187. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  48188. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48189. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  48190. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  48191. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  48192. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  48193. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  48194. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  48195. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  48196. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  48197. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  48198. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  48199. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  48200. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  48201. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  48202. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  48203. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  48204. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  48205. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  48206. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  48207. /** @hidden */
  48208. export var pbrPixelShader: {
  48209. name: string;
  48210. shader: string;
  48211. };
  48212. }
  48213. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  48214. /** @hidden */
  48215. export var pbrVertexDeclaration: {
  48216. name: string;
  48217. shader: string;
  48218. };
  48219. }
  48220. declare module "babylonjs/Shaders/pbr.vertex" {
  48221. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  48222. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  48223. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48224. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  48225. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  48226. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  48227. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  48228. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  48229. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  48230. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48231. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48232. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  48233. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  48234. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  48235. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  48236. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  48237. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  48238. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  48239. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  48240. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  48241. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  48242. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  48243. /** @hidden */
  48244. export var pbrVertexShader: {
  48245. name: string;
  48246. shader: string;
  48247. };
  48248. }
  48249. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  48250. import { Nullable } from "babylonjs/types";
  48251. import { Scene } from "babylonjs/scene";
  48252. import { Matrix } from "babylonjs/Maths/math.vector";
  48253. import { SubMesh } from "babylonjs/Meshes/subMesh";
  48254. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48255. import { Mesh } from "babylonjs/Meshes/mesh";
  48256. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  48257. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  48258. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  48259. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  48260. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  48261. import { Color3 } from "babylonjs/Maths/math.color";
  48262. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  48263. import { Material } from "babylonjs/Materials/material";
  48264. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  48265. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48266. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48267. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48268. import "babylonjs/Shaders/pbr.fragment";
  48269. import "babylonjs/Shaders/pbr.vertex";
  48270. /**
  48271. * Manages the defines for the PBR Material.
  48272. * @hidden
  48273. */
  48274. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  48275. PBR: boolean;
  48276. MAINUV1: boolean;
  48277. MAINUV2: boolean;
  48278. UV1: boolean;
  48279. UV2: boolean;
  48280. ALBEDO: boolean;
  48281. ALBEDODIRECTUV: number;
  48282. VERTEXCOLOR: boolean;
  48283. AMBIENT: boolean;
  48284. AMBIENTDIRECTUV: number;
  48285. AMBIENTINGRAYSCALE: boolean;
  48286. OPACITY: boolean;
  48287. VERTEXALPHA: boolean;
  48288. OPACITYDIRECTUV: number;
  48289. OPACITYRGB: boolean;
  48290. ALPHATEST: boolean;
  48291. DEPTHPREPASS: boolean;
  48292. ALPHABLEND: boolean;
  48293. ALPHAFROMALBEDO: boolean;
  48294. ALPHATESTVALUE: string;
  48295. SPECULAROVERALPHA: boolean;
  48296. RADIANCEOVERALPHA: boolean;
  48297. ALPHAFRESNEL: boolean;
  48298. LINEARALPHAFRESNEL: boolean;
  48299. PREMULTIPLYALPHA: boolean;
  48300. EMISSIVE: boolean;
  48301. EMISSIVEDIRECTUV: number;
  48302. REFLECTIVITY: boolean;
  48303. REFLECTIVITYDIRECTUV: number;
  48304. SPECULARTERM: boolean;
  48305. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  48306. MICROSURFACEAUTOMATIC: boolean;
  48307. LODBASEDMICROSFURACE: boolean;
  48308. MICROSURFACEMAP: boolean;
  48309. MICROSURFACEMAPDIRECTUV: number;
  48310. METALLICWORKFLOW: boolean;
  48311. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  48312. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  48313. METALLNESSSTOREINMETALMAPBLUE: boolean;
  48314. AOSTOREINMETALMAPRED: boolean;
  48315. ENVIRONMENTBRDF: boolean;
  48316. ENVIRONMENTBRDF_RGBD: boolean;
  48317. NORMAL: boolean;
  48318. TANGENT: boolean;
  48319. BUMP: boolean;
  48320. BUMPDIRECTUV: number;
  48321. OBJECTSPACE_NORMALMAP: boolean;
  48322. PARALLAX: boolean;
  48323. PARALLAXOCCLUSION: boolean;
  48324. NORMALXYSCALE: boolean;
  48325. LIGHTMAP: boolean;
  48326. LIGHTMAPDIRECTUV: number;
  48327. USELIGHTMAPASSHADOWMAP: boolean;
  48328. GAMMALIGHTMAP: boolean;
  48329. REFLECTION: boolean;
  48330. REFLECTIONMAP_3D: boolean;
  48331. REFLECTIONMAP_SPHERICAL: boolean;
  48332. REFLECTIONMAP_PLANAR: boolean;
  48333. REFLECTIONMAP_CUBIC: boolean;
  48334. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  48335. REFLECTIONMAP_PROJECTION: boolean;
  48336. REFLECTIONMAP_SKYBOX: boolean;
  48337. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  48338. REFLECTIONMAP_EXPLICIT: boolean;
  48339. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  48340. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  48341. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  48342. INVERTCUBICMAP: boolean;
  48343. USESPHERICALFROMREFLECTIONMAP: boolean;
  48344. USEIRRADIANCEMAP: boolean;
  48345. SPHERICAL_HARMONICS: boolean;
  48346. USESPHERICALINVERTEX: boolean;
  48347. REFLECTIONMAP_OPPOSITEZ: boolean;
  48348. LODINREFLECTIONALPHA: boolean;
  48349. GAMMAREFLECTION: boolean;
  48350. RGBDREFLECTION: boolean;
  48351. LINEARSPECULARREFLECTION: boolean;
  48352. RADIANCEOCCLUSION: boolean;
  48353. HORIZONOCCLUSION: boolean;
  48354. INSTANCES: boolean;
  48355. NUM_BONE_INFLUENCERS: number;
  48356. BonesPerMesh: number;
  48357. BONETEXTURE: boolean;
  48358. NONUNIFORMSCALING: boolean;
  48359. MORPHTARGETS: boolean;
  48360. MORPHTARGETS_NORMAL: boolean;
  48361. MORPHTARGETS_TANGENT: boolean;
  48362. MORPHTARGETS_UV: boolean;
  48363. NUM_MORPH_INFLUENCERS: number;
  48364. IMAGEPROCESSING: boolean;
  48365. VIGNETTE: boolean;
  48366. VIGNETTEBLENDMODEMULTIPLY: boolean;
  48367. VIGNETTEBLENDMODEOPAQUE: boolean;
  48368. TONEMAPPING: boolean;
  48369. TONEMAPPING_ACES: boolean;
  48370. CONTRAST: boolean;
  48371. COLORCURVES: boolean;
  48372. COLORGRADING: boolean;
  48373. COLORGRADING3D: boolean;
  48374. SAMPLER3DGREENDEPTH: boolean;
  48375. SAMPLER3DBGRMAP: boolean;
  48376. IMAGEPROCESSINGPOSTPROCESS: boolean;
  48377. EXPOSURE: boolean;
  48378. MULTIVIEW: boolean;
  48379. USEPHYSICALLIGHTFALLOFF: boolean;
  48380. USEGLTFLIGHTFALLOFF: boolean;
  48381. TWOSIDEDLIGHTING: boolean;
  48382. SHADOWFLOAT: boolean;
  48383. CLIPPLANE: boolean;
  48384. CLIPPLANE2: boolean;
  48385. CLIPPLANE3: boolean;
  48386. CLIPPLANE4: boolean;
  48387. POINTSIZE: boolean;
  48388. FOG: boolean;
  48389. LOGARITHMICDEPTH: boolean;
  48390. FORCENORMALFORWARD: boolean;
  48391. SPECULARAA: boolean;
  48392. CLEARCOAT: boolean;
  48393. CLEARCOAT_DEFAULTIOR: boolean;
  48394. CLEARCOAT_TEXTURE: boolean;
  48395. CLEARCOAT_TEXTUREDIRECTUV: number;
  48396. CLEARCOAT_BUMP: boolean;
  48397. CLEARCOAT_BUMPDIRECTUV: number;
  48398. CLEARCOAT_TINT: boolean;
  48399. CLEARCOAT_TINT_TEXTURE: boolean;
  48400. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  48401. ANISOTROPIC: boolean;
  48402. ANISOTROPIC_TEXTURE: boolean;
  48403. ANISOTROPIC_TEXTUREDIRECTUV: number;
  48404. BRDF_V_HEIGHT_CORRELATED: boolean;
  48405. MS_BRDF_ENERGY_CONSERVATION: boolean;
  48406. SHEEN: boolean;
  48407. SHEEN_TEXTURE: boolean;
  48408. SHEEN_TEXTUREDIRECTUV: number;
  48409. SHEEN_LINKWITHALBEDO: boolean;
  48410. SUBSURFACE: boolean;
  48411. SS_REFRACTION: boolean;
  48412. SS_TRANSLUCENCY: boolean;
  48413. SS_SCATERRING: boolean;
  48414. SS_THICKNESSANDMASK_TEXTURE: boolean;
  48415. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  48416. SS_REFRACTIONMAP_3D: boolean;
  48417. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  48418. SS_LODINREFRACTIONALPHA: boolean;
  48419. SS_GAMMAREFRACTION: boolean;
  48420. SS_RGBDREFRACTION: boolean;
  48421. SS_LINEARSPECULARREFRACTION: boolean;
  48422. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  48423. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  48424. UNLIT: boolean;
  48425. DEBUGMODE: number;
  48426. /**
  48427. * Initializes the PBR Material defines.
  48428. */
  48429. constructor();
  48430. /**
  48431. * Resets the PBR Material defines.
  48432. */
  48433. reset(): void;
  48434. }
  48435. /**
  48436. * The Physically based material base class of BJS.
  48437. *
  48438. * This offers the main features of a standard PBR material.
  48439. * For more information, please refer to the documentation :
  48440. * https://doc.babylonjs.com/how_to/physically_based_rendering
  48441. */
  48442. export abstract class PBRBaseMaterial extends PushMaterial {
  48443. /**
  48444. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  48445. */
  48446. static readonly PBRMATERIAL_OPAQUE: number;
  48447. /**
  48448. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  48449. */
  48450. static readonly PBRMATERIAL_ALPHATEST: number;
  48451. /**
  48452. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  48453. */
  48454. static readonly PBRMATERIAL_ALPHABLEND: number;
  48455. /**
  48456. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  48457. * They are also discarded below the alpha cutoff threshold to improve performances.
  48458. */
  48459. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  48460. /**
  48461. * Defines the default value of how much AO map is occluding the analytical lights
  48462. * (point spot...).
  48463. */
  48464. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  48465. /**
  48466. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  48467. */
  48468. static readonly LIGHTFALLOFF_PHYSICAL: number;
  48469. /**
  48470. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  48471. * to enhance interoperability with other engines.
  48472. */
  48473. static readonly LIGHTFALLOFF_GLTF: number;
  48474. /**
  48475. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  48476. * to enhance interoperability with other materials.
  48477. */
  48478. static readonly LIGHTFALLOFF_STANDARD: number;
  48479. /**
  48480. * Intensity of the direct lights e.g. the four lights available in your scene.
  48481. * This impacts both the direct diffuse and specular highlights.
  48482. */
  48483. protected _directIntensity: number;
  48484. /**
  48485. * Intensity of the emissive part of the material.
  48486. * This helps controlling the emissive effect without modifying the emissive color.
  48487. */
  48488. protected _emissiveIntensity: number;
  48489. /**
  48490. * Intensity of the environment e.g. how much the environment will light the object
  48491. * either through harmonics for rough material or through the refelction for shiny ones.
  48492. */
  48493. protected _environmentIntensity: number;
  48494. /**
  48495. * This is a special control allowing the reduction of the specular highlights coming from the
  48496. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  48497. */
  48498. protected _specularIntensity: number;
  48499. /**
  48500. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  48501. */
  48502. private _lightingInfos;
  48503. /**
  48504. * Debug Control allowing disabling the bump map on this material.
  48505. */
  48506. protected _disableBumpMap: boolean;
  48507. /**
  48508. * AKA Diffuse Texture in standard nomenclature.
  48509. */
  48510. protected _albedoTexture: Nullable<BaseTexture>;
  48511. /**
  48512. * AKA Occlusion Texture in other nomenclature.
  48513. */
  48514. protected _ambientTexture: Nullable<BaseTexture>;
  48515. /**
  48516. * AKA Occlusion Texture Intensity in other nomenclature.
  48517. */
  48518. protected _ambientTextureStrength: number;
  48519. /**
  48520. * Defines how much the AO map is occluding the analytical lights (point spot...).
  48521. * 1 means it completely occludes it
  48522. * 0 mean it has no impact
  48523. */
  48524. protected _ambientTextureImpactOnAnalyticalLights: number;
  48525. /**
  48526. * Stores the alpha values in a texture.
  48527. */
  48528. protected _opacityTexture: Nullable<BaseTexture>;
  48529. /**
  48530. * Stores the reflection values in a texture.
  48531. */
  48532. protected _reflectionTexture: Nullable<BaseTexture>;
  48533. /**
  48534. * Stores the emissive values in a texture.
  48535. */
  48536. protected _emissiveTexture: Nullable<BaseTexture>;
  48537. /**
  48538. * AKA Specular texture in other nomenclature.
  48539. */
  48540. protected _reflectivityTexture: Nullable<BaseTexture>;
  48541. /**
  48542. * Used to switch from specular/glossiness to metallic/roughness workflow.
  48543. */
  48544. protected _metallicTexture: Nullable<BaseTexture>;
  48545. /**
  48546. * Specifies the metallic scalar of the metallic/roughness workflow.
  48547. * Can also be used to scale the metalness values of the metallic texture.
  48548. */
  48549. protected _metallic: Nullable<number>;
  48550. /**
  48551. * Specifies the roughness scalar of the metallic/roughness workflow.
  48552. * Can also be used to scale the roughness values of the metallic texture.
  48553. */
  48554. protected _roughness: Nullable<number>;
  48555. /**
  48556. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  48557. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  48558. */
  48559. protected _microSurfaceTexture: Nullable<BaseTexture>;
  48560. /**
  48561. * Stores surface normal data used to displace a mesh in a texture.
  48562. */
  48563. protected _bumpTexture: Nullable<BaseTexture>;
  48564. /**
  48565. * Stores the pre-calculated light information of a mesh in a texture.
  48566. */
  48567. protected _lightmapTexture: Nullable<BaseTexture>;
  48568. /**
  48569. * The color of a material in ambient lighting.
  48570. */
  48571. protected _ambientColor: Color3;
  48572. /**
  48573. * AKA Diffuse Color in other nomenclature.
  48574. */
  48575. protected _albedoColor: Color3;
  48576. /**
  48577. * AKA Specular Color in other nomenclature.
  48578. */
  48579. protected _reflectivityColor: Color3;
  48580. /**
  48581. * The color applied when light is reflected from a material.
  48582. */
  48583. protected _reflectionColor: Color3;
  48584. /**
  48585. * The color applied when light is emitted from a material.
  48586. */
  48587. protected _emissiveColor: Color3;
  48588. /**
  48589. * AKA Glossiness in other nomenclature.
  48590. */
  48591. protected _microSurface: number;
  48592. /**
  48593. * Specifies that the material will use the light map as a show map.
  48594. */
  48595. protected _useLightmapAsShadowmap: boolean;
  48596. /**
  48597. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  48598. * makes the reflect vector face the model (under horizon).
  48599. */
  48600. protected _useHorizonOcclusion: boolean;
  48601. /**
  48602. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  48603. * too much the area relying on ambient texture to define their ambient occlusion.
  48604. */
  48605. protected _useRadianceOcclusion: boolean;
  48606. /**
  48607. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  48608. */
  48609. protected _useAlphaFromAlbedoTexture: boolean;
  48610. /**
  48611. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  48612. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  48613. */
  48614. protected _useSpecularOverAlpha: boolean;
  48615. /**
  48616. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  48617. */
  48618. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  48619. /**
  48620. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  48621. */
  48622. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  48623. /**
  48624. * Specifies if the metallic texture contains the roughness information in its green channel.
  48625. */
  48626. protected _useRoughnessFromMetallicTextureGreen: boolean;
  48627. /**
  48628. * Specifies if the metallic texture contains the metallness information in its blue channel.
  48629. */
  48630. protected _useMetallnessFromMetallicTextureBlue: boolean;
  48631. /**
  48632. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  48633. */
  48634. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  48635. /**
  48636. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  48637. */
  48638. protected _useAmbientInGrayScale: boolean;
  48639. /**
  48640. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  48641. * The material will try to infer what glossiness each pixel should be.
  48642. */
  48643. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  48644. /**
  48645. * Defines the falloff type used in this material.
  48646. * It by default is Physical.
  48647. */
  48648. protected _lightFalloff: number;
  48649. /**
  48650. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  48651. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  48652. */
  48653. protected _useRadianceOverAlpha: boolean;
  48654. /**
  48655. * Allows using an object space normal map (instead of tangent space).
  48656. */
  48657. protected _useObjectSpaceNormalMap: boolean;
  48658. /**
  48659. * Allows using the bump map in parallax mode.
  48660. */
  48661. protected _useParallax: boolean;
  48662. /**
  48663. * Allows using the bump map in parallax occlusion mode.
  48664. */
  48665. protected _useParallaxOcclusion: boolean;
  48666. /**
  48667. * Controls the scale bias of the parallax mode.
  48668. */
  48669. protected _parallaxScaleBias: number;
  48670. /**
  48671. * If sets to true, disables all the lights affecting the material.
  48672. */
  48673. protected _disableLighting: boolean;
  48674. /**
  48675. * Number of Simultaneous lights allowed on the material.
  48676. */
  48677. protected _maxSimultaneousLights: number;
  48678. /**
  48679. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  48680. */
  48681. protected _invertNormalMapX: boolean;
  48682. /**
  48683. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  48684. */
  48685. protected _invertNormalMapY: boolean;
  48686. /**
  48687. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  48688. */
  48689. protected _twoSidedLighting: boolean;
  48690. /**
  48691. * Defines the alpha limits in alpha test mode.
  48692. */
  48693. protected _alphaCutOff: number;
  48694. /**
  48695. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  48696. */
  48697. protected _forceAlphaTest: boolean;
  48698. /**
  48699. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  48700. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  48701. */
  48702. protected _useAlphaFresnel: boolean;
  48703. /**
  48704. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  48705. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  48706. */
  48707. protected _useLinearAlphaFresnel: boolean;
  48708. /**
  48709. * The transparency mode of the material.
  48710. */
  48711. protected _transparencyMode: Nullable<number>;
  48712. /**
  48713. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  48714. * from cos thetav and roughness:
  48715. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  48716. */
  48717. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  48718. /**
  48719. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  48720. */
  48721. protected _forceIrradianceInFragment: boolean;
  48722. /**
  48723. * Force normal to face away from face.
  48724. */
  48725. protected _forceNormalForward: boolean;
  48726. /**
  48727. * Enables specular anti aliasing in the PBR shader.
  48728. * It will both interacts on the Geometry for analytical and IBL lighting.
  48729. * It also prefilter the roughness map based on the bump values.
  48730. */
  48731. protected _enableSpecularAntiAliasing: boolean;
  48732. /**
  48733. * Default configuration related to image processing available in the PBR Material.
  48734. */
  48735. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  48736. /**
  48737. * Keep track of the image processing observer to allow dispose and replace.
  48738. */
  48739. private _imageProcessingObserver;
  48740. /**
  48741. * Attaches a new image processing configuration to the PBR Material.
  48742. * @param configuration
  48743. */
  48744. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  48745. /**
  48746. * Stores the available render targets.
  48747. */
  48748. private _renderTargets;
  48749. /**
  48750. * Sets the global ambient color for the material used in lighting calculations.
  48751. */
  48752. private _globalAmbientColor;
  48753. /**
  48754. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  48755. */
  48756. private _useLogarithmicDepth;
  48757. /**
  48758. * If set to true, no lighting calculations will be applied.
  48759. */
  48760. private _unlit;
  48761. private _debugMode;
  48762. /**
  48763. * @hidden
  48764. * This is reserved for the inspector.
  48765. * Defines the material debug mode.
  48766. * It helps seeing only some components of the material while troubleshooting.
  48767. */
  48768. debugMode: number;
  48769. /**
  48770. * @hidden
  48771. * This is reserved for the inspector.
  48772. * Specify from where on screen the debug mode should start.
  48773. * The value goes from -1 (full screen) to 1 (not visible)
  48774. * It helps with side by side comparison against the final render
  48775. * This defaults to -1
  48776. */
  48777. private debugLimit;
  48778. /**
  48779. * @hidden
  48780. * This is reserved for the inspector.
  48781. * As the default viewing range might not be enough (if the ambient is really small for instance)
  48782. * You can use the factor to better multiply the final value.
  48783. */
  48784. private debugFactor;
  48785. /**
  48786. * Defines the clear coat layer parameters for the material.
  48787. */
  48788. readonly clearCoat: PBRClearCoatConfiguration;
  48789. /**
  48790. * Defines the anisotropic parameters for the material.
  48791. */
  48792. readonly anisotropy: PBRAnisotropicConfiguration;
  48793. /**
  48794. * Defines the BRDF parameters for the material.
  48795. */
  48796. readonly brdf: PBRBRDFConfiguration;
  48797. /**
  48798. * Defines the Sheen parameters for the material.
  48799. */
  48800. readonly sheen: PBRSheenConfiguration;
  48801. /**
  48802. * Defines the SubSurface parameters for the material.
  48803. */
  48804. readonly subSurface: PBRSubSurfaceConfiguration;
  48805. /**
  48806. * Custom callback helping to override the default shader used in the material.
  48807. */
  48808. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  48809. /**
  48810. * Instantiates a new PBRMaterial instance.
  48811. *
  48812. * @param name The material name
  48813. * @param scene The scene the material will be use in.
  48814. */
  48815. constructor(name: string, scene: Scene);
  48816. /**
  48817. * Gets a boolean indicating that current material needs to register RTT
  48818. */
  48819. readonly hasRenderTargetTextures: boolean;
  48820. /**
  48821. * Gets the name of the material class.
  48822. */
  48823. getClassName(): string;
  48824. /**
  48825. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  48826. */
  48827. /**
  48828. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  48829. */
  48830. useLogarithmicDepth: boolean;
  48831. /**
  48832. * Gets the current transparency mode.
  48833. */
  48834. /**
  48835. * Sets the transparency mode of the material.
  48836. *
  48837. * | Value | Type | Description |
  48838. * | ----- | ----------------------------------- | ----------- |
  48839. * | 0 | OPAQUE | |
  48840. * | 1 | ALPHATEST | |
  48841. * | 2 | ALPHABLEND | |
  48842. * | 3 | ALPHATESTANDBLEND | |
  48843. *
  48844. */
  48845. transparencyMode: Nullable<number>;
  48846. /**
  48847. * Returns true if alpha blending should be disabled.
  48848. */
  48849. private readonly _disableAlphaBlending;
  48850. /**
  48851. * Specifies whether or not this material should be rendered in alpha blend mode.
  48852. */
  48853. needAlphaBlending(): boolean;
  48854. /**
  48855. * Specifies if the mesh will require alpha blending.
  48856. * @param mesh - BJS mesh.
  48857. */
  48858. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  48859. /**
  48860. * Specifies whether or not this material should be rendered in alpha test mode.
  48861. */
  48862. needAlphaTesting(): boolean;
  48863. /**
  48864. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  48865. */
  48866. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  48867. /**
  48868. * Gets the texture used for the alpha test.
  48869. */
  48870. getAlphaTestTexture(): Nullable<BaseTexture>;
  48871. /**
  48872. * Specifies that the submesh is ready to be used.
  48873. * @param mesh - BJS mesh.
  48874. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  48875. * @param useInstances - Specifies that instances should be used.
  48876. * @returns - boolean indicating that the submesh is ready or not.
  48877. */
  48878. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  48879. /**
  48880. * Specifies if the material uses metallic roughness workflow.
  48881. * @returns boolean specifiying if the material uses metallic roughness workflow.
  48882. */
  48883. isMetallicWorkflow(): boolean;
  48884. private _prepareEffect;
  48885. private _prepareDefines;
  48886. /**
  48887. * Force shader compilation
  48888. */
  48889. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  48890. clipPlane: boolean;
  48891. }>): void;
  48892. /**
  48893. * Initializes the uniform buffer layout for the shader.
  48894. */
  48895. buildUniformLayout(): void;
  48896. /**
  48897. * Unbinds the material from the mesh
  48898. */
  48899. unbind(): void;
  48900. /**
  48901. * Binds the submesh data.
  48902. * @param world - The world matrix.
  48903. * @param mesh - The BJS mesh.
  48904. * @param subMesh - A submesh of the BJS mesh.
  48905. */
  48906. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  48907. /**
  48908. * Returns the animatable textures.
  48909. * @returns - Array of animatable textures.
  48910. */
  48911. getAnimatables(): IAnimatable[];
  48912. /**
  48913. * Returns the texture used for reflections.
  48914. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  48915. */
  48916. private _getReflectionTexture;
  48917. /**
  48918. * Returns an array of the actively used textures.
  48919. * @returns - Array of BaseTextures
  48920. */
  48921. getActiveTextures(): BaseTexture[];
  48922. /**
  48923. * Checks to see if a texture is used in the material.
  48924. * @param texture - Base texture to use.
  48925. * @returns - Boolean specifying if a texture is used in the material.
  48926. */
  48927. hasTexture(texture: BaseTexture): boolean;
  48928. /**
  48929. * Disposes the resources of the material.
  48930. * @param forceDisposeEffect - Forces the disposal of effects.
  48931. * @param forceDisposeTextures - Forces the disposal of all textures.
  48932. */
  48933. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  48934. }
  48935. }
  48936. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  48937. import { Nullable } from "babylonjs/types";
  48938. import { Scene } from "babylonjs/scene";
  48939. import { Color3 } from "babylonjs/Maths/math.color";
  48940. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  48941. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  48942. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48943. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  48944. /**
  48945. * The Physically based material of BJS.
  48946. *
  48947. * This offers the main features of a standard PBR material.
  48948. * For more information, please refer to the documentation :
  48949. * https://doc.babylonjs.com/how_to/physically_based_rendering
  48950. */
  48951. export class PBRMaterial extends PBRBaseMaterial {
  48952. /**
  48953. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  48954. */
  48955. static readonly PBRMATERIAL_OPAQUE: number;
  48956. /**
  48957. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  48958. */
  48959. static readonly PBRMATERIAL_ALPHATEST: number;
  48960. /**
  48961. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  48962. */
  48963. static readonly PBRMATERIAL_ALPHABLEND: number;
  48964. /**
  48965. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  48966. * They are also discarded below the alpha cutoff threshold to improve performances.
  48967. */
  48968. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  48969. /**
  48970. * Defines the default value of how much AO map is occluding the analytical lights
  48971. * (point spot...).
  48972. */
  48973. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  48974. /**
  48975. * Intensity of the direct lights e.g. the four lights available in your scene.
  48976. * This impacts both the direct diffuse and specular highlights.
  48977. */
  48978. directIntensity: number;
  48979. /**
  48980. * Intensity of the emissive part of the material.
  48981. * This helps controlling the emissive effect without modifying the emissive color.
  48982. */
  48983. emissiveIntensity: number;
  48984. /**
  48985. * Intensity of the environment e.g. how much the environment will light the object
  48986. * either through harmonics for rough material or through the refelction for shiny ones.
  48987. */
  48988. environmentIntensity: number;
  48989. /**
  48990. * This is a special control allowing the reduction of the specular highlights coming from the
  48991. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  48992. */
  48993. specularIntensity: number;
  48994. /**
  48995. * Debug Control allowing disabling the bump map on this material.
  48996. */
  48997. disableBumpMap: boolean;
  48998. /**
  48999. * AKA Diffuse Texture in standard nomenclature.
  49000. */
  49001. albedoTexture: BaseTexture;
  49002. /**
  49003. * AKA Occlusion Texture in other nomenclature.
  49004. */
  49005. ambientTexture: BaseTexture;
  49006. /**
  49007. * AKA Occlusion Texture Intensity in other nomenclature.
  49008. */
  49009. ambientTextureStrength: number;
  49010. /**
  49011. * Defines how much the AO map is occluding the analytical lights (point spot...).
  49012. * 1 means it completely occludes it
  49013. * 0 mean it has no impact
  49014. */
  49015. ambientTextureImpactOnAnalyticalLights: number;
  49016. /**
  49017. * Stores the alpha values in a texture.
  49018. */
  49019. opacityTexture: BaseTexture;
  49020. /**
  49021. * Stores the reflection values in a texture.
  49022. */
  49023. reflectionTexture: Nullable<BaseTexture>;
  49024. /**
  49025. * Stores the emissive values in a texture.
  49026. */
  49027. emissiveTexture: BaseTexture;
  49028. /**
  49029. * AKA Specular texture in other nomenclature.
  49030. */
  49031. reflectivityTexture: BaseTexture;
  49032. /**
  49033. * Used to switch from specular/glossiness to metallic/roughness workflow.
  49034. */
  49035. metallicTexture: BaseTexture;
  49036. /**
  49037. * Specifies the metallic scalar of the metallic/roughness workflow.
  49038. * Can also be used to scale the metalness values of the metallic texture.
  49039. */
  49040. metallic: Nullable<number>;
  49041. /**
  49042. * Specifies the roughness scalar of the metallic/roughness workflow.
  49043. * Can also be used to scale the roughness values of the metallic texture.
  49044. */
  49045. roughness: Nullable<number>;
  49046. /**
  49047. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  49048. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  49049. */
  49050. microSurfaceTexture: BaseTexture;
  49051. /**
  49052. * Stores surface normal data used to displace a mesh in a texture.
  49053. */
  49054. bumpTexture: BaseTexture;
  49055. /**
  49056. * Stores the pre-calculated light information of a mesh in a texture.
  49057. */
  49058. lightmapTexture: BaseTexture;
  49059. /**
  49060. * Stores the refracted light information in a texture.
  49061. */
  49062. refractionTexture: Nullable<BaseTexture>;
  49063. /**
  49064. * The color of a material in ambient lighting.
  49065. */
  49066. ambientColor: Color3;
  49067. /**
  49068. * AKA Diffuse Color in other nomenclature.
  49069. */
  49070. albedoColor: Color3;
  49071. /**
  49072. * AKA Specular Color in other nomenclature.
  49073. */
  49074. reflectivityColor: Color3;
  49075. /**
  49076. * The color reflected from the material.
  49077. */
  49078. reflectionColor: Color3;
  49079. /**
  49080. * The color emitted from the material.
  49081. */
  49082. emissiveColor: Color3;
  49083. /**
  49084. * AKA Glossiness in other nomenclature.
  49085. */
  49086. microSurface: number;
  49087. /**
  49088. * source material index of refraction (IOR)' / 'destination material IOR.
  49089. */
  49090. indexOfRefraction: number;
  49091. /**
  49092. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49093. */
  49094. invertRefractionY: boolean;
  49095. /**
  49096. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49097. * Materials half opaque for instance using refraction could benefit from this control.
  49098. */
  49099. linkRefractionWithTransparency: boolean;
  49100. /**
  49101. * If true, the light map contains occlusion information instead of lighting info.
  49102. */
  49103. useLightmapAsShadowmap: boolean;
  49104. /**
  49105. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  49106. */
  49107. useAlphaFromAlbedoTexture: boolean;
  49108. /**
  49109. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  49110. */
  49111. forceAlphaTest: boolean;
  49112. /**
  49113. * Defines the alpha limits in alpha test mode.
  49114. */
  49115. alphaCutOff: number;
  49116. /**
  49117. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  49118. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  49119. */
  49120. useSpecularOverAlpha: boolean;
  49121. /**
  49122. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  49123. */
  49124. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  49125. /**
  49126. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  49127. */
  49128. useRoughnessFromMetallicTextureAlpha: boolean;
  49129. /**
  49130. * Specifies if the metallic texture contains the roughness information in its green channel.
  49131. */
  49132. useRoughnessFromMetallicTextureGreen: boolean;
  49133. /**
  49134. * Specifies if the metallic texture contains the metallness information in its blue channel.
  49135. */
  49136. useMetallnessFromMetallicTextureBlue: boolean;
  49137. /**
  49138. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  49139. */
  49140. useAmbientOcclusionFromMetallicTextureRed: boolean;
  49141. /**
  49142. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  49143. */
  49144. useAmbientInGrayScale: boolean;
  49145. /**
  49146. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  49147. * The material will try to infer what glossiness each pixel should be.
  49148. */
  49149. useAutoMicroSurfaceFromReflectivityMap: boolean;
  49150. /**
  49151. * BJS is using an harcoded light falloff based on a manually sets up range.
  49152. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  49153. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  49154. */
  49155. /**
  49156. * BJS is using an harcoded light falloff based on a manually sets up range.
  49157. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  49158. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  49159. */
  49160. usePhysicalLightFalloff: boolean;
  49161. /**
  49162. * In order to support the falloff compatibility with gltf, a special mode has been added
  49163. * to reproduce the gltf light falloff.
  49164. */
  49165. /**
  49166. * In order to support the falloff compatibility with gltf, a special mode has been added
  49167. * to reproduce the gltf light falloff.
  49168. */
  49169. useGLTFLightFalloff: boolean;
  49170. /**
  49171. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  49172. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  49173. */
  49174. useRadianceOverAlpha: boolean;
  49175. /**
  49176. * Allows using an object space normal map (instead of tangent space).
  49177. */
  49178. useObjectSpaceNormalMap: boolean;
  49179. /**
  49180. * Allows using the bump map in parallax mode.
  49181. */
  49182. useParallax: boolean;
  49183. /**
  49184. * Allows using the bump map in parallax occlusion mode.
  49185. */
  49186. useParallaxOcclusion: boolean;
  49187. /**
  49188. * Controls the scale bias of the parallax mode.
  49189. */
  49190. parallaxScaleBias: number;
  49191. /**
  49192. * If sets to true, disables all the lights affecting the material.
  49193. */
  49194. disableLighting: boolean;
  49195. /**
  49196. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  49197. */
  49198. forceIrradianceInFragment: boolean;
  49199. /**
  49200. * Number of Simultaneous lights allowed on the material.
  49201. */
  49202. maxSimultaneousLights: number;
  49203. /**
  49204. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  49205. */
  49206. invertNormalMapX: boolean;
  49207. /**
  49208. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  49209. */
  49210. invertNormalMapY: boolean;
  49211. /**
  49212. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  49213. */
  49214. twoSidedLighting: boolean;
  49215. /**
  49216. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  49217. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  49218. */
  49219. useAlphaFresnel: boolean;
  49220. /**
  49221. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  49222. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  49223. */
  49224. useLinearAlphaFresnel: boolean;
  49225. /**
  49226. * Let user defines the brdf lookup texture used for IBL.
  49227. * A default 8bit version is embedded but you could point at :
  49228. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  49229. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  49230. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  49231. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  49232. */
  49233. environmentBRDFTexture: Nullable<BaseTexture>;
  49234. /**
  49235. * Force normal to face away from face.
  49236. */
  49237. forceNormalForward: boolean;
  49238. /**
  49239. * Enables specular anti aliasing in the PBR shader.
  49240. * It will both interacts on the Geometry for analytical and IBL lighting.
  49241. * It also prefilter the roughness map based on the bump values.
  49242. */
  49243. enableSpecularAntiAliasing: boolean;
  49244. /**
  49245. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  49246. * makes the reflect vector face the model (under horizon).
  49247. */
  49248. useHorizonOcclusion: boolean;
  49249. /**
  49250. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  49251. * too much the area relying on ambient texture to define their ambient occlusion.
  49252. */
  49253. useRadianceOcclusion: boolean;
  49254. /**
  49255. * If set to true, no lighting calculations will be applied.
  49256. */
  49257. unlit: boolean;
  49258. /**
  49259. * Gets the image processing configuration used either in this material.
  49260. */
  49261. /**
  49262. * Sets the Default image processing configuration used either in the this material.
  49263. *
  49264. * If sets to null, the scene one is in use.
  49265. */
  49266. imageProcessingConfiguration: ImageProcessingConfiguration;
  49267. /**
  49268. * Gets wether the color curves effect is enabled.
  49269. */
  49270. /**
  49271. * Sets wether the color curves effect is enabled.
  49272. */
  49273. cameraColorCurvesEnabled: boolean;
  49274. /**
  49275. * Gets wether the color grading effect is enabled.
  49276. */
  49277. /**
  49278. * Gets wether the color grading effect is enabled.
  49279. */
  49280. cameraColorGradingEnabled: boolean;
  49281. /**
  49282. * Gets wether tonemapping is enabled or not.
  49283. */
  49284. /**
  49285. * Sets wether tonemapping is enabled or not
  49286. */
  49287. cameraToneMappingEnabled: boolean;
  49288. /**
  49289. * The camera exposure used on this material.
  49290. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  49291. * This corresponds to a photographic exposure.
  49292. */
  49293. /**
  49294. * The camera exposure used on this material.
  49295. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  49296. * This corresponds to a photographic exposure.
  49297. */
  49298. cameraExposure: number;
  49299. /**
  49300. * Gets The camera contrast used on this material.
  49301. */
  49302. /**
  49303. * Sets The camera contrast used on this material.
  49304. */
  49305. cameraContrast: number;
  49306. /**
  49307. * Gets the Color Grading 2D Lookup Texture.
  49308. */
  49309. /**
  49310. * Sets the Color Grading 2D Lookup Texture.
  49311. */
  49312. cameraColorGradingTexture: Nullable<BaseTexture>;
  49313. /**
  49314. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  49315. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  49316. * 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;
  49317. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  49318. */
  49319. /**
  49320. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  49321. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  49322. * 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;
  49323. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  49324. */
  49325. cameraColorCurves: Nullable<ColorCurves>;
  49326. /**
  49327. * Instantiates a new PBRMaterial instance.
  49328. *
  49329. * @param name The material name
  49330. * @param scene The scene the material will be use in.
  49331. */
  49332. constructor(name: string, scene: Scene);
  49333. /**
  49334. * Returns the name of this material class.
  49335. */
  49336. getClassName(): string;
  49337. /**
  49338. * Makes a duplicate of the current material.
  49339. * @param name - name to use for the new material.
  49340. */
  49341. clone(name: string): PBRMaterial;
  49342. /**
  49343. * Serializes this PBR Material.
  49344. * @returns - An object with the serialized material.
  49345. */
  49346. serialize(): any;
  49347. /**
  49348. * Parses a PBR Material from a serialized object.
  49349. * @param source - Serialized object.
  49350. * @param scene - BJS scene instance.
  49351. * @param rootUrl - url for the scene object
  49352. * @returns - PBRMaterial
  49353. */
  49354. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  49355. }
  49356. }
  49357. declare module "babylonjs/Misc/dds" {
  49358. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  49359. import { Engine } from "babylonjs/Engines/engine";
  49360. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49361. import { Nullable } from "babylonjs/types";
  49362. import { Scene } from "babylonjs/scene";
  49363. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  49364. /**
  49365. * Direct draw surface info
  49366. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  49367. */
  49368. export interface DDSInfo {
  49369. /**
  49370. * Width of the texture
  49371. */
  49372. width: number;
  49373. /**
  49374. * Width of the texture
  49375. */
  49376. height: number;
  49377. /**
  49378. * Number of Mipmaps for the texture
  49379. * @see https://en.wikipedia.org/wiki/Mipmap
  49380. */
  49381. mipmapCount: number;
  49382. /**
  49383. * If the textures format is a known fourCC format
  49384. * @see https://www.fourcc.org/
  49385. */
  49386. isFourCC: boolean;
  49387. /**
  49388. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  49389. */
  49390. isRGB: boolean;
  49391. /**
  49392. * If the texture is a lumincance format
  49393. */
  49394. isLuminance: boolean;
  49395. /**
  49396. * If this is a cube texture
  49397. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  49398. */
  49399. isCube: boolean;
  49400. /**
  49401. * If the texture is a compressed format eg. FOURCC_DXT1
  49402. */
  49403. isCompressed: boolean;
  49404. /**
  49405. * The dxgiFormat of the texture
  49406. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  49407. */
  49408. dxgiFormat: number;
  49409. /**
  49410. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  49411. */
  49412. textureType: number;
  49413. /**
  49414. * Sphericle polynomial created for the dds texture
  49415. */
  49416. sphericalPolynomial?: SphericalPolynomial;
  49417. }
  49418. /**
  49419. * Class used to provide DDS decompression tools
  49420. */
  49421. export class DDSTools {
  49422. /**
  49423. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  49424. */
  49425. static StoreLODInAlphaChannel: boolean;
  49426. /**
  49427. * Gets DDS information from an array buffer
  49428. * @param arrayBuffer defines the array buffer to read data from
  49429. * @returns the DDS information
  49430. */
  49431. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  49432. private static _FloatView;
  49433. private static _Int32View;
  49434. private static _ToHalfFloat;
  49435. private static _FromHalfFloat;
  49436. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  49437. private static _GetHalfFloatRGBAArrayBuffer;
  49438. private static _GetFloatRGBAArrayBuffer;
  49439. private static _GetFloatAsUIntRGBAArrayBuffer;
  49440. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  49441. private static _GetRGBAArrayBuffer;
  49442. private static _ExtractLongWordOrder;
  49443. private static _GetRGBArrayBuffer;
  49444. private static _GetLuminanceArrayBuffer;
  49445. /**
  49446. * Uploads DDS Levels to a Babylon Texture
  49447. * @hidden
  49448. */
  49449. static UploadDDSLevels(engine: Engine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  49450. }
  49451. module "babylonjs/Engines/engine" {
  49452. interface Engine {
  49453. /**
  49454. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  49455. * @param rootUrl defines the url where the file to load is located
  49456. * @param scene defines the current scene
  49457. * @param lodScale defines scale to apply to the mip map selection
  49458. * @param lodOffset defines offset to apply to the mip map selection
  49459. * @param onLoad defines an optional callback raised when the texture is loaded
  49460. * @param onError defines an optional callback raised if there is an issue to load the texture
  49461. * @param format defines the format of the data
  49462. * @param forcedExtension defines the extension to use to pick the right loader
  49463. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  49464. * @returns the cube texture as an InternalTexture
  49465. */
  49466. 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;
  49467. }
  49468. }
  49469. }
  49470. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  49471. import { Nullable } from "babylonjs/types";
  49472. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49473. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  49474. /**
  49475. * Implementation of the DDS Texture Loader.
  49476. * @hidden
  49477. */
  49478. export class _DDSTextureLoader implements IInternalTextureLoader {
  49479. /**
  49480. * Defines wether the loader supports cascade loading the different faces.
  49481. */
  49482. readonly supportCascades: boolean;
  49483. /**
  49484. * This returns if the loader support the current file information.
  49485. * @param extension defines the file extension of the file being loaded
  49486. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49487. * @param fallback defines the fallback internal texture if any
  49488. * @param isBase64 defines whether the texture is encoded as a base64
  49489. * @param isBuffer defines whether the texture data are stored as a buffer
  49490. * @returns true if the loader can load the specified file
  49491. */
  49492. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  49493. /**
  49494. * Transform the url before loading if required.
  49495. * @param rootUrl the url of the texture
  49496. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49497. * @returns the transformed texture
  49498. */
  49499. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  49500. /**
  49501. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  49502. * @param rootUrl the url of the texture
  49503. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49504. * @returns the fallback texture
  49505. */
  49506. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  49507. /**
  49508. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  49509. * @param data contains the texture data
  49510. * @param texture defines the BabylonJS internal texture
  49511. * @param createPolynomials will be true if polynomials have been requested
  49512. * @param onLoad defines the callback to trigger once the texture is ready
  49513. * @param onError defines the callback to trigger in case of error
  49514. */
  49515. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  49516. /**
  49517. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  49518. * @param data contains the texture data
  49519. * @param texture defines the BabylonJS internal texture
  49520. * @param callback defines the method to call once ready to upload
  49521. */
  49522. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  49523. }
  49524. }
  49525. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  49526. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  49527. /** @hidden */
  49528. export var rgbdEncodePixelShader: {
  49529. name: string;
  49530. shader: string;
  49531. };
  49532. }
  49533. declare module "babylonjs/Misc/environmentTextureTools" {
  49534. import { Nullable } from "babylonjs/types";
  49535. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  49536. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49537. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  49538. import "babylonjs/Engines/Extensions/engine.renderTarget";
  49539. import "babylonjs/Shaders/rgbdEncode.fragment";
  49540. import "babylonjs/Shaders/rgbdDecode.fragment";
  49541. /**
  49542. * Raw texture data and descriptor sufficient for WebGL texture upload
  49543. */
  49544. export interface EnvironmentTextureInfo {
  49545. /**
  49546. * Version of the environment map
  49547. */
  49548. version: number;
  49549. /**
  49550. * Width of image
  49551. */
  49552. width: number;
  49553. /**
  49554. * Irradiance information stored in the file.
  49555. */
  49556. irradiance: any;
  49557. /**
  49558. * Specular information stored in the file.
  49559. */
  49560. specular: any;
  49561. }
  49562. /**
  49563. * Sets of helpers addressing the serialization and deserialization of environment texture
  49564. * stored in a BabylonJS env file.
  49565. * Those files are usually stored as .env files.
  49566. */
  49567. export class EnvironmentTextureTools {
  49568. /**
  49569. * Magic number identifying the env file.
  49570. */
  49571. private static _MagicBytes;
  49572. /**
  49573. * Gets the environment info from an env file.
  49574. * @param data The array buffer containing the .env bytes.
  49575. * @returns the environment file info (the json header) if successfully parsed.
  49576. */
  49577. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  49578. /**
  49579. * Creates an environment texture from a loaded cube texture.
  49580. * @param texture defines the cube texture to convert in env file
  49581. * @return a promise containing the environment data if succesfull.
  49582. */
  49583. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  49584. /**
  49585. * Creates a JSON representation of the spherical data.
  49586. * @param texture defines the texture containing the polynomials
  49587. * @return the JSON representation of the spherical info
  49588. */
  49589. private static _CreateEnvTextureIrradiance;
  49590. /**
  49591. * Uploads the texture info contained in the env file to the GPU.
  49592. * @param texture defines the internal texture to upload to
  49593. * @param arrayBuffer defines the buffer cotaining the data to load
  49594. * @param info defines the texture info retrieved through the GetEnvInfo method
  49595. * @returns a promise
  49596. */
  49597. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  49598. /**
  49599. * Uploads the levels of image data to the GPU.
  49600. * @param texture defines the internal texture to upload to
  49601. * @param imageData defines the array buffer views of image data [mipmap][face]
  49602. * @returns a promise
  49603. */
  49604. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  49605. /**
  49606. * Uploads spherical polynomials information to the texture.
  49607. * @param texture defines the texture we are trying to upload the information to
  49608. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  49609. */
  49610. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  49611. /** @hidden */
  49612. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  49613. }
  49614. }
  49615. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  49616. import { Nullable } from "babylonjs/types";
  49617. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49618. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  49619. /**
  49620. * Implementation of the ENV Texture Loader.
  49621. * @hidden
  49622. */
  49623. export class _ENVTextureLoader implements IInternalTextureLoader {
  49624. /**
  49625. * Defines wether the loader supports cascade loading the different faces.
  49626. */
  49627. readonly supportCascades: boolean;
  49628. /**
  49629. * This returns if the loader support the current file information.
  49630. * @param extension defines the file extension of the file being loaded
  49631. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49632. * @param fallback defines the fallback internal texture if any
  49633. * @param isBase64 defines whether the texture is encoded as a base64
  49634. * @param isBuffer defines whether the texture data are stored as a buffer
  49635. * @returns true if the loader can load the specified file
  49636. */
  49637. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  49638. /**
  49639. * Transform the url before loading if required.
  49640. * @param rootUrl the url of the texture
  49641. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49642. * @returns the transformed texture
  49643. */
  49644. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  49645. /**
  49646. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  49647. * @param rootUrl the url of the texture
  49648. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49649. * @returns the fallback texture
  49650. */
  49651. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  49652. /**
  49653. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  49654. * @param data contains the texture data
  49655. * @param texture defines the BabylonJS internal texture
  49656. * @param createPolynomials will be true if polynomials have been requested
  49657. * @param onLoad defines the callback to trigger once the texture is ready
  49658. * @param onError defines the callback to trigger in case of error
  49659. */
  49660. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  49661. /**
  49662. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  49663. * @param data contains the texture data
  49664. * @param texture defines the BabylonJS internal texture
  49665. * @param callback defines the method to call once ready to upload
  49666. */
  49667. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  49668. }
  49669. }
  49670. declare module "babylonjs/Misc/khronosTextureContainer" {
  49671. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49672. /**
  49673. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  49674. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  49675. */
  49676. export class KhronosTextureContainer {
  49677. /** contents of the KTX container file */
  49678. arrayBuffer: any;
  49679. private static HEADER_LEN;
  49680. private static COMPRESSED_2D;
  49681. private static COMPRESSED_3D;
  49682. private static TEX_2D;
  49683. private static TEX_3D;
  49684. /**
  49685. * Gets the openGL type
  49686. */
  49687. glType: number;
  49688. /**
  49689. * Gets the openGL type size
  49690. */
  49691. glTypeSize: number;
  49692. /**
  49693. * Gets the openGL format
  49694. */
  49695. glFormat: number;
  49696. /**
  49697. * Gets the openGL internal format
  49698. */
  49699. glInternalFormat: number;
  49700. /**
  49701. * Gets the base internal format
  49702. */
  49703. glBaseInternalFormat: number;
  49704. /**
  49705. * Gets image width in pixel
  49706. */
  49707. pixelWidth: number;
  49708. /**
  49709. * Gets image height in pixel
  49710. */
  49711. pixelHeight: number;
  49712. /**
  49713. * Gets image depth in pixels
  49714. */
  49715. pixelDepth: number;
  49716. /**
  49717. * Gets the number of array elements
  49718. */
  49719. numberOfArrayElements: number;
  49720. /**
  49721. * Gets the number of faces
  49722. */
  49723. numberOfFaces: number;
  49724. /**
  49725. * Gets the number of mipmap levels
  49726. */
  49727. numberOfMipmapLevels: number;
  49728. /**
  49729. * Gets the bytes of key value data
  49730. */
  49731. bytesOfKeyValueData: number;
  49732. /**
  49733. * Gets the load type
  49734. */
  49735. loadType: number;
  49736. /**
  49737. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  49738. */
  49739. isInvalid: boolean;
  49740. /**
  49741. * Creates a new KhronosTextureContainer
  49742. * @param arrayBuffer contents of the KTX container file
  49743. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  49744. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  49745. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  49746. */
  49747. constructor(
  49748. /** contents of the KTX container file */
  49749. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  49750. /**
  49751. * Uploads KTX content to a Babylon Texture.
  49752. * It is assumed that the texture has already been created & is currently bound
  49753. * @hidden
  49754. */
  49755. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  49756. private _upload2DCompressedLevels;
  49757. }
  49758. }
  49759. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  49760. import { Nullable } from "babylonjs/types";
  49761. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  49762. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  49763. /**
  49764. * Implementation of the KTX Texture Loader.
  49765. * @hidden
  49766. */
  49767. export class _KTXTextureLoader implements IInternalTextureLoader {
  49768. /**
  49769. * Defines wether the loader supports cascade loading the different faces.
  49770. */
  49771. readonly supportCascades: boolean;
  49772. /**
  49773. * This returns if the loader support the current file information.
  49774. * @param extension defines the file extension of the file being loaded
  49775. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49776. * @param fallback defines the fallback internal texture if any
  49777. * @param isBase64 defines whether the texture is encoded as a base64
  49778. * @param isBuffer defines whether the texture data are stored as a buffer
  49779. * @returns true if the loader can load the specified file
  49780. */
  49781. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  49782. /**
  49783. * Transform the url before loading if required.
  49784. * @param rootUrl the url of the texture
  49785. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49786. * @returns the transformed texture
  49787. */
  49788. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  49789. /**
  49790. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  49791. * @param rootUrl the url of the texture
  49792. * @param textureFormatInUse defines the current compressed format in use iun the engine
  49793. * @returns the fallback texture
  49794. */
  49795. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  49796. /**
  49797. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  49798. * @param data contains the texture data
  49799. * @param texture defines the BabylonJS internal texture
  49800. * @param createPolynomials will be true if polynomials have been requested
  49801. * @param onLoad defines the callback to trigger once the texture is ready
  49802. * @param onError defines the callback to trigger in case of error
  49803. */
  49804. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  49805. /**
  49806. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  49807. * @param data contains the texture data
  49808. * @param texture defines the BabylonJS internal texture
  49809. * @param callback defines the method to call once ready to upload
  49810. */
  49811. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  49812. }
  49813. }
  49814. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  49815. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  49816. import { Scene } from "babylonjs/scene";
  49817. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  49818. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  49819. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  49820. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  49821. import { WebXRManagedOutputCanvas } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  49822. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  49823. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49824. /**
  49825. * Options for the default xr helper
  49826. */
  49827. export class WebXRDefaultExperienceOptions {
  49828. /**
  49829. * Floor meshes that should be used for teleporting
  49830. */
  49831. floorMeshes: Array<AbstractMesh>;
  49832. }
  49833. /**
  49834. * Default experience which provides a similar setup to the previous webVRExperience
  49835. */
  49836. export class WebXRDefaultExperience {
  49837. /**
  49838. * Base experience
  49839. */
  49840. baseExperience: WebXRExperienceHelper;
  49841. /**
  49842. * Input experience extension
  49843. */
  49844. input: WebXRInput;
  49845. /**
  49846. * Loads the controller models
  49847. */
  49848. controllerModelLoader: WebXRControllerModelLoader;
  49849. /**
  49850. * Enables laser pointer and selection
  49851. */
  49852. pointerSelection: WebXRControllerPointerSelection;
  49853. /**
  49854. * Enables teleportation
  49855. */
  49856. teleportation: WebXRControllerTeleportation;
  49857. /**
  49858. * Enables ui for enetering/exiting xr
  49859. */
  49860. enterExitUI: WebXREnterExitUI;
  49861. /**
  49862. * Default output canvas xr should render to
  49863. */
  49864. outputCanvas: WebXRManagedOutputCanvas;
  49865. /**
  49866. * Creates the default xr experience
  49867. * @param scene scene
  49868. * @param options options for basic configuration
  49869. * @returns resulting WebXRDefaultExperience
  49870. */
  49871. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  49872. private constructor();
  49873. /**
  49874. * DIsposes of the experience helper
  49875. */
  49876. dispose(): void;
  49877. }
  49878. }
  49879. declare module "babylonjs/Helpers/sceneHelpers" {
  49880. import { Nullable } from "babylonjs/types";
  49881. import { Mesh } from "babylonjs/Meshes/mesh";
  49882. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49883. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  49884. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  49885. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  49886. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  49887. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  49888. import "babylonjs/Meshes/Builders/boxBuilder";
  49889. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  49890. /** @hidden */
  49891. export var _forceSceneHelpersToBundle: boolean;
  49892. module "babylonjs/scene" {
  49893. interface Scene {
  49894. /**
  49895. * Creates a default light for the scene.
  49896. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  49897. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  49898. */
  49899. createDefaultLight(replace?: boolean): void;
  49900. /**
  49901. * Creates a default camera for the scene.
  49902. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  49903. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  49904. * @param replace has default false, when true replaces the active camera in the scene
  49905. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  49906. */
  49907. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  49908. /**
  49909. * Creates a default camera and a default light.
  49910. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  49911. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  49912. * @param replace has the default false, when true replaces the active camera/light in the scene
  49913. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  49914. */
  49915. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  49916. /**
  49917. * Creates a new sky box
  49918. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  49919. * @param environmentTexture defines the texture to use as environment texture
  49920. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  49921. * @param scale defines the overall scale of the skybox
  49922. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  49923. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  49924. * @returns a new mesh holding the sky box
  49925. */
  49926. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  49927. /**
  49928. * Creates a new environment
  49929. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  49930. * @param options defines the options you can use to configure the environment
  49931. * @returns the new EnvironmentHelper
  49932. */
  49933. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  49934. /**
  49935. * Creates a new VREXperienceHelper
  49936. * @see http://doc.babylonjs.com/how_to/webvr_helper
  49937. * @param webVROptions defines the options used to create the new VREXperienceHelper
  49938. * @returns a new VREXperienceHelper
  49939. */
  49940. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  49941. /**
  49942. * Creates a new WebXRDefaultExperience
  49943. * @see http://doc.babylonjs.com/how_to/webxr
  49944. * @param options experience options
  49945. * @returns a promise for a new WebXRDefaultExperience
  49946. */
  49947. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  49948. }
  49949. }
  49950. }
  49951. declare module "babylonjs/Helpers/videoDome" {
  49952. import { Scene } from "babylonjs/scene";
  49953. import { TransformNode } from "babylonjs/Meshes/transformNode";
  49954. import { Mesh } from "babylonjs/Meshes/mesh";
  49955. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  49956. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  49957. import "babylonjs/Meshes/Builders/sphereBuilder";
  49958. /**
  49959. * Display a 360 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  49960. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  49961. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  49962. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  49963. */
  49964. export class VideoDome extends TransformNode {
  49965. /**
  49966. * Define the video source as a Monoscopic panoramic 360 video.
  49967. */
  49968. static readonly MODE_MONOSCOPIC: number;
  49969. /**
  49970. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  49971. */
  49972. static readonly MODE_TOPBOTTOM: number;
  49973. /**
  49974. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  49975. */
  49976. static readonly MODE_SIDEBYSIDE: number;
  49977. private _useDirectMapping;
  49978. /**
  49979. * The video texture being displayed on the sphere
  49980. */
  49981. protected _videoTexture: VideoTexture;
  49982. /**
  49983. * Gets the video texture being displayed on the sphere
  49984. */
  49985. readonly videoTexture: VideoTexture;
  49986. /**
  49987. * The skybox material
  49988. */
  49989. protected _material: BackgroundMaterial;
  49990. /**
  49991. * The surface used for the skybox
  49992. */
  49993. protected _mesh: Mesh;
  49994. /**
  49995. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  49996. * Also see the options.resolution property.
  49997. */
  49998. fovMultiplier: number;
  49999. private _videoMode;
  50000. /**
  50001. * Gets or set the current video mode for the video. It can be:
  50002. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  50003. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  50004. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  50005. */
  50006. videoMode: number;
  50007. /**
  50008. * Oberserver used in Stereoscopic VR Mode.
  50009. */
  50010. private _onBeforeCameraRenderObserver;
  50011. /**
  50012. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  50013. * @param name Element's name, child elements will append suffixes for their own names.
  50014. * @param urlsOrVideo defines the url(s) or the video element to use
  50015. * @param options An object containing optional or exposed sub element properties
  50016. */
  50017. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  50018. resolution?: number;
  50019. clickToPlay?: boolean;
  50020. autoPlay?: boolean;
  50021. loop?: boolean;
  50022. size?: number;
  50023. poster?: string;
  50024. faceForward?: boolean;
  50025. useDirectMapping?: boolean;
  50026. }, scene: Scene);
  50027. private _changeVideoMode;
  50028. /**
  50029. * Releases resources associated with this node.
  50030. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  50031. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  50032. */
  50033. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  50034. }
  50035. }
  50036. declare module "babylonjs/Helpers/index" {
  50037. export * from "babylonjs/Helpers/environmentHelper";
  50038. export * from "babylonjs/Helpers/photoDome";
  50039. export * from "babylonjs/Helpers/sceneHelpers";
  50040. export * from "babylonjs/Helpers/videoDome";
  50041. }
  50042. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  50043. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  50044. import { IDisposable } from "babylonjs/scene";
  50045. import { Engine } from "babylonjs/Engines/engine";
  50046. /**
  50047. * This class can be used to get instrumentation data from a Babylon engine
  50048. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  50049. */
  50050. export class EngineInstrumentation implements IDisposable {
  50051. /**
  50052. * Define the instrumented engine.
  50053. */
  50054. engine: Engine;
  50055. private _captureGPUFrameTime;
  50056. private _gpuFrameTimeToken;
  50057. private _gpuFrameTime;
  50058. private _captureShaderCompilationTime;
  50059. private _shaderCompilationTime;
  50060. private _onBeginFrameObserver;
  50061. private _onEndFrameObserver;
  50062. private _onBeforeShaderCompilationObserver;
  50063. private _onAfterShaderCompilationObserver;
  50064. /**
  50065. * Gets the perf counter used for GPU frame time
  50066. */
  50067. readonly gpuFrameTimeCounter: PerfCounter;
  50068. /**
  50069. * Gets the GPU frame time capture status
  50070. */
  50071. /**
  50072. * Enable or disable the GPU frame time capture
  50073. */
  50074. captureGPUFrameTime: boolean;
  50075. /**
  50076. * Gets the perf counter used for shader compilation time
  50077. */
  50078. readonly shaderCompilationTimeCounter: PerfCounter;
  50079. /**
  50080. * Gets the shader compilation time capture status
  50081. */
  50082. /**
  50083. * Enable or disable the shader compilation time capture
  50084. */
  50085. captureShaderCompilationTime: boolean;
  50086. /**
  50087. * Instantiates a new engine instrumentation.
  50088. * This class can be used to get instrumentation data from a Babylon engine
  50089. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  50090. * @param engine Defines the engine to instrument
  50091. */
  50092. constructor(
  50093. /**
  50094. * Define the instrumented engine.
  50095. */
  50096. engine: Engine);
  50097. /**
  50098. * Dispose and release associated resources.
  50099. */
  50100. dispose(): void;
  50101. }
  50102. }
  50103. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  50104. import { Scene, IDisposable } from "babylonjs/scene";
  50105. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  50106. /**
  50107. * This class can be used to get instrumentation data from a Babylon engine
  50108. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  50109. */
  50110. export class SceneInstrumentation implements IDisposable {
  50111. /**
  50112. * Defines the scene to instrument
  50113. */
  50114. scene: Scene;
  50115. private _captureActiveMeshesEvaluationTime;
  50116. private _activeMeshesEvaluationTime;
  50117. private _captureRenderTargetsRenderTime;
  50118. private _renderTargetsRenderTime;
  50119. private _captureFrameTime;
  50120. private _frameTime;
  50121. private _captureRenderTime;
  50122. private _renderTime;
  50123. private _captureInterFrameTime;
  50124. private _interFrameTime;
  50125. private _captureParticlesRenderTime;
  50126. private _particlesRenderTime;
  50127. private _captureSpritesRenderTime;
  50128. private _spritesRenderTime;
  50129. private _capturePhysicsTime;
  50130. private _physicsTime;
  50131. private _captureAnimationsTime;
  50132. private _animationsTime;
  50133. private _captureCameraRenderTime;
  50134. private _cameraRenderTime;
  50135. private _onBeforeActiveMeshesEvaluationObserver;
  50136. private _onAfterActiveMeshesEvaluationObserver;
  50137. private _onBeforeRenderTargetsRenderObserver;
  50138. private _onAfterRenderTargetsRenderObserver;
  50139. private _onAfterRenderObserver;
  50140. private _onBeforeDrawPhaseObserver;
  50141. private _onAfterDrawPhaseObserver;
  50142. private _onBeforeAnimationsObserver;
  50143. private _onBeforeParticlesRenderingObserver;
  50144. private _onAfterParticlesRenderingObserver;
  50145. private _onBeforeSpritesRenderingObserver;
  50146. private _onAfterSpritesRenderingObserver;
  50147. private _onBeforePhysicsObserver;
  50148. private _onAfterPhysicsObserver;
  50149. private _onAfterAnimationsObserver;
  50150. private _onBeforeCameraRenderObserver;
  50151. private _onAfterCameraRenderObserver;
  50152. /**
  50153. * Gets the perf counter used for active meshes evaluation time
  50154. */
  50155. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  50156. /**
  50157. * Gets the active meshes evaluation time capture status
  50158. */
  50159. /**
  50160. * Enable or disable the active meshes evaluation time capture
  50161. */
  50162. captureActiveMeshesEvaluationTime: boolean;
  50163. /**
  50164. * Gets the perf counter used for render targets render time
  50165. */
  50166. readonly renderTargetsRenderTimeCounter: PerfCounter;
  50167. /**
  50168. * Gets the render targets render time capture status
  50169. */
  50170. /**
  50171. * Enable or disable the render targets render time capture
  50172. */
  50173. captureRenderTargetsRenderTime: boolean;
  50174. /**
  50175. * Gets the perf counter used for particles render time
  50176. */
  50177. readonly particlesRenderTimeCounter: PerfCounter;
  50178. /**
  50179. * Gets the particles render time capture status
  50180. */
  50181. /**
  50182. * Enable or disable the particles render time capture
  50183. */
  50184. captureParticlesRenderTime: boolean;
  50185. /**
  50186. * Gets the perf counter used for sprites render time
  50187. */
  50188. readonly spritesRenderTimeCounter: PerfCounter;
  50189. /**
  50190. * Gets the sprites render time capture status
  50191. */
  50192. /**
  50193. * Enable or disable the sprites render time capture
  50194. */
  50195. captureSpritesRenderTime: boolean;
  50196. /**
  50197. * Gets the perf counter used for physics time
  50198. */
  50199. readonly physicsTimeCounter: PerfCounter;
  50200. /**
  50201. * Gets the physics time capture status
  50202. */
  50203. /**
  50204. * Enable or disable the physics time capture
  50205. */
  50206. capturePhysicsTime: boolean;
  50207. /**
  50208. * Gets the perf counter used for animations time
  50209. */
  50210. readonly animationsTimeCounter: PerfCounter;
  50211. /**
  50212. * Gets the animations time capture status
  50213. */
  50214. /**
  50215. * Enable or disable the animations time capture
  50216. */
  50217. captureAnimationsTime: boolean;
  50218. /**
  50219. * Gets the perf counter used for frame time capture
  50220. */
  50221. readonly frameTimeCounter: PerfCounter;
  50222. /**
  50223. * Gets the frame time capture status
  50224. */
  50225. /**
  50226. * Enable or disable the frame time capture
  50227. */
  50228. captureFrameTime: boolean;
  50229. /**
  50230. * Gets the perf counter used for inter-frames time capture
  50231. */
  50232. readonly interFrameTimeCounter: PerfCounter;
  50233. /**
  50234. * Gets the inter-frames time capture status
  50235. */
  50236. /**
  50237. * Enable or disable the inter-frames time capture
  50238. */
  50239. captureInterFrameTime: boolean;
  50240. /**
  50241. * Gets the perf counter used for render time capture
  50242. */
  50243. readonly renderTimeCounter: PerfCounter;
  50244. /**
  50245. * Gets the render time capture status
  50246. */
  50247. /**
  50248. * Enable or disable the render time capture
  50249. */
  50250. captureRenderTime: boolean;
  50251. /**
  50252. * Gets the perf counter used for camera render time capture
  50253. */
  50254. readonly cameraRenderTimeCounter: PerfCounter;
  50255. /**
  50256. * Gets the camera render time capture status
  50257. */
  50258. /**
  50259. * Enable or disable the camera render time capture
  50260. */
  50261. captureCameraRenderTime: boolean;
  50262. /**
  50263. * Gets the perf counter used for draw calls
  50264. */
  50265. readonly drawCallsCounter: PerfCounter;
  50266. /**
  50267. * Instantiates a new scene instrumentation.
  50268. * This class can be used to get instrumentation data from a Babylon engine
  50269. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  50270. * @param scene Defines the scene to instrument
  50271. */
  50272. constructor(
  50273. /**
  50274. * Defines the scene to instrument
  50275. */
  50276. scene: Scene);
  50277. /**
  50278. * Dispose and release associated resources.
  50279. */
  50280. dispose(): void;
  50281. }
  50282. }
  50283. declare module "babylonjs/Instrumentation/index" {
  50284. export * from "babylonjs/Instrumentation/engineInstrumentation";
  50285. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  50286. export * from "babylonjs/Instrumentation/timeToken";
  50287. }
  50288. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  50289. /** @hidden */
  50290. export var glowMapGenerationPixelShader: {
  50291. name: string;
  50292. shader: string;
  50293. };
  50294. }
  50295. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  50296. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  50297. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  50298. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  50299. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  50300. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  50301. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  50302. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  50303. /** @hidden */
  50304. export var glowMapGenerationVertexShader: {
  50305. name: string;
  50306. shader: string;
  50307. };
  50308. }
  50309. declare module "babylonjs/Layers/effectLayer" {
  50310. import { Observable } from "babylonjs/Misc/observable";
  50311. import { Nullable } from "babylonjs/types";
  50312. import { Camera } from "babylonjs/Cameras/camera";
  50313. import { Scene } from "babylonjs/scene";
  50314. import { ISize } from "babylonjs/Maths/math.size";
  50315. import { Color4 } from "babylonjs/Maths/math.color";
  50316. import { Engine } from "babylonjs/Engines/engine";
  50317. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50318. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50319. import { Mesh } from "babylonjs/Meshes/mesh";
  50320. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  50321. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50322. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  50323. import { Effect } from "babylonjs/Materials/effect";
  50324. import { Material } from "babylonjs/Materials/material";
  50325. import "babylonjs/Shaders/glowMapGeneration.fragment";
  50326. import "babylonjs/Shaders/glowMapGeneration.vertex";
  50327. /**
  50328. * Effect layer options. This helps customizing the behaviour
  50329. * of the effect layer.
  50330. */
  50331. export interface IEffectLayerOptions {
  50332. /**
  50333. * Multiplication factor apply to the canvas size to compute the render target size
  50334. * used to generated the objects (the smaller the faster).
  50335. */
  50336. mainTextureRatio: number;
  50337. /**
  50338. * Enforces a fixed size texture to ensure effect stability across devices.
  50339. */
  50340. mainTextureFixedSize?: number;
  50341. /**
  50342. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  50343. */
  50344. alphaBlendingMode: number;
  50345. /**
  50346. * The camera attached to the layer.
  50347. */
  50348. camera: Nullable<Camera>;
  50349. /**
  50350. * The rendering group to draw the layer in.
  50351. */
  50352. renderingGroupId: number;
  50353. }
  50354. /**
  50355. * The effect layer Helps adding post process effect blended with the main pass.
  50356. *
  50357. * This can be for instance use to generate glow or higlight effects on the scene.
  50358. *
  50359. * The effect layer class can not be used directly and is intented to inherited from to be
  50360. * customized per effects.
  50361. */
  50362. export abstract class EffectLayer {
  50363. private _vertexBuffers;
  50364. private _indexBuffer;
  50365. private _cachedDefines;
  50366. private _effectLayerMapGenerationEffect;
  50367. private _effectLayerOptions;
  50368. private _mergeEffect;
  50369. protected _scene: Scene;
  50370. protected _engine: Engine;
  50371. protected _maxSize: number;
  50372. protected _mainTextureDesiredSize: ISize;
  50373. protected _mainTexture: RenderTargetTexture;
  50374. protected _shouldRender: boolean;
  50375. protected _postProcesses: PostProcess[];
  50376. protected _textures: BaseTexture[];
  50377. protected _emissiveTextureAndColor: {
  50378. texture: Nullable<BaseTexture>;
  50379. color: Color4;
  50380. };
  50381. /**
  50382. * The name of the layer
  50383. */
  50384. name: string;
  50385. /**
  50386. * The clear color of the texture used to generate the glow map.
  50387. */
  50388. neutralColor: Color4;
  50389. /**
  50390. * Specifies wether the highlight layer is enabled or not.
  50391. */
  50392. isEnabled: boolean;
  50393. /**
  50394. * Gets the camera attached to the layer.
  50395. */
  50396. readonly camera: Nullable<Camera>;
  50397. /**
  50398. * Gets the rendering group id the layer should render in.
  50399. */
  50400. renderingGroupId: number;
  50401. /**
  50402. * An event triggered when the effect layer has been disposed.
  50403. */
  50404. onDisposeObservable: Observable<EffectLayer>;
  50405. /**
  50406. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  50407. */
  50408. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  50409. /**
  50410. * An event triggered when the generated texture is being merged in the scene.
  50411. */
  50412. onBeforeComposeObservable: Observable<EffectLayer>;
  50413. /**
  50414. * An event triggered when the generated texture has been merged in the scene.
  50415. */
  50416. onAfterComposeObservable: Observable<EffectLayer>;
  50417. /**
  50418. * An event triggered when the efffect layer changes its size.
  50419. */
  50420. onSizeChangedObservable: Observable<EffectLayer>;
  50421. /** @hidden */
  50422. static _SceneComponentInitialization: (scene: Scene) => void;
  50423. /**
  50424. * Instantiates a new effect Layer and references it in the scene.
  50425. * @param name The name of the layer
  50426. * @param scene The scene to use the layer in
  50427. */
  50428. constructor(
  50429. /** The Friendly of the effect in the scene */
  50430. name: string, scene: Scene);
  50431. /**
  50432. * Get the effect name of the layer.
  50433. * @return The effect name
  50434. */
  50435. abstract getEffectName(): string;
  50436. /**
  50437. * Checks for the readiness of the element composing the layer.
  50438. * @param subMesh the mesh to check for
  50439. * @param useInstances specify wether or not to use instances to render the mesh
  50440. * @return true if ready otherwise, false
  50441. */
  50442. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  50443. /**
  50444. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  50445. * @returns true if the effect requires stencil during the main canvas render pass.
  50446. */
  50447. abstract needStencil(): boolean;
  50448. /**
  50449. * Create the merge effect. This is the shader use to blit the information back
  50450. * to the main canvas at the end of the scene rendering.
  50451. * @returns The effect containing the shader used to merge the effect on the main canvas
  50452. */
  50453. protected abstract _createMergeEffect(): Effect;
  50454. /**
  50455. * Creates the render target textures and post processes used in the effect layer.
  50456. */
  50457. protected abstract _createTextureAndPostProcesses(): void;
  50458. /**
  50459. * Implementation specific of rendering the generating effect on the main canvas.
  50460. * @param effect The effect used to render through
  50461. */
  50462. protected abstract _internalRender(effect: Effect): void;
  50463. /**
  50464. * Sets the required values for both the emissive texture and and the main color.
  50465. */
  50466. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  50467. /**
  50468. * Free any resources and references associated to a mesh.
  50469. * Internal use
  50470. * @param mesh The mesh to free.
  50471. */
  50472. abstract _disposeMesh(mesh: Mesh): void;
  50473. /**
  50474. * Serializes this layer (Glow or Highlight for example)
  50475. * @returns a serialized layer object
  50476. */
  50477. abstract serialize?(): any;
  50478. /**
  50479. * Initializes the effect layer with the required options.
  50480. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  50481. */
  50482. protected _init(options: Partial<IEffectLayerOptions>): void;
  50483. /**
  50484. * Generates the index buffer of the full screen quad blending to the main canvas.
  50485. */
  50486. private _generateIndexBuffer;
  50487. /**
  50488. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  50489. */
  50490. private _generateVertexBuffer;
  50491. /**
  50492. * Sets the main texture desired size which is the closest power of two
  50493. * of the engine canvas size.
  50494. */
  50495. private _setMainTextureSize;
  50496. /**
  50497. * Creates the main texture for the effect layer.
  50498. */
  50499. protected _createMainTexture(): void;
  50500. /**
  50501. * Adds specific effects defines.
  50502. * @param defines The defines to add specifics to.
  50503. */
  50504. protected _addCustomEffectDefines(defines: string[]): void;
  50505. /**
  50506. * Checks for the readiness of the element composing the layer.
  50507. * @param subMesh the mesh to check for
  50508. * @param useInstances specify wether or not to use instances to render the mesh
  50509. * @param emissiveTexture the associated emissive texture used to generate the glow
  50510. * @return true if ready otherwise, false
  50511. */
  50512. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  50513. /**
  50514. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  50515. */
  50516. render(): void;
  50517. /**
  50518. * Determine if a given mesh will be used in the current effect.
  50519. * @param mesh mesh to test
  50520. * @returns true if the mesh will be used
  50521. */
  50522. hasMesh(mesh: AbstractMesh): boolean;
  50523. /**
  50524. * Returns true if the layer contains information to display, otherwise false.
  50525. * @returns true if the glow layer should be rendered
  50526. */
  50527. shouldRender(): boolean;
  50528. /**
  50529. * Returns true if the mesh should render, otherwise false.
  50530. * @param mesh The mesh to render
  50531. * @returns true if it should render otherwise false
  50532. */
  50533. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  50534. /**
  50535. * Returns true if the mesh can be rendered, otherwise false.
  50536. * @param mesh The mesh to render
  50537. * @param material The material used on the mesh
  50538. * @returns true if it can be rendered otherwise false
  50539. */
  50540. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  50541. /**
  50542. * Returns true if the mesh should render, otherwise false.
  50543. * @param mesh The mesh to render
  50544. * @returns true if it should render otherwise false
  50545. */
  50546. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  50547. /**
  50548. * Renders the submesh passed in parameter to the generation map.
  50549. */
  50550. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  50551. /**
  50552. * Rebuild the required buffers.
  50553. * @hidden Internal use only.
  50554. */
  50555. _rebuild(): void;
  50556. /**
  50557. * Dispose only the render target textures and post process.
  50558. */
  50559. private _disposeTextureAndPostProcesses;
  50560. /**
  50561. * Dispose the highlight layer and free resources.
  50562. */
  50563. dispose(): void;
  50564. /**
  50565. * Gets the class name of the effect layer
  50566. * @returns the string with the class name of the effect layer
  50567. */
  50568. getClassName(): string;
  50569. /**
  50570. * Creates an effect layer from parsed effect layer data
  50571. * @param parsedEffectLayer defines effect layer data
  50572. * @param scene defines the current scene
  50573. * @param rootUrl defines the root URL containing the effect layer information
  50574. * @returns a parsed effect Layer
  50575. */
  50576. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  50577. }
  50578. }
  50579. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  50580. import { Scene } from "babylonjs/scene";
  50581. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  50582. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  50583. import { AbstractScene } from "babylonjs/abstractScene";
  50584. module "babylonjs/abstractScene" {
  50585. interface AbstractScene {
  50586. /**
  50587. * The list of effect layers (highlights/glow) added to the scene
  50588. * @see http://doc.babylonjs.com/how_to/highlight_layer
  50589. * @see http://doc.babylonjs.com/how_to/glow_layer
  50590. */
  50591. effectLayers: Array<EffectLayer>;
  50592. /**
  50593. * Removes the given effect layer from this scene.
  50594. * @param toRemove defines the effect layer to remove
  50595. * @returns the index of the removed effect layer
  50596. */
  50597. removeEffectLayer(toRemove: EffectLayer): number;
  50598. /**
  50599. * Adds the given effect layer to this scene
  50600. * @param newEffectLayer defines the effect layer to add
  50601. */
  50602. addEffectLayer(newEffectLayer: EffectLayer): void;
  50603. }
  50604. }
  50605. /**
  50606. * Defines the layer scene component responsible to manage any effect layers
  50607. * in a given scene.
  50608. */
  50609. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  50610. /**
  50611. * The component name helpfull to identify the component in the list of scene components.
  50612. */
  50613. readonly name: string;
  50614. /**
  50615. * The scene the component belongs to.
  50616. */
  50617. scene: Scene;
  50618. private _engine;
  50619. private _renderEffects;
  50620. private _needStencil;
  50621. private _previousStencilState;
  50622. /**
  50623. * Creates a new instance of the component for the given scene
  50624. * @param scene Defines the scene to register the component in
  50625. */
  50626. constructor(scene: Scene);
  50627. /**
  50628. * Registers the component in a given scene
  50629. */
  50630. register(): void;
  50631. /**
  50632. * Rebuilds the elements related to this component in case of
  50633. * context lost for instance.
  50634. */
  50635. rebuild(): void;
  50636. /**
  50637. * Serializes the component data to the specified json object
  50638. * @param serializationObject The object to serialize to
  50639. */
  50640. serialize(serializationObject: any): void;
  50641. /**
  50642. * Adds all the elements from the container to the scene
  50643. * @param container the container holding the elements
  50644. */
  50645. addFromContainer(container: AbstractScene): void;
  50646. /**
  50647. * Removes all the elements in the container from the scene
  50648. * @param container contains the elements to remove
  50649. * @param dispose if the removed element should be disposed (default: false)
  50650. */
  50651. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  50652. /**
  50653. * Disposes the component and the associated ressources.
  50654. */
  50655. dispose(): void;
  50656. private _isReadyForMesh;
  50657. private _renderMainTexture;
  50658. private _setStencil;
  50659. private _setStencilBack;
  50660. private _draw;
  50661. private _drawCamera;
  50662. private _drawRenderingGroup;
  50663. }
  50664. }
  50665. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  50666. /** @hidden */
  50667. export var glowMapMergePixelShader: {
  50668. name: string;
  50669. shader: string;
  50670. };
  50671. }
  50672. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  50673. /** @hidden */
  50674. export var glowMapMergeVertexShader: {
  50675. name: string;
  50676. shader: string;
  50677. };
  50678. }
  50679. declare module "babylonjs/Layers/glowLayer" {
  50680. import { Nullable } from "babylonjs/types";
  50681. import { Camera } from "babylonjs/Cameras/camera";
  50682. import { Scene } from "babylonjs/scene";
  50683. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50684. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50685. import { Mesh } from "babylonjs/Meshes/mesh";
  50686. import { Texture } from "babylonjs/Materials/Textures/texture";
  50687. import { Effect } from "babylonjs/Materials/effect";
  50688. import { Material } from "babylonjs/Materials/material";
  50689. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  50690. import { Color4 } from "babylonjs/Maths/math.color";
  50691. import "babylonjs/Shaders/glowMapMerge.fragment";
  50692. import "babylonjs/Shaders/glowMapMerge.vertex";
  50693. import "babylonjs/Layers/effectLayerSceneComponent";
  50694. module "babylonjs/abstractScene" {
  50695. interface AbstractScene {
  50696. /**
  50697. * Return a the first highlight layer of the scene with a given name.
  50698. * @param name The name of the highlight layer to look for.
  50699. * @return The highlight layer if found otherwise null.
  50700. */
  50701. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  50702. }
  50703. }
  50704. /**
  50705. * Glow layer options. This helps customizing the behaviour
  50706. * of the glow layer.
  50707. */
  50708. export interface IGlowLayerOptions {
  50709. /**
  50710. * Multiplication factor apply to the canvas size to compute the render target size
  50711. * used to generated the glowing objects (the smaller the faster).
  50712. */
  50713. mainTextureRatio: number;
  50714. /**
  50715. * Enforces a fixed size texture to ensure resize independant blur.
  50716. */
  50717. mainTextureFixedSize?: number;
  50718. /**
  50719. * How big is the kernel of the blur texture.
  50720. */
  50721. blurKernelSize: number;
  50722. /**
  50723. * The camera attached to the layer.
  50724. */
  50725. camera: Nullable<Camera>;
  50726. /**
  50727. * Enable MSAA by chosing the number of samples.
  50728. */
  50729. mainTextureSamples?: number;
  50730. /**
  50731. * The rendering group to draw the layer in.
  50732. */
  50733. renderingGroupId: number;
  50734. }
  50735. /**
  50736. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  50737. *
  50738. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  50739. * glowy meshes to your scene.
  50740. *
  50741. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  50742. */
  50743. export class GlowLayer extends EffectLayer {
  50744. /**
  50745. * Effect Name of the layer.
  50746. */
  50747. static readonly EffectName: string;
  50748. /**
  50749. * The default blur kernel size used for the glow.
  50750. */
  50751. static DefaultBlurKernelSize: number;
  50752. /**
  50753. * The default texture size ratio used for the glow.
  50754. */
  50755. static DefaultTextureRatio: number;
  50756. /**
  50757. * Sets the kernel size of the blur.
  50758. */
  50759. /**
  50760. * Gets the kernel size of the blur.
  50761. */
  50762. blurKernelSize: number;
  50763. /**
  50764. * Sets the glow intensity.
  50765. */
  50766. /**
  50767. * Gets the glow intensity.
  50768. */
  50769. intensity: number;
  50770. private _options;
  50771. private _intensity;
  50772. private _horizontalBlurPostprocess1;
  50773. private _verticalBlurPostprocess1;
  50774. private _horizontalBlurPostprocess2;
  50775. private _verticalBlurPostprocess2;
  50776. private _blurTexture1;
  50777. private _blurTexture2;
  50778. private _postProcesses1;
  50779. private _postProcesses2;
  50780. private _includedOnlyMeshes;
  50781. private _excludedMeshes;
  50782. /**
  50783. * Callback used to let the user override the color selection on a per mesh basis
  50784. */
  50785. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  50786. /**
  50787. * Callback used to let the user override the texture selection on a per mesh basis
  50788. */
  50789. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  50790. /**
  50791. * Instantiates a new glow Layer and references it to the scene.
  50792. * @param name The name of the layer
  50793. * @param scene The scene to use the layer in
  50794. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  50795. */
  50796. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  50797. /**
  50798. * Get the effect name of the layer.
  50799. * @return The effect name
  50800. */
  50801. getEffectName(): string;
  50802. /**
  50803. * Create the merge effect. This is the shader use to blit the information back
  50804. * to the main canvas at the end of the scene rendering.
  50805. */
  50806. protected _createMergeEffect(): Effect;
  50807. /**
  50808. * Creates the render target textures and post processes used in the glow layer.
  50809. */
  50810. protected _createTextureAndPostProcesses(): void;
  50811. /**
  50812. * Checks for the readiness of the element composing the layer.
  50813. * @param subMesh the mesh to check for
  50814. * @param useInstances specify wether or not to use instances to render the mesh
  50815. * @param emissiveTexture the associated emissive texture used to generate the glow
  50816. * @return true if ready otherwise, false
  50817. */
  50818. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  50819. /**
  50820. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  50821. */
  50822. needStencil(): boolean;
  50823. /**
  50824. * Returns true if the mesh can be rendered, otherwise false.
  50825. * @param mesh The mesh to render
  50826. * @param material The material used on the mesh
  50827. * @returns true if it can be rendered otherwise false
  50828. */
  50829. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  50830. /**
  50831. * Implementation specific of rendering the generating effect on the main canvas.
  50832. * @param effect The effect used to render through
  50833. */
  50834. protected _internalRender(effect: Effect): void;
  50835. /**
  50836. * Sets the required values for both the emissive texture and and the main color.
  50837. */
  50838. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  50839. /**
  50840. * Returns true if the mesh should render, otherwise false.
  50841. * @param mesh The mesh to render
  50842. * @returns true if it should render otherwise false
  50843. */
  50844. protected _shouldRenderMesh(mesh: Mesh): boolean;
  50845. /**
  50846. * Adds specific effects defines.
  50847. * @param defines The defines to add specifics to.
  50848. */
  50849. protected _addCustomEffectDefines(defines: string[]): void;
  50850. /**
  50851. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  50852. * @param mesh The mesh to exclude from the glow layer
  50853. */
  50854. addExcludedMesh(mesh: Mesh): void;
  50855. /**
  50856. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  50857. * @param mesh The mesh to remove
  50858. */
  50859. removeExcludedMesh(mesh: Mesh): void;
  50860. /**
  50861. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  50862. * @param mesh The mesh to include in the glow layer
  50863. */
  50864. addIncludedOnlyMesh(mesh: Mesh): void;
  50865. /**
  50866. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  50867. * @param mesh The mesh to remove
  50868. */
  50869. removeIncludedOnlyMesh(mesh: Mesh): void;
  50870. /**
  50871. * Determine if a given mesh will be used in the glow layer
  50872. * @param mesh The mesh to test
  50873. * @returns true if the mesh will be highlighted by the current glow layer
  50874. */
  50875. hasMesh(mesh: AbstractMesh): boolean;
  50876. /**
  50877. * Free any resources and references associated to a mesh.
  50878. * Internal use
  50879. * @param mesh The mesh to free.
  50880. * @hidden
  50881. */
  50882. _disposeMesh(mesh: Mesh): void;
  50883. /**
  50884. * Gets the class name of the effect layer
  50885. * @returns the string with the class name of the effect layer
  50886. */
  50887. getClassName(): string;
  50888. /**
  50889. * Serializes this glow layer
  50890. * @returns a serialized glow layer object
  50891. */
  50892. serialize(): any;
  50893. /**
  50894. * Creates a Glow Layer from parsed glow layer data
  50895. * @param parsedGlowLayer defines glow layer data
  50896. * @param scene defines the current scene
  50897. * @param rootUrl defines the root URL containing the glow layer information
  50898. * @returns a parsed Glow Layer
  50899. */
  50900. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  50901. }
  50902. }
  50903. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  50904. /** @hidden */
  50905. export var glowBlurPostProcessPixelShader: {
  50906. name: string;
  50907. shader: string;
  50908. };
  50909. }
  50910. declare module "babylonjs/Layers/highlightLayer" {
  50911. import { Observable } from "babylonjs/Misc/observable";
  50912. import { Nullable } from "babylonjs/types";
  50913. import { Camera } from "babylonjs/Cameras/camera";
  50914. import { Scene } from "babylonjs/scene";
  50915. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50916. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50917. import { Mesh } from "babylonjs/Meshes/mesh";
  50918. import { Effect } from "babylonjs/Materials/effect";
  50919. import { Material } from "babylonjs/Materials/material";
  50920. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  50921. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  50922. import "babylonjs/Shaders/glowMapMerge.fragment";
  50923. import "babylonjs/Shaders/glowMapMerge.vertex";
  50924. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  50925. module "babylonjs/abstractScene" {
  50926. interface AbstractScene {
  50927. /**
  50928. * Return a the first highlight layer of the scene with a given name.
  50929. * @param name The name of the highlight layer to look for.
  50930. * @return The highlight layer if found otherwise null.
  50931. */
  50932. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  50933. }
  50934. }
  50935. /**
  50936. * Highlight layer options. This helps customizing the behaviour
  50937. * of the highlight layer.
  50938. */
  50939. export interface IHighlightLayerOptions {
  50940. /**
  50941. * Multiplication factor apply to the canvas size to compute the render target size
  50942. * used to generated the glowing objects (the smaller the faster).
  50943. */
  50944. mainTextureRatio: number;
  50945. /**
  50946. * Enforces a fixed size texture to ensure resize independant blur.
  50947. */
  50948. mainTextureFixedSize?: number;
  50949. /**
  50950. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  50951. * of the picture to blur (the smaller the faster).
  50952. */
  50953. blurTextureSizeRatio: number;
  50954. /**
  50955. * How big in texel of the blur texture is the vertical blur.
  50956. */
  50957. blurVerticalSize: number;
  50958. /**
  50959. * How big in texel of the blur texture is the horizontal blur.
  50960. */
  50961. blurHorizontalSize: number;
  50962. /**
  50963. * Alpha blending mode used to apply the blur. Default is combine.
  50964. */
  50965. alphaBlendingMode: number;
  50966. /**
  50967. * The camera attached to the layer.
  50968. */
  50969. camera: Nullable<Camera>;
  50970. /**
  50971. * Should we display highlight as a solid stroke?
  50972. */
  50973. isStroke?: boolean;
  50974. /**
  50975. * The rendering group to draw the layer in.
  50976. */
  50977. renderingGroupId: number;
  50978. }
  50979. /**
  50980. * The highlight layer Helps adding a glow effect around a mesh.
  50981. *
  50982. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  50983. * glowy meshes to your scene.
  50984. *
  50985. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  50986. */
  50987. export class HighlightLayer extends EffectLayer {
  50988. name: string;
  50989. /**
  50990. * Effect Name of the highlight layer.
  50991. */
  50992. static readonly EffectName: string;
  50993. /**
  50994. * The neutral color used during the preparation of the glow effect.
  50995. * This is black by default as the blend operation is a blend operation.
  50996. */
  50997. static NeutralColor: Color4;
  50998. /**
  50999. * Stencil value used for glowing meshes.
  51000. */
  51001. static GlowingMeshStencilReference: number;
  51002. /**
  51003. * Stencil value used for the other meshes in the scene.
  51004. */
  51005. static NormalMeshStencilReference: number;
  51006. /**
  51007. * Specifies whether or not the inner glow is ACTIVE in the layer.
  51008. */
  51009. innerGlow: boolean;
  51010. /**
  51011. * Specifies whether or not the outer glow is ACTIVE in the layer.
  51012. */
  51013. outerGlow: boolean;
  51014. /**
  51015. * Specifies the horizontal size of the blur.
  51016. */
  51017. /**
  51018. * Gets the horizontal size of the blur.
  51019. */
  51020. blurHorizontalSize: number;
  51021. /**
  51022. * Specifies the vertical size of the blur.
  51023. */
  51024. /**
  51025. * Gets the vertical size of the blur.
  51026. */
  51027. blurVerticalSize: number;
  51028. /**
  51029. * An event triggered when the highlight layer is being blurred.
  51030. */
  51031. onBeforeBlurObservable: Observable<HighlightLayer>;
  51032. /**
  51033. * An event triggered when the highlight layer has been blurred.
  51034. */
  51035. onAfterBlurObservable: Observable<HighlightLayer>;
  51036. private _instanceGlowingMeshStencilReference;
  51037. private _options;
  51038. private _downSamplePostprocess;
  51039. private _horizontalBlurPostprocess;
  51040. private _verticalBlurPostprocess;
  51041. private _blurTexture;
  51042. private _meshes;
  51043. private _excludedMeshes;
  51044. /**
  51045. * Instantiates a new highlight Layer and references it to the scene..
  51046. * @param name The name of the layer
  51047. * @param scene The scene to use the layer in
  51048. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  51049. */
  51050. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  51051. /**
  51052. * Get the effect name of the layer.
  51053. * @return The effect name
  51054. */
  51055. getEffectName(): string;
  51056. /**
  51057. * Create the merge effect. This is the shader use to blit the information back
  51058. * to the main canvas at the end of the scene rendering.
  51059. */
  51060. protected _createMergeEffect(): Effect;
  51061. /**
  51062. * Creates the render target textures and post processes used in the highlight layer.
  51063. */
  51064. protected _createTextureAndPostProcesses(): void;
  51065. /**
  51066. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  51067. */
  51068. needStencil(): boolean;
  51069. /**
  51070. * Checks for the readiness of the element composing the layer.
  51071. * @param subMesh the mesh to check for
  51072. * @param useInstances specify wether or not to use instances to render the mesh
  51073. * @param emissiveTexture the associated emissive texture used to generate the glow
  51074. * @return true if ready otherwise, false
  51075. */
  51076. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  51077. /**
  51078. * Implementation specific of rendering the generating effect on the main canvas.
  51079. * @param effect The effect used to render through
  51080. */
  51081. protected _internalRender(effect: Effect): void;
  51082. /**
  51083. * Returns true if the layer contains information to display, otherwise false.
  51084. */
  51085. shouldRender(): boolean;
  51086. /**
  51087. * Returns true if the mesh should render, otherwise false.
  51088. * @param mesh The mesh to render
  51089. * @returns true if it should render otherwise false
  51090. */
  51091. protected _shouldRenderMesh(mesh: Mesh): boolean;
  51092. /**
  51093. * Sets the required values for both the emissive texture and and the main color.
  51094. */
  51095. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  51096. /**
  51097. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  51098. * @param mesh The mesh to exclude from the highlight layer
  51099. */
  51100. addExcludedMesh(mesh: Mesh): void;
  51101. /**
  51102. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  51103. * @param mesh The mesh to highlight
  51104. */
  51105. removeExcludedMesh(mesh: Mesh): void;
  51106. /**
  51107. * Determine if a given mesh will be highlighted by the current HighlightLayer
  51108. * @param mesh mesh to test
  51109. * @returns true if the mesh will be highlighted by the current HighlightLayer
  51110. */
  51111. hasMesh(mesh: AbstractMesh): boolean;
  51112. /**
  51113. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  51114. * @param mesh The mesh to highlight
  51115. * @param color The color of the highlight
  51116. * @param glowEmissiveOnly Extract the glow from the emissive texture
  51117. */
  51118. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  51119. /**
  51120. * Remove a mesh from the highlight layer in order to make it stop glowing.
  51121. * @param mesh The mesh to highlight
  51122. */
  51123. removeMesh(mesh: Mesh): void;
  51124. /**
  51125. * Force the stencil to the normal expected value for none glowing parts
  51126. */
  51127. private _defaultStencilReference;
  51128. /**
  51129. * Free any resources and references associated to a mesh.
  51130. * Internal use
  51131. * @param mesh The mesh to free.
  51132. * @hidden
  51133. */
  51134. _disposeMesh(mesh: Mesh): void;
  51135. /**
  51136. * Dispose the highlight layer and free resources.
  51137. */
  51138. dispose(): void;
  51139. /**
  51140. * Gets the class name of the effect layer
  51141. * @returns the string with the class name of the effect layer
  51142. */
  51143. getClassName(): string;
  51144. /**
  51145. * Serializes this Highlight layer
  51146. * @returns a serialized Highlight layer object
  51147. */
  51148. serialize(): any;
  51149. /**
  51150. * Creates a Highlight layer from parsed Highlight layer data
  51151. * @param parsedHightlightLayer defines the Highlight layer data
  51152. * @param scene defines the current scene
  51153. * @param rootUrl defines the root URL containing the Highlight layer information
  51154. * @returns a parsed Highlight layer
  51155. */
  51156. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  51157. }
  51158. }
  51159. declare module "babylonjs/Layers/layerSceneComponent" {
  51160. import { Scene } from "babylonjs/scene";
  51161. import { ISceneComponent } from "babylonjs/sceneComponent";
  51162. import { Layer } from "babylonjs/Layers/layer";
  51163. import { AbstractScene } from "babylonjs/abstractScene";
  51164. module "babylonjs/abstractScene" {
  51165. interface AbstractScene {
  51166. /**
  51167. * The list of layers (background and foreground) of the scene
  51168. */
  51169. layers: Array<Layer>;
  51170. }
  51171. }
  51172. /**
  51173. * Defines the layer scene component responsible to manage any layers
  51174. * in a given scene.
  51175. */
  51176. export class LayerSceneComponent implements ISceneComponent {
  51177. /**
  51178. * The component name helpfull to identify the component in the list of scene components.
  51179. */
  51180. readonly name: string;
  51181. /**
  51182. * The scene the component belongs to.
  51183. */
  51184. scene: Scene;
  51185. private _engine;
  51186. /**
  51187. * Creates a new instance of the component for the given scene
  51188. * @param scene Defines the scene to register the component in
  51189. */
  51190. constructor(scene: Scene);
  51191. /**
  51192. * Registers the component in a given scene
  51193. */
  51194. register(): void;
  51195. /**
  51196. * Rebuilds the elements related to this component in case of
  51197. * context lost for instance.
  51198. */
  51199. rebuild(): void;
  51200. /**
  51201. * Disposes the component and the associated ressources.
  51202. */
  51203. dispose(): void;
  51204. private _draw;
  51205. private _drawCameraPredicate;
  51206. private _drawCameraBackground;
  51207. private _drawCameraForeground;
  51208. private _drawRenderTargetPredicate;
  51209. private _drawRenderTargetBackground;
  51210. private _drawRenderTargetForeground;
  51211. /**
  51212. * Adds all the elements from the container to the scene
  51213. * @param container the container holding the elements
  51214. */
  51215. addFromContainer(container: AbstractScene): void;
  51216. /**
  51217. * Removes all the elements in the container from the scene
  51218. * @param container contains the elements to remove
  51219. * @param dispose if the removed element should be disposed (default: false)
  51220. */
  51221. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  51222. }
  51223. }
  51224. declare module "babylonjs/Shaders/layer.fragment" {
  51225. /** @hidden */
  51226. export var layerPixelShader: {
  51227. name: string;
  51228. shader: string;
  51229. };
  51230. }
  51231. declare module "babylonjs/Shaders/layer.vertex" {
  51232. /** @hidden */
  51233. export var layerVertexShader: {
  51234. name: string;
  51235. shader: string;
  51236. };
  51237. }
  51238. declare module "babylonjs/Layers/layer" {
  51239. import { Observable } from "babylonjs/Misc/observable";
  51240. import { Nullable } from "babylonjs/types";
  51241. import { Scene } from "babylonjs/scene";
  51242. import { Vector2 } from "babylonjs/Maths/math.vector";
  51243. import { Color4 } from "babylonjs/Maths/math.color";
  51244. import { Texture } from "babylonjs/Materials/Textures/texture";
  51245. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  51246. import "babylonjs/Shaders/layer.fragment";
  51247. import "babylonjs/Shaders/layer.vertex";
  51248. /**
  51249. * This represents a full screen 2d layer.
  51250. * This can be useful to display a picture in the background of your scene for instance.
  51251. * @see https://www.babylonjs-playground.com/#08A2BS#1
  51252. */
  51253. export class Layer {
  51254. /**
  51255. * Define the name of the layer.
  51256. */
  51257. name: string;
  51258. /**
  51259. * Define the texture the layer should display.
  51260. */
  51261. texture: Nullable<Texture>;
  51262. /**
  51263. * Is the layer in background or foreground.
  51264. */
  51265. isBackground: boolean;
  51266. /**
  51267. * Define the color of the layer (instead of texture).
  51268. */
  51269. color: Color4;
  51270. /**
  51271. * Define the scale of the layer in order to zoom in out of the texture.
  51272. */
  51273. scale: Vector2;
  51274. /**
  51275. * Define an offset for the layer in order to shift the texture.
  51276. */
  51277. offset: Vector2;
  51278. /**
  51279. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  51280. */
  51281. alphaBlendingMode: number;
  51282. /**
  51283. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  51284. * Alpha test will not mix with the background color in case of transparency.
  51285. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  51286. */
  51287. alphaTest: boolean;
  51288. /**
  51289. * Define a mask to restrict the layer to only some of the scene cameras.
  51290. */
  51291. layerMask: number;
  51292. /**
  51293. * Define the list of render target the layer is visible into.
  51294. */
  51295. renderTargetTextures: RenderTargetTexture[];
  51296. /**
  51297. * Define if the layer is only used in renderTarget or if it also
  51298. * renders in the main frame buffer of the canvas.
  51299. */
  51300. renderOnlyInRenderTargetTextures: boolean;
  51301. private _scene;
  51302. private _vertexBuffers;
  51303. private _indexBuffer;
  51304. private _effect;
  51305. private _alphaTestEffect;
  51306. /**
  51307. * An event triggered when the layer is disposed.
  51308. */
  51309. onDisposeObservable: Observable<Layer>;
  51310. private _onDisposeObserver;
  51311. /**
  51312. * Back compatibility with callback before the onDisposeObservable existed.
  51313. * The set callback will be triggered when the layer has been disposed.
  51314. */
  51315. onDispose: () => void;
  51316. /**
  51317. * An event triggered before rendering the scene
  51318. */
  51319. onBeforeRenderObservable: Observable<Layer>;
  51320. private _onBeforeRenderObserver;
  51321. /**
  51322. * Back compatibility with callback before the onBeforeRenderObservable existed.
  51323. * The set callback will be triggered just before rendering the layer.
  51324. */
  51325. onBeforeRender: () => void;
  51326. /**
  51327. * An event triggered after rendering the scene
  51328. */
  51329. onAfterRenderObservable: Observable<Layer>;
  51330. private _onAfterRenderObserver;
  51331. /**
  51332. * Back compatibility with callback before the onAfterRenderObservable existed.
  51333. * The set callback will be triggered just after rendering the layer.
  51334. */
  51335. onAfterRender: () => void;
  51336. /**
  51337. * Instantiates a new layer.
  51338. * This represents a full screen 2d layer.
  51339. * This can be useful to display a picture in the background of your scene for instance.
  51340. * @see https://www.babylonjs-playground.com/#08A2BS#1
  51341. * @param name Define the name of the layer in the scene
  51342. * @param imgUrl Define the url of the texture to display in the layer
  51343. * @param scene Define the scene the layer belongs to
  51344. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  51345. * @param color Defines a color for the layer
  51346. */
  51347. constructor(
  51348. /**
  51349. * Define the name of the layer.
  51350. */
  51351. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  51352. private _createIndexBuffer;
  51353. /** @hidden */
  51354. _rebuild(): void;
  51355. /**
  51356. * Renders the layer in the scene.
  51357. */
  51358. render(): void;
  51359. /**
  51360. * Disposes and releases the associated ressources.
  51361. */
  51362. dispose(): void;
  51363. }
  51364. }
  51365. declare module "babylonjs/Layers/index" {
  51366. export * from "babylonjs/Layers/effectLayer";
  51367. export * from "babylonjs/Layers/effectLayerSceneComponent";
  51368. export * from "babylonjs/Layers/glowLayer";
  51369. export * from "babylonjs/Layers/highlightLayer";
  51370. export * from "babylonjs/Layers/layer";
  51371. export * from "babylonjs/Layers/layerSceneComponent";
  51372. }
  51373. declare module "babylonjs/Shaders/lensFlare.fragment" {
  51374. /** @hidden */
  51375. export var lensFlarePixelShader: {
  51376. name: string;
  51377. shader: string;
  51378. };
  51379. }
  51380. declare module "babylonjs/Shaders/lensFlare.vertex" {
  51381. /** @hidden */
  51382. export var lensFlareVertexShader: {
  51383. name: string;
  51384. shader: string;
  51385. };
  51386. }
  51387. declare module "babylonjs/LensFlares/lensFlareSystem" {
  51388. import { Scene } from "babylonjs/scene";
  51389. import { Vector3 } from "babylonjs/Maths/math.vector";
  51390. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51391. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  51392. import "babylonjs/Shaders/lensFlare.fragment";
  51393. import "babylonjs/Shaders/lensFlare.vertex";
  51394. import { Viewport } from "babylonjs/Maths/math.viewport";
  51395. /**
  51396. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  51397. * It is usually composed of several `lensFlare`.
  51398. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51399. */
  51400. export class LensFlareSystem {
  51401. /**
  51402. * Define the name of the lens flare system
  51403. */
  51404. name: string;
  51405. /**
  51406. * List of lens flares used in this system.
  51407. */
  51408. lensFlares: LensFlare[];
  51409. /**
  51410. * Define a limit from the border the lens flare can be visible.
  51411. */
  51412. borderLimit: number;
  51413. /**
  51414. * Define a viewport border we do not want to see the lens flare in.
  51415. */
  51416. viewportBorder: number;
  51417. /**
  51418. * Define a predicate which could limit the list of meshes able to occlude the effect.
  51419. */
  51420. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51421. /**
  51422. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  51423. */
  51424. layerMask: number;
  51425. /**
  51426. * Define the id of the lens flare system in the scene.
  51427. * (equal to name by default)
  51428. */
  51429. id: string;
  51430. private _scene;
  51431. private _emitter;
  51432. private _vertexBuffers;
  51433. private _indexBuffer;
  51434. private _effect;
  51435. private _positionX;
  51436. private _positionY;
  51437. private _isEnabled;
  51438. /** @hidden */
  51439. static _SceneComponentInitialization: (scene: Scene) => void;
  51440. /**
  51441. * Instantiates a lens flare system.
  51442. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  51443. * It is usually composed of several `lensFlare`.
  51444. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51445. * @param name Define the name of the lens flare system in the scene
  51446. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  51447. * @param scene Define the scene the lens flare system belongs to
  51448. */
  51449. constructor(
  51450. /**
  51451. * Define the name of the lens flare system
  51452. */
  51453. name: string, emitter: any, scene: Scene);
  51454. /**
  51455. * Define if the lens flare system is enabled.
  51456. */
  51457. isEnabled: boolean;
  51458. /**
  51459. * Get the scene the effects belongs to.
  51460. * @returns the scene holding the lens flare system
  51461. */
  51462. getScene(): Scene;
  51463. /**
  51464. * Get the emitter of the lens flare system.
  51465. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  51466. * @returns the emitter of the lens flare system
  51467. */
  51468. getEmitter(): any;
  51469. /**
  51470. * Set the emitter of the lens flare system.
  51471. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  51472. * @param newEmitter Define the new emitter of the system
  51473. */
  51474. setEmitter(newEmitter: any): void;
  51475. /**
  51476. * Get the lens flare system emitter position.
  51477. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  51478. * @returns the position
  51479. */
  51480. getEmitterPosition(): Vector3;
  51481. /**
  51482. * @hidden
  51483. */
  51484. computeEffectivePosition(globalViewport: Viewport): boolean;
  51485. /** @hidden */
  51486. _isVisible(): boolean;
  51487. /**
  51488. * @hidden
  51489. */
  51490. render(): boolean;
  51491. /**
  51492. * Dispose and release the lens flare with its associated resources.
  51493. */
  51494. dispose(): void;
  51495. /**
  51496. * Parse a lens flare system from a JSON repressentation
  51497. * @param parsedLensFlareSystem Define the JSON to parse
  51498. * @param scene Define the scene the parsed system should be instantiated in
  51499. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  51500. * @returns the parsed system
  51501. */
  51502. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  51503. /**
  51504. * Serialize the current Lens Flare System into a JSON representation.
  51505. * @returns the serialized JSON
  51506. */
  51507. serialize(): any;
  51508. }
  51509. }
  51510. declare module "babylonjs/LensFlares/lensFlare" {
  51511. import { Nullable } from "babylonjs/types";
  51512. import { Color3 } from "babylonjs/Maths/math.color";
  51513. import { Texture } from "babylonjs/Materials/Textures/texture";
  51514. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  51515. /**
  51516. * This represents one of the lens effect in a `lensFlareSystem`.
  51517. * It controls one of the indiviual texture used in the effect.
  51518. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51519. */
  51520. export class LensFlare {
  51521. /**
  51522. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  51523. */
  51524. size: number;
  51525. /**
  51526. * 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.
  51527. */
  51528. position: number;
  51529. /**
  51530. * Define the lens color.
  51531. */
  51532. color: Color3;
  51533. /**
  51534. * Define the lens texture.
  51535. */
  51536. texture: Nullable<Texture>;
  51537. /**
  51538. * Define the alpha mode to render this particular lens.
  51539. */
  51540. alphaMode: number;
  51541. private _system;
  51542. /**
  51543. * Creates a new Lens Flare.
  51544. * This represents one of the lens effect in a `lensFlareSystem`.
  51545. * It controls one of the indiviual texture used in the effect.
  51546. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51547. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  51548. * @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.
  51549. * @param color Define the lens color
  51550. * @param imgUrl Define the lens texture url
  51551. * @param system Define the `lensFlareSystem` this flare is part of
  51552. * @returns The newly created Lens Flare
  51553. */
  51554. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  51555. /**
  51556. * Instantiates a new Lens Flare.
  51557. * This represents one of the lens effect in a `lensFlareSystem`.
  51558. * It controls one of the indiviual texture used in the effect.
  51559. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51560. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  51561. * @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.
  51562. * @param color Define the lens color
  51563. * @param imgUrl Define the lens texture url
  51564. * @param system Define the `lensFlareSystem` this flare is part of
  51565. */
  51566. constructor(
  51567. /**
  51568. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  51569. */
  51570. size: number,
  51571. /**
  51572. * 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.
  51573. */
  51574. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  51575. /**
  51576. * Dispose and release the lens flare with its associated resources.
  51577. */
  51578. dispose(): void;
  51579. }
  51580. }
  51581. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  51582. import { Nullable } from "babylonjs/types";
  51583. import { Scene } from "babylonjs/scene";
  51584. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  51585. import { AbstractScene } from "babylonjs/abstractScene";
  51586. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  51587. module "babylonjs/abstractScene" {
  51588. interface AbstractScene {
  51589. /**
  51590. * The list of lens flare system added to the scene
  51591. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  51592. */
  51593. lensFlareSystems: Array<LensFlareSystem>;
  51594. /**
  51595. * Removes the given lens flare system from this scene.
  51596. * @param toRemove The lens flare system to remove
  51597. * @returns The index of the removed lens flare system
  51598. */
  51599. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  51600. /**
  51601. * Adds the given lens flare system to this scene
  51602. * @param newLensFlareSystem The lens flare system to add
  51603. */
  51604. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  51605. /**
  51606. * Gets a lens flare system using its name
  51607. * @param name defines the name to look for
  51608. * @returns the lens flare system or null if not found
  51609. */
  51610. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  51611. /**
  51612. * Gets a lens flare system using its id
  51613. * @param id defines the id to look for
  51614. * @returns the lens flare system or null if not found
  51615. */
  51616. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  51617. }
  51618. }
  51619. /**
  51620. * Defines the lens flare scene component responsible to manage any lens flares
  51621. * in a given scene.
  51622. */
  51623. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  51624. /**
  51625. * The component name helpfull to identify the component in the list of scene components.
  51626. */
  51627. readonly name: string;
  51628. /**
  51629. * The scene the component belongs to.
  51630. */
  51631. scene: Scene;
  51632. /**
  51633. * Creates a new instance of the component for the given scene
  51634. * @param scene Defines the scene to register the component in
  51635. */
  51636. constructor(scene: Scene);
  51637. /**
  51638. * Registers the component in a given scene
  51639. */
  51640. register(): void;
  51641. /**
  51642. * Rebuilds the elements related to this component in case of
  51643. * context lost for instance.
  51644. */
  51645. rebuild(): void;
  51646. /**
  51647. * Adds all the elements from the container to the scene
  51648. * @param container the container holding the elements
  51649. */
  51650. addFromContainer(container: AbstractScene): void;
  51651. /**
  51652. * Removes all the elements in the container from the scene
  51653. * @param container contains the elements to remove
  51654. * @param dispose if the removed element should be disposed (default: false)
  51655. */
  51656. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  51657. /**
  51658. * Serializes the component data to the specified json object
  51659. * @param serializationObject The object to serialize to
  51660. */
  51661. serialize(serializationObject: any): void;
  51662. /**
  51663. * Disposes the component and the associated ressources.
  51664. */
  51665. dispose(): void;
  51666. private _draw;
  51667. }
  51668. }
  51669. declare module "babylonjs/LensFlares/index" {
  51670. export * from "babylonjs/LensFlares/lensFlare";
  51671. export * from "babylonjs/LensFlares/lensFlareSystem";
  51672. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  51673. }
  51674. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  51675. import { Scene } from "babylonjs/scene";
  51676. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  51677. import { AbstractScene } from "babylonjs/abstractScene";
  51678. /**
  51679. * Defines the shadow generator component responsible to manage any shadow generators
  51680. * in a given scene.
  51681. */
  51682. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  51683. /**
  51684. * The component name helpfull to identify the component in the list of scene components.
  51685. */
  51686. readonly name: string;
  51687. /**
  51688. * The scene the component belongs to.
  51689. */
  51690. scene: Scene;
  51691. /**
  51692. * Creates a new instance of the component for the given scene
  51693. * @param scene Defines the scene to register the component in
  51694. */
  51695. constructor(scene: Scene);
  51696. /**
  51697. * Registers the component in a given scene
  51698. */
  51699. register(): void;
  51700. /**
  51701. * Rebuilds the elements related to this component in case of
  51702. * context lost for instance.
  51703. */
  51704. rebuild(): void;
  51705. /**
  51706. * Serializes the component data to the specified json object
  51707. * @param serializationObject The object to serialize to
  51708. */
  51709. serialize(serializationObject: any): void;
  51710. /**
  51711. * Adds all the elements from the container to the scene
  51712. * @param container the container holding the elements
  51713. */
  51714. addFromContainer(container: AbstractScene): void;
  51715. /**
  51716. * Removes all the elements in the container from the scene
  51717. * @param container contains the elements to remove
  51718. * @param dispose if the removed element should be disposed (default: false)
  51719. */
  51720. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  51721. /**
  51722. * Rebuilds the elements related to this component in case of
  51723. * context lost for instance.
  51724. */
  51725. dispose(): void;
  51726. private _gatherRenderTargets;
  51727. }
  51728. }
  51729. declare module "babylonjs/Lights/Shadows/index" {
  51730. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  51731. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  51732. }
  51733. declare module "babylonjs/Lights/pointLight" {
  51734. import { Scene } from "babylonjs/scene";
  51735. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  51736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51737. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  51738. import { Effect } from "babylonjs/Materials/effect";
  51739. /**
  51740. * A point light is a light defined by an unique point in world space.
  51741. * The light is emitted in every direction from this point.
  51742. * A good example of a point light is a standard light bulb.
  51743. * Documentation: https://doc.babylonjs.com/babylon101/lights
  51744. */
  51745. export class PointLight extends ShadowLight {
  51746. private _shadowAngle;
  51747. /**
  51748. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  51749. * This specifies what angle the shadow will use to be created.
  51750. *
  51751. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  51752. */
  51753. /**
  51754. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  51755. * This specifies what angle the shadow will use to be created.
  51756. *
  51757. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  51758. */
  51759. shadowAngle: number;
  51760. /**
  51761. * Gets the direction if it has been set.
  51762. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  51763. */
  51764. /**
  51765. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  51766. */
  51767. direction: Vector3;
  51768. /**
  51769. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  51770. * A PointLight emits the light in every direction.
  51771. * It can cast shadows.
  51772. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  51773. * ```javascript
  51774. * var pointLight = new PointLight("pl", camera.position, scene);
  51775. * ```
  51776. * Documentation : https://doc.babylonjs.com/babylon101/lights
  51777. * @param name The light friendly name
  51778. * @param position The position of the point light in the scene
  51779. * @param scene The scene the lights belongs to
  51780. */
  51781. constructor(name: string, position: Vector3, scene: Scene);
  51782. /**
  51783. * Returns the string "PointLight"
  51784. * @returns the class name
  51785. */
  51786. getClassName(): string;
  51787. /**
  51788. * Returns the integer 0.
  51789. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  51790. */
  51791. getTypeID(): number;
  51792. /**
  51793. * Specifies wether or not the shadowmap should be a cube texture.
  51794. * @returns true if the shadowmap needs to be a cube texture.
  51795. */
  51796. needCube(): boolean;
  51797. /**
  51798. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  51799. * @param faceIndex The index of the face we are computed the direction to generate shadow
  51800. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  51801. */
  51802. getShadowDirection(faceIndex?: number): Vector3;
  51803. /**
  51804. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  51805. * - fov = PI / 2
  51806. * - aspect ratio : 1.0
  51807. * - z-near and far equal to the active camera minZ and maxZ.
  51808. * Returns the PointLight.
  51809. */
  51810. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  51811. protected _buildUniformLayout(): void;
  51812. /**
  51813. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  51814. * @param effect The effect to update
  51815. * @param lightIndex The index of the light in the effect to update
  51816. * @returns The point light
  51817. */
  51818. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  51819. /**
  51820. * Prepares the list of defines specific to the light type.
  51821. * @param defines the list of defines
  51822. * @param lightIndex defines the index of the light for the effect
  51823. */
  51824. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  51825. }
  51826. }
  51827. declare module "babylonjs/Lights/index" {
  51828. export * from "babylonjs/Lights/light";
  51829. export * from "babylonjs/Lights/shadowLight";
  51830. export * from "babylonjs/Lights/Shadows/index";
  51831. export * from "babylonjs/Lights/directionalLight";
  51832. export * from "babylonjs/Lights/hemisphericLight";
  51833. export * from "babylonjs/Lights/pointLight";
  51834. export * from "babylonjs/Lights/spotLight";
  51835. }
  51836. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  51837. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  51838. /**
  51839. * Header information of HDR texture files.
  51840. */
  51841. export interface HDRInfo {
  51842. /**
  51843. * The height of the texture in pixels.
  51844. */
  51845. height: number;
  51846. /**
  51847. * The width of the texture in pixels.
  51848. */
  51849. width: number;
  51850. /**
  51851. * The index of the beginning of the data in the binary file.
  51852. */
  51853. dataPosition: number;
  51854. }
  51855. /**
  51856. * This groups tools to convert HDR texture to native colors array.
  51857. */
  51858. export class HDRTools {
  51859. private static Ldexp;
  51860. private static Rgbe2float;
  51861. private static readStringLine;
  51862. /**
  51863. * Reads header information from an RGBE texture stored in a native array.
  51864. * More information on this format are available here:
  51865. * https://en.wikipedia.org/wiki/RGBE_image_format
  51866. *
  51867. * @param uint8array The binary file stored in native array.
  51868. * @return The header information.
  51869. */
  51870. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  51871. /**
  51872. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  51873. * This RGBE texture needs to store the information as a panorama.
  51874. *
  51875. * More information on this format are available here:
  51876. * https://en.wikipedia.org/wiki/RGBE_image_format
  51877. *
  51878. * @param buffer The binary file stored in an array buffer.
  51879. * @param size The expected size of the extracted cubemap.
  51880. * @return The Cube Map information.
  51881. */
  51882. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  51883. /**
  51884. * Returns the pixels data extracted from an RGBE texture.
  51885. * This pixels will be stored left to right up to down in the R G B order in one array.
  51886. *
  51887. * More information on this format are available here:
  51888. * https://en.wikipedia.org/wiki/RGBE_image_format
  51889. *
  51890. * @param uint8array The binary file stored in an array buffer.
  51891. * @param hdrInfo The header information of the file.
  51892. * @return The pixels data in RGB right to left up to down order.
  51893. */
  51894. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  51895. private static RGBE_ReadPixels_RLE;
  51896. }
  51897. }
  51898. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  51899. import { Nullable } from "babylonjs/types";
  51900. import { Scene } from "babylonjs/scene";
  51901. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  51902. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51903. import "babylonjs/Engines/Extensions/engine.rawTexture";
  51904. /**
  51905. * This represents a texture coming from an HDR input.
  51906. *
  51907. * The only supported format is currently panorama picture stored in RGBE format.
  51908. * Example of such files can be found on HDRLib: http://hdrlib.com/
  51909. */
  51910. export class HDRCubeTexture extends BaseTexture {
  51911. private static _facesMapping;
  51912. private _generateHarmonics;
  51913. private _noMipmap;
  51914. private _textureMatrix;
  51915. private _size;
  51916. private _onLoad;
  51917. private _onError;
  51918. /**
  51919. * The texture URL.
  51920. */
  51921. url: string;
  51922. /**
  51923. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  51924. */
  51925. coordinatesMode: number;
  51926. protected _isBlocking: boolean;
  51927. /**
  51928. * Sets wether or not the texture is blocking during loading.
  51929. */
  51930. /**
  51931. * Gets wether or not the texture is blocking during loading.
  51932. */
  51933. isBlocking: boolean;
  51934. protected _rotationY: number;
  51935. /**
  51936. * Sets texture matrix rotation angle around Y axis in radians.
  51937. */
  51938. /**
  51939. * Gets texture matrix rotation angle around Y axis radians.
  51940. */
  51941. rotationY: number;
  51942. /**
  51943. * Gets or sets the center of the bounding box associated with the cube texture
  51944. * It must define where the camera used to render the texture was set
  51945. */
  51946. boundingBoxPosition: Vector3;
  51947. private _boundingBoxSize;
  51948. /**
  51949. * Gets or sets the size of the bounding box associated with the cube texture
  51950. * When defined, the cubemap will switch to local mode
  51951. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  51952. * @example https://www.babylonjs-playground.com/#RNASML
  51953. */
  51954. boundingBoxSize: Vector3;
  51955. /**
  51956. * Instantiates an HDRTexture from the following parameters.
  51957. *
  51958. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  51959. * @param scene The scene the texture will be used in
  51960. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  51961. * @param noMipmap Forces to not generate the mipmap if true
  51962. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  51963. * @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)
  51964. * @param reserved Reserved flag for internal use.
  51965. */
  51966. 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>);
  51967. /**
  51968. * Get the current class name of the texture useful for serialization or dynamic coding.
  51969. * @returns "HDRCubeTexture"
  51970. */
  51971. getClassName(): string;
  51972. /**
  51973. * Occurs when the file is raw .hdr file.
  51974. */
  51975. private loadTexture;
  51976. clone(): HDRCubeTexture;
  51977. delayLoad(): void;
  51978. /**
  51979. * Get the texture reflection matrix used to rotate/transform the reflection.
  51980. * @returns the reflection matrix
  51981. */
  51982. getReflectionTextureMatrix(): Matrix;
  51983. /**
  51984. * Set the texture reflection matrix used to rotate/transform the reflection.
  51985. * @param value Define the reflection matrix to set
  51986. */
  51987. setReflectionTextureMatrix(value: Matrix): void;
  51988. /**
  51989. * Parses a JSON representation of an HDR Texture in order to create the texture
  51990. * @param parsedTexture Define the JSON representation
  51991. * @param scene Define the scene the texture should be created in
  51992. * @param rootUrl Define the root url in case we need to load relative dependencies
  51993. * @returns the newly created texture after parsing
  51994. */
  51995. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  51996. serialize(): any;
  51997. }
  51998. }
  51999. declare module "babylonjs/Physics/physicsEngine" {
  52000. import { Nullable } from "babylonjs/types";
  52001. import { Vector3 } from "babylonjs/Maths/math.vector";
  52002. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52003. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  52004. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  52005. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52006. /**
  52007. * Class used to control physics engine
  52008. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  52009. */
  52010. export class PhysicsEngine implements IPhysicsEngine {
  52011. private _physicsPlugin;
  52012. /**
  52013. * Global value used to control the smallest number supported by the simulation
  52014. */
  52015. static Epsilon: number;
  52016. private _impostors;
  52017. private _joints;
  52018. /**
  52019. * Gets the gravity vector used by the simulation
  52020. */
  52021. gravity: Vector3;
  52022. /**
  52023. * Factory used to create the default physics plugin.
  52024. * @returns The default physics plugin
  52025. */
  52026. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  52027. /**
  52028. * Creates a new Physics Engine
  52029. * @param gravity defines the gravity vector used by the simulation
  52030. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  52031. */
  52032. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  52033. /**
  52034. * Sets the gravity vector used by the simulation
  52035. * @param gravity defines the gravity vector to use
  52036. */
  52037. setGravity(gravity: Vector3): void;
  52038. /**
  52039. * Set the time step of the physics engine.
  52040. * Default is 1/60.
  52041. * To slow it down, enter 1/600 for example.
  52042. * To speed it up, 1/30
  52043. * @param newTimeStep defines the new timestep to apply to this world.
  52044. */
  52045. setTimeStep(newTimeStep?: number): void;
  52046. /**
  52047. * Get the time step of the physics engine.
  52048. * @returns the current time step
  52049. */
  52050. getTimeStep(): number;
  52051. /**
  52052. * Release all resources
  52053. */
  52054. dispose(): void;
  52055. /**
  52056. * Gets the name of the current physics plugin
  52057. * @returns the name of the plugin
  52058. */
  52059. getPhysicsPluginName(): string;
  52060. /**
  52061. * Adding a new impostor for the impostor tracking.
  52062. * This will be done by the impostor itself.
  52063. * @param impostor the impostor to add
  52064. */
  52065. addImpostor(impostor: PhysicsImpostor): void;
  52066. /**
  52067. * Remove an impostor from the engine.
  52068. * This impostor and its mesh will not longer be updated by the physics engine.
  52069. * @param impostor the impostor to remove
  52070. */
  52071. removeImpostor(impostor: PhysicsImpostor): void;
  52072. /**
  52073. * Add a joint to the physics engine
  52074. * @param mainImpostor defines the main impostor to which the joint is added.
  52075. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  52076. * @param joint defines the joint that will connect both impostors.
  52077. */
  52078. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  52079. /**
  52080. * Removes a joint from the simulation
  52081. * @param mainImpostor defines the impostor used with the joint
  52082. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  52083. * @param joint defines the joint to remove
  52084. */
  52085. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  52086. /**
  52087. * Called by the scene. No need to call it.
  52088. * @param delta defines the timespam between frames
  52089. */
  52090. _step(delta: number): void;
  52091. /**
  52092. * Gets the current plugin used to run the simulation
  52093. * @returns current plugin
  52094. */
  52095. getPhysicsPlugin(): IPhysicsEnginePlugin;
  52096. /**
  52097. * Gets the list of physic impostors
  52098. * @returns an array of PhysicsImpostor
  52099. */
  52100. getImpostors(): Array<PhysicsImpostor>;
  52101. /**
  52102. * Gets the impostor for a physics enabled object
  52103. * @param object defines the object impersonated by the impostor
  52104. * @returns the PhysicsImpostor or null if not found
  52105. */
  52106. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  52107. /**
  52108. * Gets the impostor for a physics body object
  52109. * @param body defines physics body used by the impostor
  52110. * @returns the PhysicsImpostor or null if not found
  52111. */
  52112. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  52113. /**
  52114. * Does a raycast in the physics world
  52115. * @param from when should the ray start?
  52116. * @param to when should the ray end?
  52117. * @returns PhysicsRaycastResult
  52118. */
  52119. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52120. }
  52121. }
  52122. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  52123. import { Nullable } from "babylonjs/types";
  52124. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  52125. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52126. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  52127. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52128. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  52129. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52130. /** @hidden */
  52131. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  52132. private _useDeltaForWorldStep;
  52133. world: any;
  52134. name: string;
  52135. private _physicsMaterials;
  52136. private _fixedTimeStep;
  52137. private _cannonRaycastResult;
  52138. private _raycastResult;
  52139. private _physicsBodysToRemoveAfterStep;
  52140. BJSCANNON: any;
  52141. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  52142. setGravity(gravity: Vector3): void;
  52143. setTimeStep(timeStep: number): void;
  52144. getTimeStep(): number;
  52145. executeStep(delta: number): void;
  52146. private _removeMarkedPhysicsBodiesFromWorld;
  52147. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52148. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52149. generatePhysicsBody(impostor: PhysicsImpostor): void;
  52150. private _processChildMeshes;
  52151. removePhysicsBody(impostor: PhysicsImpostor): void;
  52152. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  52153. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  52154. private _addMaterial;
  52155. private _checkWithEpsilon;
  52156. private _createShape;
  52157. private _createHeightmap;
  52158. private _minus90X;
  52159. private _plus90X;
  52160. private _tmpPosition;
  52161. private _tmpDeltaPosition;
  52162. private _tmpUnityRotation;
  52163. private _updatePhysicsBodyTransformation;
  52164. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  52165. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  52166. isSupported(): boolean;
  52167. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52168. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52169. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52170. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52171. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  52172. getBodyMass(impostor: PhysicsImpostor): number;
  52173. getBodyFriction(impostor: PhysicsImpostor): number;
  52174. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  52175. getBodyRestitution(impostor: PhysicsImpostor): number;
  52176. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  52177. sleepBody(impostor: PhysicsImpostor): void;
  52178. wakeUpBody(impostor: PhysicsImpostor): void;
  52179. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  52180. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  52181. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  52182. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  52183. getRadius(impostor: PhysicsImpostor): number;
  52184. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  52185. dispose(): void;
  52186. private _extendNamespace;
  52187. /**
  52188. * Does a raycast in the physics world
  52189. * @param from when should the ray start?
  52190. * @param to when should the ray end?
  52191. * @returns PhysicsRaycastResult
  52192. */
  52193. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52194. }
  52195. }
  52196. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  52197. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  52198. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52199. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  52200. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52201. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  52202. import { Nullable } from "babylonjs/types";
  52203. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52204. /** @hidden */
  52205. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  52206. world: any;
  52207. name: string;
  52208. BJSOIMO: any;
  52209. private _raycastResult;
  52210. constructor(iterations?: number, oimoInjection?: any);
  52211. setGravity(gravity: Vector3): void;
  52212. setTimeStep(timeStep: number): void;
  52213. getTimeStep(): number;
  52214. private _tmpImpostorsArray;
  52215. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  52216. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52217. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52218. generatePhysicsBody(impostor: PhysicsImpostor): void;
  52219. private _tmpPositionVector;
  52220. removePhysicsBody(impostor: PhysicsImpostor): void;
  52221. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  52222. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  52223. isSupported(): boolean;
  52224. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  52225. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  52226. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52227. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52228. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52229. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52230. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  52231. getBodyMass(impostor: PhysicsImpostor): number;
  52232. getBodyFriction(impostor: PhysicsImpostor): number;
  52233. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  52234. getBodyRestitution(impostor: PhysicsImpostor): number;
  52235. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  52236. sleepBody(impostor: PhysicsImpostor): void;
  52237. wakeUpBody(impostor: PhysicsImpostor): void;
  52238. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  52239. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  52240. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  52241. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  52242. getRadius(impostor: PhysicsImpostor): number;
  52243. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  52244. dispose(): void;
  52245. /**
  52246. * Does a raycast in the physics world
  52247. * @param from when should the ray start?
  52248. * @param to when should the ray end?
  52249. * @returns PhysicsRaycastResult
  52250. */
  52251. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52252. }
  52253. }
  52254. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  52255. import { Nullable } from "babylonjs/types";
  52256. import { Scene } from "babylonjs/scene";
  52257. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  52258. import { Color4 } from "babylonjs/Maths/math.color";
  52259. import { Mesh } from "babylonjs/Meshes/mesh";
  52260. /**
  52261. * Class containing static functions to help procedurally build meshes
  52262. */
  52263. export class RibbonBuilder {
  52264. /**
  52265. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  52266. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  52267. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  52268. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  52269. * * 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
  52270. * * 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
  52271. * * 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
  52272. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52273. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52274. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  52275. * * 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
  52276. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  52277. * * 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
  52278. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  52279. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52280. * @param name defines the name of the mesh
  52281. * @param options defines the options used to create the mesh
  52282. * @param scene defines the hosting scene
  52283. * @returns the ribbon mesh
  52284. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  52285. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  52286. */
  52287. static CreateRibbon(name: string, options: {
  52288. pathArray: Vector3[][];
  52289. closeArray?: boolean;
  52290. closePath?: boolean;
  52291. offset?: number;
  52292. updatable?: boolean;
  52293. sideOrientation?: number;
  52294. frontUVs?: Vector4;
  52295. backUVs?: Vector4;
  52296. instance?: Mesh;
  52297. invertUV?: boolean;
  52298. uvs?: Vector2[];
  52299. colors?: Color4[];
  52300. }, scene?: Nullable<Scene>): Mesh;
  52301. }
  52302. }
  52303. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  52304. import { Nullable } from "babylonjs/types";
  52305. import { Scene } from "babylonjs/scene";
  52306. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  52307. import { Mesh } from "babylonjs/Meshes/mesh";
  52308. /**
  52309. * Class containing static functions to help procedurally build meshes
  52310. */
  52311. export class ShapeBuilder {
  52312. /**
  52313. * 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.
  52314. * * 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.
  52315. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  52316. * * 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.
  52317. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  52318. * * 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
  52319. * * 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
  52320. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  52321. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52322. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52323. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  52324. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  52325. * @param name defines the name of the mesh
  52326. * @param options defines the options used to create the mesh
  52327. * @param scene defines the hosting scene
  52328. * @returns the extruded shape mesh
  52329. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  52330. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  52331. */
  52332. static ExtrudeShape(name: string, options: {
  52333. shape: Vector3[];
  52334. path: Vector3[];
  52335. scale?: number;
  52336. rotation?: number;
  52337. cap?: number;
  52338. updatable?: boolean;
  52339. sideOrientation?: number;
  52340. frontUVs?: Vector4;
  52341. backUVs?: Vector4;
  52342. instance?: Mesh;
  52343. invertUV?: boolean;
  52344. }, scene?: Nullable<Scene>): Mesh;
  52345. /**
  52346. * Creates an custom extruded shape mesh.
  52347. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  52348. * * 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.
  52349. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  52350. * * 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
  52351. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  52352. * * 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
  52353. * * It must returns a float value that will be the scale value applied to the shape on each path point
  52354. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  52355. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  52356. * * 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
  52357. * * 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
  52358. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  52359. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52360. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52361. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  52362. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52363. * @param name defines the name of the mesh
  52364. * @param options defines the options used to create the mesh
  52365. * @param scene defines the hosting scene
  52366. * @returns the custom extruded shape mesh
  52367. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  52368. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  52369. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  52370. */
  52371. static ExtrudeShapeCustom(name: string, options: {
  52372. shape: Vector3[];
  52373. path: Vector3[];
  52374. scaleFunction?: any;
  52375. rotationFunction?: any;
  52376. ribbonCloseArray?: boolean;
  52377. ribbonClosePath?: boolean;
  52378. cap?: number;
  52379. updatable?: boolean;
  52380. sideOrientation?: number;
  52381. frontUVs?: Vector4;
  52382. backUVs?: Vector4;
  52383. instance?: Mesh;
  52384. invertUV?: boolean;
  52385. }, scene?: Nullable<Scene>): Mesh;
  52386. private static _ExtrudeShapeGeneric;
  52387. }
  52388. }
  52389. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  52390. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  52391. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  52392. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52393. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  52394. import { Nullable } from "babylonjs/types";
  52395. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52396. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  52397. /**
  52398. * AmmoJS Physics plugin
  52399. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  52400. * @see https://github.com/kripken/ammo.js/
  52401. */
  52402. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  52403. private _useDeltaForWorldStep;
  52404. /**
  52405. * Reference to the Ammo library
  52406. */
  52407. bjsAMMO: any;
  52408. /**
  52409. * Created ammoJS world which physics bodies are added to
  52410. */
  52411. world: any;
  52412. /**
  52413. * Name of the plugin
  52414. */
  52415. name: string;
  52416. private _timeStep;
  52417. private _fixedTimeStep;
  52418. private _maxSteps;
  52419. private _tmpQuaternion;
  52420. private _tmpAmmoTransform;
  52421. private _tmpAmmoQuaternion;
  52422. private _tmpAmmoConcreteContactResultCallback;
  52423. private _collisionConfiguration;
  52424. private _dispatcher;
  52425. private _overlappingPairCache;
  52426. private _solver;
  52427. private _softBodySolver;
  52428. private _tmpAmmoVectorA;
  52429. private _tmpAmmoVectorB;
  52430. private _tmpAmmoVectorC;
  52431. private _tmpAmmoVectorD;
  52432. private _tmpContactCallbackResult;
  52433. private _tmpAmmoVectorRCA;
  52434. private _tmpAmmoVectorRCB;
  52435. private _raycastResult;
  52436. private static readonly DISABLE_COLLISION_FLAG;
  52437. private static readonly KINEMATIC_FLAG;
  52438. private static readonly DISABLE_DEACTIVATION_FLAG;
  52439. /**
  52440. * Initializes the ammoJS plugin
  52441. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  52442. * @param ammoInjection can be used to inject your own ammo reference
  52443. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  52444. */
  52445. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  52446. /**
  52447. * Sets the gravity of the physics world (m/(s^2))
  52448. * @param gravity Gravity to set
  52449. */
  52450. setGravity(gravity: Vector3): void;
  52451. /**
  52452. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  52453. * @param timeStep timestep to use in seconds
  52454. */
  52455. setTimeStep(timeStep: number): void;
  52456. /**
  52457. * 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)
  52458. * @param fixedTimeStep fixedTimeStep to use in seconds
  52459. */
  52460. setFixedTimeStep(fixedTimeStep: number): void;
  52461. /**
  52462. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  52463. * @param maxSteps the maximum number of steps by the physics engine per frame
  52464. */
  52465. setMaxSteps(maxSteps: number): void;
  52466. /**
  52467. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  52468. * @returns the current timestep in seconds
  52469. */
  52470. getTimeStep(): number;
  52471. private _isImpostorInContact;
  52472. private _isImpostorPairInContact;
  52473. private _stepSimulation;
  52474. /**
  52475. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  52476. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  52477. * After the step the babylon meshes are set to the position of the physics imposters
  52478. * @param delta amount of time to step forward
  52479. * @param impostors array of imposters to update before/after the step
  52480. */
  52481. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  52482. /**
  52483. * Update babylon mesh to match physics world object
  52484. * @param impostor imposter to match
  52485. */
  52486. private _afterSoftStep;
  52487. /**
  52488. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  52489. * @param impostor imposter to match
  52490. */
  52491. private _ropeStep;
  52492. /**
  52493. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  52494. * @param impostor imposter to match
  52495. */
  52496. private _softbodyOrClothStep;
  52497. private _tmpVector;
  52498. private _tmpMatrix;
  52499. /**
  52500. * Applies an impulse on the imposter
  52501. * @param impostor imposter to apply impulse to
  52502. * @param force amount of force to be applied to the imposter
  52503. * @param contactPoint the location to apply the impulse on the imposter
  52504. */
  52505. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52506. /**
  52507. * Applies a force on the imposter
  52508. * @param impostor imposter to apply force
  52509. * @param force amount of force to be applied to the imposter
  52510. * @param contactPoint the location to apply the force on the imposter
  52511. */
  52512. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  52513. /**
  52514. * Creates a physics body using the plugin
  52515. * @param impostor the imposter to create the physics body on
  52516. */
  52517. generatePhysicsBody(impostor: PhysicsImpostor): void;
  52518. /**
  52519. * Removes the physics body from the imposter and disposes of the body's memory
  52520. * @param impostor imposter to remove the physics body from
  52521. */
  52522. removePhysicsBody(impostor: PhysicsImpostor): void;
  52523. /**
  52524. * Generates a joint
  52525. * @param impostorJoint the imposter joint to create the joint with
  52526. */
  52527. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  52528. /**
  52529. * Removes a joint
  52530. * @param impostorJoint the imposter joint to remove the joint from
  52531. */
  52532. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  52533. private _addMeshVerts;
  52534. /**
  52535. * Initialise the soft body vertices to match its object's (mesh) vertices
  52536. * Softbody vertices (nodes) are in world space and to match this
  52537. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  52538. * @param impostor to create the softbody for
  52539. */
  52540. private _softVertexData;
  52541. /**
  52542. * Create an impostor's soft body
  52543. * @param impostor to create the softbody for
  52544. */
  52545. private _createSoftbody;
  52546. /**
  52547. * Create cloth for an impostor
  52548. * @param impostor to create the softbody for
  52549. */
  52550. private _createCloth;
  52551. /**
  52552. * Create rope for an impostor
  52553. * @param impostor to create the softbody for
  52554. */
  52555. private _createRope;
  52556. private _addHullVerts;
  52557. private _createShape;
  52558. /**
  52559. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  52560. * @param impostor imposter containing the physics body and babylon object
  52561. */
  52562. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  52563. /**
  52564. * Sets the babylon object's position/rotation from the physics body's position/rotation
  52565. * @param impostor imposter containing the physics body and babylon object
  52566. * @param newPosition new position
  52567. * @param newRotation new rotation
  52568. */
  52569. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  52570. /**
  52571. * If this plugin is supported
  52572. * @returns true if its supported
  52573. */
  52574. isSupported(): boolean;
  52575. /**
  52576. * Sets the linear velocity of the physics body
  52577. * @param impostor imposter to set the velocity on
  52578. * @param velocity velocity to set
  52579. */
  52580. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52581. /**
  52582. * Sets the angular velocity of the physics body
  52583. * @param impostor imposter to set the velocity on
  52584. * @param velocity velocity to set
  52585. */
  52586. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  52587. /**
  52588. * gets the linear velocity
  52589. * @param impostor imposter to get linear velocity from
  52590. * @returns linear velocity
  52591. */
  52592. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52593. /**
  52594. * gets the angular velocity
  52595. * @param impostor imposter to get angular velocity from
  52596. * @returns angular velocity
  52597. */
  52598. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  52599. /**
  52600. * Sets the mass of physics body
  52601. * @param impostor imposter to set the mass on
  52602. * @param mass mass to set
  52603. */
  52604. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  52605. /**
  52606. * Gets the mass of the physics body
  52607. * @param impostor imposter to get the mass from
  52608. * @returns mass
  52609. */
  52610. getBodyMass(impostor: PhysicsImpostor): number;
  52611. /**
  52612. * Gets friction of the impostor
  52613. * @param impostor impostor to get friction from
  52614. * @returns friction value
  52615. */
  52616. getBodyFriction(impostor: PhysicsImpostor): number;
  52617. /**
  52618. * Sets friction of the impostor
  52619. * @param impostor impostor to set friction on
  52620. * @param friction friction value
  52621. */
  52622. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  52623. /**
  52624. * Gets restitution of the impostor
  52625. * @param impostor impostor to get restitution from
  52626. * @returns restitution value
  52627. */
  52628. getBodyRestitution(impostor: PhysicsImpostor): number;
  52629. /**
  52630. * Sets resitution of the impostor
  52631. * @param impostor impostor to set resitution on
  52632. * @param restitution resitution value
  52633. */
  52634. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  52635. /**
  52636. * Gets pressure inside the impostor
  52637. * @param impostor impostor to get pressure from
  52638. * @returns pressure value
  52639. */
  52640. getBodyPressure(impostor: PhysicsImpostor): number;
  52641. /**
  52642. * Sets pressure inside a soft body impostor
  52643. * Cloth and rope must remain 0 pressure
  52644. * @param impostor impostor to set pressure on
  52645. * @param pressure pressure value
  52646. */
  52647. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  52648. /**
  52649. * Gets stiffness of the impostor
  52650. * @param impostor impostor to get stiffness from
  52651. * @returns pressure value
  52652. */
  52653. getBodyStiffness(impostor: PhysicsImpostor): number;
  52654. /**
  52655. * Sets stiffness of the impostor
  52656. * @param impostor impostor to set stiffness on
  52657. * @param stiffness stiffness value from 0 to 1
  52658. */
  52659. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  52660. /**
  52661. * Gets velocityIterations of the impostor
  52662. * @param impostor impostor to get velocity iterations from
  52663. * @returns velocityIterations value
  52664. */
  52665. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  52666. /**
  52667. * Sets velocityIterations of the impostor
  52668. * @param impostor impostor to set velocity iterations on
  52669. * @param velocityIterations velocityIterations value
  52670. */
  52671. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  52672. /**
  52673. * Gets positionIterations of the impostor
  52674. * @param impostor impostor to get position iterations from
  52675. * @returns positionIterations value
  52676. */
  52677. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  52678. /**
  52679. * Sets positionIterations of the impostor
  52680. * @param impostor impostor to set position on
  52681. * @param positionIterations positionIterations value
  52682. */
  52683. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  52684. /**
  52685. * Append an anchor to a cloth object
  52686. * @param impostor is the cloth impostor to add anchor to
  52687. * @param otherImpostor is the rigid impostor to anchor to
  52688. * @param width ratio across width from 0 to 1
  52689. * @param height ratio up height from 0 to 1
  52690. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  52691. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  52692. */
  52693. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  52694. /**
  52695. * Append an hook to a rope object
  52696. * @param impostor is the rope impostor to add hook to
  52697. * @param otherImpostor is the rigid impostor to hook to
  52698. * @param length ratio along the rope from 0 to 1
  52699. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  52700. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  52701. */
  52702. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  52703. /**
  52704. * Sleeps the physics body and stops it from being active
  52705. * @param impostor impostor to sleep
  52706. */
  52707. sleepBody(impostor: PhysicsImpostor): void;
  52708. /**
  52709. * Activates the physics body
  52710. * @param impostor impostor to activate
  52711. */
  52712. wakeUpBody(impostor: PhysicsImpostor): void;
  52713. /**
  52714. * Updates the distance parameters of the joint
  52715. * @param joint joint to update
  52716. * @param maxDistance maximum distance of the joint
  52717. * @param minDistance minimum distance of the joint
  52718. */
  52719. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  52720. /**
  52721. * Sets a motor on the joint
  52722. * @param joint joint to set motor on
  52723. * @param speed speed of the motor
  52724. * @param maxForce maximum force of the motor
  52725. * @param motorIndex index of the motor
  52726. */
  52727. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  52728. /**
  52729. * Sets the motors limit
  52730. * @param joint joint to set limit on
  52731. * @param upperLimit upper limit
  52732. * @param lowerLimit lower limit
  52733. */
  52734. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  52735. /**
  52736. * Syncs the position and rotation of a mesh with the impostor
  52737. * @param mesh mesh to sync
  52738. * @param impostor impostor to update the mesh with
  52739. */
  52740. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  52741. /**
  52742. * Gets the radius of the impostor
  52743. * @param impostor impostor to get radius from
  52744. * @returns the radius
  52745. */
  52746. getRadius(impostor: PhysicsImpostor): number;
  52747. /**
  52748. * Gets the box size of the impostor
  52749. * @param impostor impostor to get box size from
  52750. * @param result the resulting box size
  52751. */
  52752. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  52753. /**
  52754. * Disposes of the impostor
  52755. */
  52756. dispose(): void;
  52757. /**
  52758. * Does a raycast in the physics world
  52759. * @param from when should the ray start?
  52760. * @param to when should the ray end?
  52761. * @returns PhysicsRaycastResult
  52762. */
  52763. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  52764. }
  52765. }
  52766. declare module "babylonjs/Probes/reflectionProbe" {
  52767. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  52768. import { Vector3 } from "babylonjs/Maths/math.vector";
  52769. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52770. import { Nullable } from "babylonjs/types";
  52771. import { Scene } from "babylonjs/scene";
  52772. module "babylonjs/abstractScene" {
  52773. interface AbstractScene {
  52774. /**
  52775. * The list of reflection probes added to the scene
  52776. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  52777. */
  52778. reflectionProbes: Array<ReflectionProbe>;
  52779. /**
  52780. * Removes the given reflection probe from this scene.
  52781. * @param toRemove The reflection probe to remove
  52782. * @returns The index of the removed reflection probe
  52783. */
  52784. removeReflectionProbe(toRemove: ReflectionProbe): number;
  52785. /**
  52786. * Adds the given reflection probe to this scene.
  52787. * @param newReflectionProbe The reflection probe to add
  52788. */
  52789. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  52790. }
  52791. }
  52792. /**
  52793. * Class used to generate realtime reflection / refraction cube textures
  52794. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  52795. */
  52796. export class ReflectionProbe {
  52797. /** defines the name of the probe */
  52798. name: string;
  52799. private _scene;
  52800. private _renderTargetTexture;
  52801. private _projectionMatrix;
  52802. private _viewMatrix;
  52803. private _target;
  52804. private _add;
  52805. private _attachedMesh;
  52806. private _invertYAxis;
  52807. /** Gets or sets probe position (center of the cube map) */
  52808. position: Vector3;
  52809. /**
  52810. * Creates a new reflection probe
  52811. * @param name defines the name of the probe
  52812. * @param size defines the texture resolution (for each face)
  52813. * @param scene defines the hosting scene
  52814. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  52815. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  52816. */
  52817. constructor(
  52818. /** defines the name of the probe */
  52819. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  52820. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  52821. samples: number;
  52822. /** Gets or sets the refresh rate to use (on every frame by default) */
  52823. refreshRate: number;
  52824. /**
  52825. * Gets the hosting scene
  52826. * @returns a Scene
  52827. */
  52828. getScene(): Scene;
  52829. /** Gets the internal CubeTexture used to render to */
  52830. readonly cubeTexture: RenderTargetTexture;
  52831. /** Gets the list of meshes to render */
  52832. readonly renderList: Nullable<AbstractMesh[]>;
  52833. /**
  52834. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  52835. * @param mesh defines the mesh to attach to
  52836. */
  52837. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  52838. /**
  52839. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  52840. * @param renderingGroupId The rendering group id corresponding to its index
  52841. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  52842. */
  52843. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  52844. /**
  52845. * Clean all associated resources
  52846. */
  52847. dispose(): void;
  52848. /**
  52849. * Converts the reflection probe information to a readable string for debug purpose.
  52850. * @param fullDetails Supports for multiple levels of logging within scene loading
  52851. * @returns the human readable reflection probe info
  52852. */
  52853. toString(fullDetails?: boolean): string;
  52854. /**
  52855. * Get the class name of the relfection probe.
  52856. * @returns "ReflectionProbe"
  52857. */
  52858. getClassName(): string;
  52859. /**
  52860. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  52861. * @returns The JSON representation of the texture
  52862. */
  52863. serialize(): any;
  52864. /**
  52865. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  52866. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  52867. * @param scene Define the scene the parsed reflection probe should be instantiated in
  52868. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  52869. * @returns The parsed reflection probe if successful
  52870. */
  52871. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  52872. }
  52873. }
  52874. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  52875. /** @hidden */
  52876. export var _BabylonLoaderRegistered: boolean;
  52877. }
  52878. declare module "babylonjs/Loading/Plugins/index" {
  52879. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  52880. }
  52881. declare module "babylonjs/Loading/index" {
  52882. export * from "babylonjs/Loading/loadingScreen";
  52883. export * from "babylonjs/Loading/Plugins/index";
  52884. export * from "babylonjs/Loading/sceneLoader";
  52885. export * from "babylonjs/Loading/sceneLoaderFlags";
  52886. }
  52887. declare module "babylonjs/Materials/Background/index" {
  52888. export * from "babylonjs/Materials/Background/backgroundMaterial";
  52889. }
  52890. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  52891. import { Scene } from "babylonjs/scene";
  52892. import { Color3 } from "babylonjs/Maths/math.color";
  52893. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  52894. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  52895. /**
  52896. * The Physically based simple base material of BJS.
  52897. *
  52898. * This enables better naming and convention enforcements on top of the pbrMaterial.
  52899. * It is used as the base class for both the specGloss and metalRough conventions.
  52900. */
  52901. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  52902. /**
  52903. * Number of Simultaneous lights allowed on the material.
  52904. */
  52905. maxSimultaneousLights: number;
  52906. /**
  52907. * If sets to true, disables all the lights affecting the material.
  52908. */
  52909. disableLighting: boolean;
  52910. /**
  52911. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  52912. */
  52913. environmentTexture: BaseTexture;
  52914. /**
  52915. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  52916. */
  52917. invertNormalMapX: boolean;
  52918. /**
  52919. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  52920. */
  52921. invertNormalMapY: boolean;
  52922. /**
  52923. * Normal map used in the model.
  52924. */
  52925. normalTexture: BaseTexture;
  52926. /**
  52927. * Emissivie color used to self-illuminate the model.
  52928. */
  52929. emissiveColor: Color3;
  52930. /**
  52931. * Emissivie texture used to self-illuminate the model.
  52932. */
  52933. emissiveTexture: BaseTexture;
  52934. /**
  52935. * Occlusion Channel Strenght.
  52936. */
  52937. occlusionStrength: number;
  52938. /**
  52939. * Occlusion Texture of the material (adding extra occlusion effects).
  52940. */
  52941. occlusionTexture: BaseTexture;
  52942. /**
  52943. * Defines the alpha limits in alpha test mode.
  52944. */
  52945. alphaCutOff: number;
  52946. /**
  52947. * Gets the current double sided mode.
  52948. */
  52949. /**
  52950. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  52951. */
  52952. doubleSided: boolean;
  52953. /**
  52954. * Stores the pre-calculated light information of a mesh in a texture.
  52955. */
  52956. lightmapTexture: BaseTexture;
  52957. /**
  52958. * If true, the light map contains occlusion information instead of lighting info.
  52959. */
  52960. useLightmapAsShadowmap: boolean;
  52961. /**
  52962. * Instantiates a new PBRMaterial instance.
  52963. *
  52964. * @param name The material name
  52965. * @param scene The scene the material will be use in.
  52966. */
  52967. constructor(name: string, scene: Scene);
  52968. getClassName(): string;
  52969. }
  52970. }
  52971. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  52972. import { Scene } from "babylonjs/scene";
  52973. import { Color3 } from "babylonjs/Maths/math.color";
  52974. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  52975. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  52976. /**
  52977. * The PBR material of BJS following the metal roughness convention.
  52978. *
  52979. * This fits to the PBR convention in the GLTF definition:
  52980. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  52981. */
  52982. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  52983. /**
  52984. * The base color has two different interpretations depending on the value of metalness.
  52985. * When the material is a metal, the base color is the specific measured reflectance value
  52986. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  52987. * of the material.
  52988. */
  52989. baseColor: Color3;
  52990. /**
  52991. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  52992. * well as opacity information in the alpha channel.
  52993. */
  52994. baseTexture: BaseTexture;
  52995. /**
  52996. * Specifies the metallic scalar value of the material.
  52997. * Can also be used to scale the metalness values of the metallic texture.
  52998. */
  52999. metallic: number;
  53000. /**
  53001. * Specifies the roughness scalar value of the material.
  53002. * Can also be used to scale the roughness values of the metallic texture.
  53003. */
  53004. roughness: number;
  53005. /**
  53006. * Texture containing both the metallic value in the B channel and the
  53007. * roughness value in the G channel to keep better precision.
  53008. */
  53009. metallicRoughnessTexture: BaseTexture;
  53010. /**
  53011. * Instantiates a new PBRMetalRoughnessMaterial instance.
  53012. *
  53013. * @param name The material name
  53014. * @param scene The scene the material will be use in.
  53015. */
  53016. constructor(name: string, scene: Scene);
  53017. /**
  53018. * Return the currrent class name of the material.
  53019. */
  53020. getClassName(): string;
  53021. /**
  53022. * Makes a duplicate of the current material.
  53023. * @param name - name to use for the new material.
  53024. */
  53025. clone(name: string): PBRMetallicRoughnessMaterial;
  53026. /**
  53027. * Serialize the material to a parsable JSON object.
  53028. */
  53029. serialize(): any;
  53030. /**
  53031. * Parses a JSON object correponding to the serialize function.
  53032. */
  53033. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  53034. }
  53035. }
  53036. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  53037. import { Scene } from "babylonjs/scene";
  53038. import { Color3 } from "babylonjs/Maths/math.color";
  53039. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53040. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  53041. /**
  53042. * The PBR material of BJS following the specular glossiness convention.
  53043. *
  53044. * This fits to the PBR convention in the GLTF definition:
  53045. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  53046. */
  53047. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  53048. /**
  53049. * Specifies the diffuse color of the material.
  53050. */
  53051. diffuseColor: Color3;
  53052. /**
  53053. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  53054. * channel.
  53055. */
  53056. diffuseTexture: BaseTexture;
  53057. /**
  53058. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  53059. */
  53060. specularColor: Color3;
  53061. /**
  53062. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  53063. */
  53064. glossiness: number;
  53065. /**
  53066. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  53067. */
  53068. specularGlossinessTexture: BaseTexture;
  53069. /**
  53070. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  53071. *
  53072. * @param name The material name
  53073. * @param scene The scene the material will be use in.
  53074. */
  53075. constructor(name: string, scene: Scene);
  53076. /**
  53077. * Return the currrent class name of the material.
  53078. */
  53079. getClassName(): string;
  53080. /**
  53081. * Makes a duplicate of the current material.
  53082. * @param name - name to use for the new material.
  53083. */
  53084. clone(name: string): PBRSpecularGlossinessMaterial;
  53085. /**
  53086. * Serialize the material to a parsable JSON object.
  53087. */
  53088. serialize(): any;
  53089. /**
  53090. * Parses a JSON object correponding to the serialize function.
  53091. */
  53092. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  53093. }
  53094. }
  53095. declare module "babylonjs/Materials/PBR/index" {
  53096. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  53097. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  53098. export * from "babylonjs/Materials/PBR/pbrMaterial";
  53099. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  53100. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  53101. }
  53102. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  53103. import { Nullable } from "babylonjs/types";
  53104. import { Scene } from "babylonjs/scene";
  53105. import { Matrix } from "babylonjs/Maths/math.vector";
  53106. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53107. /**
  53108. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  53109. * It can help converting any input color in a desired output one. This can then be used to create effects
  53110. * from sepia, black and white to sixties or futuristic rendering...
  53111. *
  53112. * The only supported format is currently 3dl.
  53113. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  53114. */
  53115. export class ColorGradingTexture extends BaseTexture {
  53116. /**
  53117. * The current texture matrix. (will always be identity in color grading texture)
  53118. */
  53119. private _textureMatrix;
  53120. /**
  53121. * The texture URL.
  53122. */
  53123. url: string;
  53124. /**
  53125. * Empty line regex stored for GC.
  53126. */
  53127. private static _noneEmptyLineRegex;
  53128. private _engine;
  53129. /**
  53130. * Instantiates a ColorGradingTexture from the following parameters.
  53131. *
  53132. * @param url The location of the color gradind data (currently only supporting 3dl)
  53133. * @param scene The scene the texture will be used in
  53134. */
  53135. constructor(url: string, scene: Scene);
  53136. /**
  53137. * Returns the texture matrix used in most of the material.
  53138. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  53139. */
  53140. getTextureMatrix(): Matrix;
  53141. /**
  53142. * Occurs when the file being loaded is a .3dl LUT file.
  53143. */
  53144. private load3dlTexture;
  53145. /**
  53146. * Starts the loading process of the texture.
  53147. */
  53148. private loadTexture;
  53149. /**
  53150. * Clones the color gradind texture.
  53151. */
  53152. clone(): ColorGradingTexture;
  53153. /**
  53154. * Called during delayed load for textures.
  53155. */
  53156. delayLoad(): void;
  53157. /**
  53158. * Parses a color grading texture serialized by Babylon.
  53159. * @param parsedTexture The texture information being parsedTexture
  53160. * @param scene The scene to load the texture in
  53161. * @param rootUrl The root url of the data assets to load
  53162. * @return A color gradind texture
  53163. */
  53164. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  53165. /**
  53166. * Serializes the LUT texture to json format.
  53167. */
  53168. serialize(): any;
  53169. }
  53170. }
  53171. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  53172. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53173. import { Scene } from "babylonjs/scene";
  53174. import { Nullable } from "babylonjs/types";
  53175. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53176. /**
  53177. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  53178. */
  53179. export class EquiRectangularCubeTexture extends BaseTexture {
  53180. /** The six faces of the cube. */
  53181. private static _FacesMapping;
  53182. private _noMipmap;
  53183. private _onLoad;
  53184. private _onError;
  53185. /** The size of the cubemap. */
  53186. private _size;
  53187. /** The buffer of the image. */
  53188. private _buffer;
  53189. /** The width of the input image. */
  53190. private _width;
  53191. /** The height of the input image. */
  53192. private _height;
  53193. /** The URL to the image. */
  53194. url: string;
  53195. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  53196. coordinatesMode: number;
  53197. /**
  53198. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  53199. * @param url The location of the image
  53200. * @param scene The scene the texture will be used in
  53201. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53202. * @param noMipmap Forces to not generate the mipmap if true
  53203. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  53204. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  53205. * @param onLoad — defines a callback called when texture is loaded
  53206. * @param onError — defines a callback called if there is an error
  53207. */
  53208. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  53209. /**
  53210. * Load the image data, by putting the image on a canvas and extracting its buffer.
  53211. */
  53212. private loadImage;
  53213. /**
  53214. * Convert the image buffer into a cubemap and create a CubeTexture.
  53215. */
  53216. private loadTexture;
  53217. /**
  53218. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  53219. * @param buffer The ArrayBuffer that should be converted.
  53220. * @returns The buffer as Float32Array.
  53221. */
  53222. private getFloat32ArrayFromArrayBuffer;
  53223. /**
  53224. * Get the current class name of the texture useful for serialization or dynamic coding.
  53225. * @returns "EquiRectangularCubeTexture"
  53226. */
  53227. getClassName(): string;
  53228. /**
  53229. * Create a clone of the current EquiRectangularCubeTexture and return it.
  53230. * @returns A clone of the current EquiRectangularCubeTexture.
  53231. */
  53232. clone(): EquiRectangularCubeTexture;
  53233. }
  53234. }
  53235. declare module "babylonjs/Misc/tga" {
  53236. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53237. /**
  53238. * Based on jsTGALoader - Javascript loader for TGA file
  53239. * By Vincent Thibault
  53240. * @see http://blog.robrowser.com/javascript-tga-loader.html
  53241. */
  53242. export class TGATools {
  53243. private static _TYPE_INDEXED;
  53244. private static _TYPE_RGB;
  53245. private static _TYPE_GREY;
  53246. private static _TYPE_RLE_INDEXED;
  53247. private static _TYPE_RLE_RGB;
  53248. private static _TYPE_RLE_GREY;
  53249. private static _ORIGIN_MASK;
  53250. private static _ORIGIN_SHIFT;
  53251. private static _ORIGIN_BL;
  53252. private static _ORIGIN_BR;
  53253. private static _ORIGIN_UL;
  53254. private static _ORIGIN_UR;
  53255. /**
  53256. * Gets the header of a TGA file
  53257. * @param data defines the TGA data
  53258. * @returns the header
  53259. */
  53260. static GetTGAHeader(data: Uint8Array): any;
  53261. /**
  53262. * Uploads TGA content to a Babylon Texture
  53263. * @hidden
  53264. */
  53265. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  53266. /** @hidden */
  53267. 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;
  53268. /** @hidden */
  53269. 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;
  53270. /** @hidden */
  53271. 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;
  53272. /** @hidden */
  53273. 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;
  53274. /** @hidden */
  53275. 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;
  53276. /** @hidden */
  53277. 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;
  53278. }
  53279. }
  53280. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  53281. import { Nullable } from "babylonjs/types";
  53282. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53283. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  53284. /**
  53285. * Implementation of the TGA Texture Loader.
  53286. * @hidden
  53287. */
  53288. export class _TGATextureLoader implements IInternalTextureLoader {
  53289. /**
  53290. * Defines wether the loader supports cascade loading the different faces.
  53291. */
  53292. readonly supportCascades: boolean;
  53293. /**
  53294. * This returns if the loader support the current file information.
  53295. * @param extension defines the file extension of the file being loaded
  53296. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53297. * @param fallback defines the fallback internal texture if any
  53298. * @param isBase64 defines whether the texture is encoded as a base64
  53299. * @param isBuffer defines whether the texture data are stored as a buffer
  53300. * @returns true if the loader can load the specified file
  53301. */
  53302. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  53303. /**
  53304. * Transform the url before loading if required.
  53305. * @param rootUrl the url of the texture
  53306. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53307. * @returns the transformed texture
  53308. */
  53309. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  53310. /**
  53311. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  53312. * @param rootUrl the url of the texture
  53313. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53314. * @returns the fallback texture
  53315. */
  53316. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  53317. /**
  53318. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  53319. * @param data contains the texture data
  53320. * @param texture defines the BabylonJS internal texture
  53321. * @param createPolynomials will be true if polynomials have been requested
  53322. * @param onLoad defines the callback to trigger once the texture is ready
  53323. * @param onError defines the callback to trigger in case of error
  53324. */
  53325. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  53326. /**
  53327. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  53328. * @param data contains the texture data
  53329. * @param texture defines the BabylonJS internal texture
  53330. * @param callback defines the method to call once ready to upload
  53331. */
  53332. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  53333. }
  53334. }
  53335. declare module "babylonjs/Misc/basis" {
  53336. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53337. /**
  53338. * Info about the .basis files
  53339. */
  53340. class BasisFileInfo {
  53341. /**
  53342. * If the file has alpha
  53343. */
  53344. hasAlpha: boolean;
  53345. /**
  53346. * Info about each image of the basis file
  53347. */
  53348. images: Array<{
  53349. levels: Array<{
  53350. width: number;
  53351. height: number;
  53352. transcodedPixels: ArrayBufferView;
  53353. }>;
  53354. }>;
  53355. }
  53356. /**
  53357. * Result of transcoding a basis file
  53358. */
  53359. class TranscodeResult {
  53360. /**
  53361. * Info about the .basis file
  53362. */
  53363. fileInfo: BasisFileInfo;
  53364. /**
  53365. * Format to use when loading the file
  53366. */
  53367. format: number;
  53368. }
  53369. /**
  53370. * Configuration options for the Basis transcoder
  53371. */
  53372. export class BasisTranscodeConfiguration {
  53373. /**
  53374. * Supported compression formats used to determine the supported output format of the transcoder
  53375. */
  53376. supportedCompressionFormats?: {
  53377. /**
  53378. * etc1 compression format
  53379. */
  53380. etc1?: boolean;
  53381. /**
  53382. * s3tc compression format
  53383. */
  53384. s3tc?: boolean;
  53385. /**
  53386. * pvrtc compression format
  53387. */
  53388. pvrtc?: boolean;
  53389. /**
  53390. * etc2 compression format
  53391. */
  53392. etc2?: boolean;
  53393. };
  53394. /**
  53395. * If mipmap levels should be loaded for transcoded images (Default: true)
  53396. */
  53397. loadMipmapLevels?: boolean;
  53398. /**
  53399. * Index of a single image to load (Default: all images)
  53400. */
  53401. loadSingleImage?: number;
  53402. }
  53403. /**
  53404. * Used to load .Basis files
  53405. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  53406. */
  53407. export class BasisTools {
  53408. private static _IgnoreSupportedFormats;
  53409. /**
  53410. * URL to use when loading the basis transcoder
  53411. */
  53412. static JSModuleURL: string;
  53413. /**
  53414. * URL to use when loading the wasm module for the transcoder
  53415. */
  53416. static WasmModuleURL: string;
  53417. /**
  53418. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  53419. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  53420. * @returns internal format corresponding to the Basis format
  53421. */
  53422. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  53423. private static _WorkerPromise;
  53424. private static _Worker;
  53425. private static _actionId;
  53426. private static _CreateWorkerAsync;
  53427. /**
  53428. * Transcodes a loaded image file to compressed pixel data
  53429. * @param imageData image data to transcode
  53430. * @param config configuration options for the transcoding
  53431. * @returns a promise resulting in the transcoded image
  53432. */
  53433. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  53434. /**
  53435. * Loads a texture from the transcode result
  53436. * @param texture texture load to
  53437. * @param transcodeResult the result of transcoding the basis file to load from
  53438. */
  53439. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  53440. }
  53441. }
  53442. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  53443. import { Nullable } from "babylonjs/types";
  53444. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53445. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  53446. /**
  53447. * Loader for .basis file format
  53448. */
  53449. export class _BasisTextureLoader implements IInternalTextureLoader {
  53450. /**
  53451. * Defines whether the loader supports cascade loading the different faces.
  53452. */
  53453. readonly supportCascades: boolean;
  53454. /**
  53455. * This returns if the loader support the current file information.
  53456. * @param extension defines the file extension of the file being loaded
  53457. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53458. * @param fallback defines the fallback internal texture if any
  53459. * @param isBase64 defines whether the texture is encoded as a base64
  53460. * @param isBuffer defines whether the texture data are stored as a buffer
  53461. * @returns true if the loader can load the specified file
  53462. */
  53463. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  53464. /**
  53465. * Transform the url before loading if required.
  53466. * @param rootUrl the url of the texture
  53467. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53468. * @returns the transformed texture
  53469. */
  53470. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  53471. /**
  53472. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  53473. * @param rootUrl the url of the texture
  53474. * @param textureFormatInUse defines the current compressed format in use iun the engine
  53475. * @returns the fallback texture
  53476. */
  53477. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  53478. /**
  53479. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  53480. * @param data contains the texture data
  53481. * @param texture defines the BabylonJS internal texture
  53482. * @param createPolynomials will be true if polynomials have been requested
  53483. * @param onLoad defines the callback to trigger once the texture is ready
  53484. * @param onError defines the callback to trigger in case of error
  53485. */
  53486. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  53487. /**
  53488. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  53489. * @param data contains the texture data
  53490. * @param texture defines the BabylonJS internal texture
  53491. * @param callback defines the method to call once ready to upload
  53492. */
  53493. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  53494. }
  53495. }
  53496. declare module "babylonjs/Materials/Textures/Loaders/index" {
  53497. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  53498. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  53499. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  53500. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  53501. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  53502. }
  53503. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  53504. import { Scene } from "babylonjs/scene";
  53505. import { Texture } from "babylonjs/Materials/Textures/texture";
  53506. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  53507. /**
  53508. * 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.
  53509. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  53510. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  53511. */
  53512. export class CustomProceduralTexture extends ProceduralTexture {
  53513. private _animate;
  53514. private _time;
  53515. private _config;
  53516. private _texturePath;
  53517. /**
  53518. * Instantiates a new Custom Procedural Texture.
  53519. * 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.
  53520. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  53521. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  53522. * @param name Define the name of the texture
  53523. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  53524. * @param size Define the size of the texture to create
  53525. * @param scene Define the scene the texture belongs to
  53526. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  53527. * @param generateMipMaps Define if the texture should creates mip maps or not
  53528. */
  53529. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  53530. private _loadJson;
  53531. /**
  53532. * Is the texture ready to be used ? (rendered at least once)
  53533. * @returns true if ready, otherwise, false.
  53534. */
  53535. isReady(): boolean;
  53536. /**
  53537. * Render the texture to its associated render target.
  53538. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  53539. */
  53540. render(useCameraPostProcess?: boolean): void;
  53541. /**
  53542. * Update the list of dependant textures samplers in the shader.
  53543. */
  53544. updateTextures(): void;
  53545. /**
  53546. * Update the uniform values of the procedural texture in the shader.
  53547. */
  53548. updateShaderUniforms(): void;
  53549. /**
  53550. * Define if the texture animates or not.
  53551. */
  53552. animate: boolean;
  53553. }
  53554. }
  53555. declare module "babylonjs/Shaders/noise.fragment" {
  53556. /** @hidden */
  53557. export var noisePixelShader: {
  53558. name: string;
  53559. shader: string;
  53560. };
  53561. }
  53562. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  53563. import { Nullable } from "babylonjs/types";
  53564. import { Scene } from "babylonjs/scene";
  53565. import { Texture } from "babylonjs/Materials/Textures/texture";
  53566. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  53567. import "babylonjs/Shaders/noise.fragment";
  53568. /**
  53569. * Class used to generate noise procedural textures
  53570. */
  53571. export class NoiseProceduralTexture extends ProceduralTexture {
  53572. private _time;
  53573. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  53574. brightness: number;
  53575. /** Defines the number of octaves to process */
  53576. octaves: number;
  53577. /** Defines the level of persistence (0.8 by default) */
  53578. persistence: number;
  53579. /** Gets or sets animation speed factor (default is 1) */
  53580. animationSpeedFactor: number;
  53581. /**
  53582. * Creates a new NoiseProceduralTexture
  53583. * @param name defines the name fo the texture
  53584. * @param size defines the size of the texture (default is 256)
  53585. * @param scene defines the hosting scene
  53586. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  53587. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  53588. */
  53589. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  53590. private _updateShaderUniforms;
  53591. protected _getDefines(): string;
  53592. /** Generate the current state of the procedural texture */
  53593. render(useCameraPostProcess?: boolean): void;
  53594. /**
  53595. * Serializes this noise procedural texture
  53596. * @returns a serialized noise procedural texture object
  53597. */
  53598. serialize(): any;
  53599. /**
  53600. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  53601. * @param parsedTexture defines parsed texture data
  53602. * @param scene defines the current scene
  53603. * @param rootUrl defines the root URL containing noise procedural texture information
  53604. * @returns a parsed NoiseProceduralTexture
  53605. */
  53606. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  53607. }
  53608. }
  53609. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  53610. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  53611. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  53612. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  53613. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  53614. }
  53615. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  53616. import { Nullable } from "babylonjs/types";
  53617. import { Scene } from "babylonjs/scene";
  53618. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  53619. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53620. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  53621. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53622. /**
  53623. * Raw cube texture where the raw buffers are passed in
  53624. */
  53625. export class RawCubeTexture extends CubeTexture {
  53626. /**
  53627. * Creates a cube texture where the raw buffers are passed in.
  53628. * @param scene defines the scene the texture is attached to
  53629. * @param data defines the array of data to use to create each face
  53630. * @param size defines the size of the textures
  53631. * @param format defines the format of the data
  53632. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  53633. * @param generateMipMaps defines if the engine should generate the mip levels
  53634. * @param invertY defines if data must be stored with Y axis inverted
  53635. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  53636. * @param compression defines the compression used (null by default)
  53637. */
  53638. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  53639. /**
  53640. * Updates the raw cube texture.
  53641. * @param data defines the data to store
  53642. * @param format defines the data format
  53643. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  53644. * @param invertY defines if data must be stored with Y axis inverted
  53645. * @param compression defines the compression used (null by default)
  53646. * @param level defines which level of the texture to update
  53647. */
  53648. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  53649. /**
  53650. * Updates a raw cube texture with RGBD encoded data.
  53651. * @param data defines the array of data [mipmap][face] to use to create each face
  53652. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  53653. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  53654. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  53655. * @returns a promsie that resolves when the operation is complete
  53656. */
  53657. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  53658. /**
  53659. * Clones the raw cube texture.
  53660. * @return a new cube texture
  53661. */
  53662. clone(): CubeTexture;
  53663. /** @hidden */
  53664. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  53665. }
  53666. }
  53667. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  53668. import { Scene } from "babylonjs/scene";
  53669. import { Texture } from "babylonjs/Materials/Textures/texture";
  53670. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53671. /**
  53672. * Class used to store 3D textures containing user data
  53673. */
  53674. export class RawTexture3D extends Texture {
  53675. /** Gets or sets the texture format to use */
  53676. format: number;
  53677. private _engine;
  53678. /**
  53679. * Create a new RawTexture3D
  53680. * @param data defines the data of the texture
  53681. * @param width defines the width of the texture
  53682. * @param height defines the height of the texture
  53683. * @param depth defines the depth of the texture
  53684. * @param format defines the texture format to use
  53685. * @param scene defines the hosting scene
  53686. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  53687. * @param invertY defines if texture must be stored with Y axis inverted
  53688. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  53689. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  53690. */
  53691. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  53692. /** Gets or sets the texture format to use */
  53693. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  53694. /**
  53695. * Update the texture with new data
  53696. * @param data defines the data to store in the texture
  53697. */
  53698. update(data: ArrayBufferView): void;
  53699. }
  53700. }
  53701. declare module "babylonjs/Materials/Textures/refractionTexture" {
  53702. import { Scene } from "babylonjs/scene";
  53703. import { Plane } from "babylonjs/Maths/math.plane";
  53704. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  53705. /**
  53706. * Creates a refraction texture used by refraction channel of the standard material.
  53707. * It is like a mirror but to see through a material.
  53708. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  53709. */
  53710. export class RefractionTexture extends RenderTargetTexture {
  53711. /**
  53712. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  53713. * 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.
  53714. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  53715. */
  53716. refractionPlane: Plane;
  53717. /**
  53718. * Define how deep under the surface we should see.
  53719. */
  53720. depth: number;
  53721. /**
  53722. * Creates a refraction texture used by refraction channel of the standard material.
  53723. * It is like a mirror but to see through a material.
  53724. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  53725. * @param name Define the texture name
  53726. * @param size Define the size of the underlying texture
  53727. * @param scene Define the scene the refraction belongs to
  53728. * @param generateMipMaps Define if we need to generate mips level for the refraction
  53729. */
  53730. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  53731. /**
  53732. * Clone the refraction texture.
  53733. * @returns the cloned texture
  53734. */
  53735. clone(): RefractionTexture;
  53736. /**
  53737. * Serialize the texture to a JSON representation you could use in Parse later on
  53738. * @returns the serialized JSON representation
  53739. */
  53740. serialize(): any;
  53741. }
  53742. }
  53743. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  53744. import { Nullable } from "babylonjs/types";
  53745. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53746. import { Matrix } from "babylonjs/Maths/math.vector";
  53747. import { Engine } from "babylonjs/Engines/engine";
  53748. import { Scene } from "babylonjs/scene";
  53749. /**
  53750. * Defines the options related to the creation of an HtmlElementTexture
  53751. */
  53752. export interface IHtmlElementTextureOptions {
  53753. /**
  53754. * Defines wether mip maps should be created or not.
  53755. */
  53756. generateMipMaps?: boolean;
  53757. /**
  53758. * Defines the sampling mode of the texture.
  53759. */
  53760. samplingMode?: number;
  53761. /**
  53762. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  53763. */
  53764. engine: Nullable<Engine>;
  53765. /**
  53766. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  53767. */
  53768. scene: Nullable<Scene>;
  53769. }
  53770. /**
  53771. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  53772. * To be as efficient as possible depending on your constraints nothing aside the first upload
  53773. * is automatically managed.
  53774. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  53775. * in your application.
  53776. *
  53777. * As the update is not automatic, you need to call them manually.
  53778. */
  53779. export class HtmlElementTexture extends BaseTexture {
  53780. /**
  53781. * The texture URL.
  53782. */
  53783. element: HTMLVideoElement | HTMLCanvasElement;
  53784. private static readonly DefaultOptions;
  53785. private _textureMatrix;
  53786. private _engine;
  53787. private _isVideo;
  53788. private _generateMipMaps;
  53789. private _samplingMode;
  53790. /**
  53791. * Instantiates a HtmlElementTexture from the following parameters.
  53792. *
  53793. * @param name Defines the name of the texture
  53794. * @param element Defines the video or canvas the texture is filled with
  53795. * @param options Defines the other none mandatory texture creation options
  53796. */
  53797. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  53798. private _createInternalTexture;
  53799. /**
  53800. * Returns the texture matrix used in most of the material.
  53801. */
  53802. getTextureMatrix(): Matrix;
  53803. /**
  53804. * Updates the content of the texture.
  53805. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  53806. */
  53807. update(invertY?: Nullable<boolean>): void;
  53808. }
  53809. }
  53810. declare module "babylonjs/Materials/Textures/index" {
  53811. export * from "babylonjs/Materials/Textures/baseTexture";
  53812. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  53813. export * from "babylonjs/Materials/Textures/cubeTexture";
  53814. export * from "babylonjs/Materials/Textures/dynamicTexture";
  53815. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  53816. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  53817. export * from "babylonjs/Materials/Textures/internalTexture";
  53818. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  53819. export * from "babylonjs/Materials/Textures/Loaders/index";
  53820. export * from "babylonjs/Materials/Textures/mirrorTexture";
  53821. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  53822. export * from "babylonjs/Materials/Textures/Procedurals/index";
  53823. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  53824. export * from "babylonjs/Materials/Textures/rawTexture";
  53825. export * from "babylonjs/Materials/Textures/rawTexture3D";
  53826. export * from "babylonjs/Materials/Textures/refractionTexture";
  53827. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  53828. export * from "babylonjs/Materials/Textures/texture";
  53829. export * from "babylonjs/Materials/Textures/videoTexture";
  53830. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  53831. }
  53832. declare module "babylonjs/Materials/Node/nodeMaterialBlockTargets" {
  53833. /**
  53834. * Enum used to define the target of a block
  53835. */
  53836. export enum NodeMaterialBlockTargets {
  53837. /** Vertex shader */
  53838. Vertex = 1,
  53839. /** Fragment shader */
  53840. Fragment = 2,
  53841. /** Neutral */
  53842. Neutral = 4,
  53843. /** Vertex and Fragment */
  53844. VertexAndFragment = 3
  53845. }
  53846. }
  53847. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes" {
  53848. /**
  53849. * Defines the kind of connection point for node based material
  53850. */
  53851. export enum NodeMaterialBlockConnectionPointTypes {
  53852. /** Float */
  53853. Float = 1,
  53854. /** Int */
  53855. Int = 2,
  53856. /** Vector2 */
  53857. Vector2 = 4,
  53858. /** Vector3 */
  53859. Vector3 = 8,
  53860. /** Vector4 */
  53861. Vector4 = 16,
  53862. /** Color3 */
  53863. Color3 = 32,
  53864. /** Color4 */
  53865. Color4 = 64,
  53866. /** Matrix */
  53867. Matrix = 128,
  53868. /** Detect type based on connection */
  53869. AutoDetect = 1024,
  53870. /** Output type that will be defined by input type */
  53871. BasedOnInput = 2048
  53872. }
  53873. }
  53874. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  53875. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  53876. /**
  53877. * Root class for all node material optimizers
  53878. */
  53879. export class NodeMaterialOptimizer {
  53880. /**
  53881. * Function used to optimize a NodeMaterial graph
  53882. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  53883. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  53884. */
  53885. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  53886. }
  53887. }
  53888. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  53889. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  53890. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  53891. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  53892. import { Scene } from "babylonjs/scene";
  53893. /**
  53894. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  53895. */
  53896. export class TransformBlock extends NodeMaterialBlock {
  53897. /**
  53898. * Defines the value to use to complement W value to transform it to a Vector4
  53899. */
  53900. complementW: number;
  53901. /**
  53902. * Defines the value to use to complement z value to transform it to a Vector4
  53903. */
  53904. complementZ: number;
  53905. /**
  53906. * Creates a new TransformBlock
  53907. * @param name defines the block name
  53908. */
  53909. constructor(name: string);
  53910. /**
  53911. * Gets the current class name
  53912. * @returns the class name
  53913. */
  53914. getClassName(): string;
  53915. /**
  53916. * Gets the vector input
  53917. */
  53918. readonly vector: NodeMaterialConnectionPoint;
  53919. /**
  53920. * Gets the output component
  53921. */
  53922. readonly output: NodeMaterialConnectionPoint;
  53923. /**
  53924. * Gets the matrix transform input
  53925. */
  53926. readonly transform: NodeMaterialConnectionPoint;
  53927. protected _buildBlock(state: NodeMaterialBuildState): this;
  53928. serialize(): any;
  53929. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  53930. }
  53931. }
  53932. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  53933. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  53934. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  53935. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  53936. /**
  53937. * Block used to output the vertex position
  53938. */
  53939. export class VertexOutputBlock extends NodeMaterialBlock {
  53940. /**
  53941. * Creates a new VertexOutputBlock
  53942. * @param name defines the block name
  53943. */
  53944. constructor(name: string);
  53945. /**
  53946. * Gets the current class name
  53947. * @returns the class name
  53948. */
  53949. getClassName(): string;
  53950. /**
  53951. * Gets the vector input component
  53952. */
  53953. readonly vector: NodeMaterialConnectionPoint;
  53954. protected _buildBlock(state: NodeMaterialBuildState): this;
  53955. }
  53956. }
  53957. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  53958. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  53959. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  53960. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  53961. /**
  53962. * Block used to output the final color
  53963. */
  53964. export class FragmentOutputBlock extends NodeMaterialBlock {
  53965. /**
  53966. * Create a new FragmentOutputBlock
  53967. * @param name defines the block name
  53968. */
  53969. constructor(name: string);
  53970. /**
  53971. * Gets the current class name
  53972. * @returns the class name
  53973. */
  53974. getClassName(): string;
  53975. /**
  53976. * Gets the rgba input component
  53977. */
  53978. readonly rgba: NodeMaterialConnectionPoint;
  53979. /**
  53980. * Gets the rgb input component
  53981. */
  53982. readonly rgb: NodeMaterialConnectionPoint;
  53983. /**
  53984. * Gets the a input component
  53985. */
  53986. readonly a: NodeMaterialConnectionPoint;
  53987. protected _buildBlock(state: NodeMaterialBuildState): this;
  53988. }
  53989. }
  53990. declare module "babylonjs/Materials/Node/nodeMaterial" {
  53991. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  53992. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  53993. import { Scene } from "babylonjs/scene";
  53994. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53995. import { Matrix } from "babylonjs/Maths/math.vector";
  53996. import { Mesh } from "babylonjs/Meshes/mesh";
  53997. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53998. import { Observable } from "babylonjs/Misc/observable";
  53999. import { SubMesh } from "babylonjs/Meshes/subMesh";
  54000. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  54001. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  54002. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  54003. import { Nullable } from "babylonjs/types";
  54004. /**
  54005. * Interface used to configure the node material editor
  54006. */
  54007. export interface INodeMaterialEditorOptions {
  54008. /** Define the URl to load node editor script */
  54009. editorURL?: string;
  54010. }
  54011. /** @hidden */
  54012. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  54013. /** BONES */
  54014. NUM_BONE_INFLUENCERS: number;
  54015. BonesPerMesh: number;
  54016. BONETEXTURE: boolean;
  54017. /** MORPH TARGETS */
  54018. MORPHTARGETS: boolean;
  54019. MORPHTARGETS_NORMAL: boolean;
  54020. MORPHTARGETS_TANGENT: boolean;
  54021. MORPHTARGETS_UV: boolean;
  54022. NUM_MORPH_INFLUENCERS: number;
  54023. /** IMAGE PROCESSING */
  54024. IMAGEPROCESSING: boolean;
  54025. VIGNETTE: boolean;
  54026. VIGNETTEBLENDMODEMULTIPLY: boolean;
  54027. VIGNETTEBLENDMODEOPAQUE: boolean;
  54028. TONEMAPPING: boolean;
  54029. TONEMAPPING_ACES: boolean;
  54030. CONTRAST: boolean;
  54031. EXPOSURE: boolean;
  54032. COLORCURVES: boolean;
  54033. COLORGRADING: boolean;
  54034. COLORGRADING3D: boolean;
  54035. SAMPLER3DGREENDEPTH: boolean;
  54036. SAMPLER3DBGRMAP: boolean;
  54037. IMAGEPROCESSINGPOSTPROCESS: boolean;
  54038. constructor();
  54039. setValue(name: string, value: boolean): void;
  54040. }
  54041. /**
  54042. * Class used to configure NodeMaterial
  54043. */
  54044. export interface INodeMaterialOptions {
  54045. /**
  54046. * Defines if blocks should emit comments
  54047. */
  54048. emitComments: boolean;
  54049. }
  54050. /**
  54051. * Class used to create a node based material built by assembling shader blocks
  54052. */
  54053. export class NodeMaterial extends PushMaterial {
  54054. private static _BuildIdGenerator;
  54055. private _options;
  54056. private _vertexCompilationState;
  54057. private _fragmentCompilationState;
  54058. private _sharedData;
  54059. private _buildId;
  54060. private _buildWasSuccessful;
  54061. private _cachedWorldViewMatrix;
  54062. private _cachedWorldViewProjectionMatrix;
  54063. private _optimizers;
  54064. /** Define the URl to load node editor script */
  54065. static EditorURL: string;
  54066. private BJSNODEMATERIALEDITOR;
  54067. /** Get the inspector from bundle or global */
  54068. private _getGlobalNodeMaterialEditor;
  54069. /**
  54070. * 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)
  54071. */
  54072. ignoreAlpha: boolean;
  54073. /**
  54074. * Defines the maximum number of lights that can be used in the material
  54075. */
  54076. maxSimultaneousLights: number;
  54077. /**
  54078. * Observable raised when the material is built
  54079. */
  54080. onBuildObservable: Observable<NodeMaterial>;
  54081. /**
  54082. * Gets or sets the root nodes of the material vertex shader
  54083. */
  54084. _vertexOutputNodes: NodeMaterialBlock[];
  54085. /**
  54086. * Gets or sets the root nodes of the material fragment (pixel) shader
  54087. */
  54088. _fragmentOutputNodes: NodeMaterialBlock[];
  54089. /** Gets or sets options to control the node material overall behavior */
  54090. options: INodeMaterialOptions;
  54091. /**
  54092. * Default configuration related to image processing available in the standard Material.
  54093. */
  54094. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  54095. /**
  54096. * Gets the image processing configuration used either in this material.
  54097. */
  54098. /**
  54099. * Sets the Default image processing configuration used either in the this material.
  54100. *
  54101. * If sets to null, the scene one is in use.
  54102. */
  54103. imageProcessingConfiguration: ImageProcessingConfiguration;
  54104. /**
  54105. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  54106. */
  54107. attachedBlocks: NodeMaterialBlock[];
  54108. /**
  54109. * Create a new node based material
  54110. * @param name defines the material name
  54111. * @param scene defines the hosting scene
  54112. * @param options defines creation option
  54113. */
  54114. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  54115. /**
  54116. * Gets the current class name of the material e.g. "NodeMaterial"
  54117. * @returns the class name
  54118. */
  54119. getClassName(): string;
  54120. /**
  54121. * Keep track of the image processing observer to allow dispose and replace.
  54122. */
  54123. private _imageProcessingObserver;
  54124. /**
  54125. * Attaches a new image processing configuration to the Standard Material.
  54126. * @param configuration
  54127. */
  54128. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  54129. /**
  54130. * Adds a new optimizer to the list of optimizers
  54131. * @param optimizer defines the optimizers to add
  54132. * @returns the current material
  54133. */
  54134. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  54135. /**
  54136. * Remove an optimizer from the list of optimizers
  54137. * @param optimizer defines the optimizers to remove
  54138. * @returns the current material
  54139. */
  54140. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  54141. /**
  54142. * Add a new block to the list of output nodes
  54143. * @param node defines the node to add
  54144. * @returns the current material
  54145. */
  54146. addOutputNode(node: NodeMaterialBlock): this;
  54147. /**
  54148. * Remove a block from the list of root nodes
  54149. * @param node defines the node to remove
  54150. * @returns the current material
  54151. */
  54152. removeOutputNode(node: NodeMaterialBlock): this;
  54153. private _addVertexOutputNode;
  54154. private _removeVertexOutputNode;
  54155. private _addFragmentOutputNode;
  54156. private _removeFragmentOutputNode;
  54157. /**
  54158. * Specifies if the material will require alpha blending
  54159. * @returns a boolean specifying if alpha blending is needed
  54160. */
  54161. needAlphaBlending(): boolean;
  54162. /**
  54163. * Specifies if this material should be rendered in alpha test mode
  54164. * @returns a boolean specifying if an alpha test is needed.
  54165. */
  54166. needAlphaTesting(): boolean;
  54167. private _initializeBlock;
  54168. private _resetDualBlocks;
  54169. /**
  54170. * Build the material and generates the inner effect
  54171. * @param verbose defines if the build should log activity
  54172. */
  54173. build(verbose?: boolean): void;
  54174. /**
  54175. * Runs an otpimization phase to try to improve the shader code
  54176. */
  54177. optimize(): void;
  54178. private _prepareDefinesForAttributes;
  54179. /**
  54180. * Get if the submesh is ready to be used and all its information available.
  54181. * Child classes can use it to update shaders
  54182. * @param mesh defines the mesh to check
  54183. * @param subMesh defines which submesh to check
  54184. * @param useInstances specifies that instances should be used
  54185. * @returns a boolean indicating that the submesh is ready or not
  54186. */
  54187. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  54188. /**
  54189. * Get a string representing the shaders built by the current node graph
  54190. */
  54191. readonly compiledShaders: string;
  54192. /**
  54193. * Binds the world matrix to the material
  54194. * @param world defines the world transformation matrix
  54195. */
  54196. bindOnlyWorldMatrix(world: Matrix): void;
  54197. /**
  54198. * Binds the submesh to this material by preparing the effect and shader to draw
  54199. * @param world defines the world transformation matrix
  54200. * @param mesh defines the mesh containing the submesh
  54201. * @param subMesh defines the submesh to bind the material to
  54202. */
  54203. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  54204. /**
  54205. * Gets the active textures from the material
  54206. * @returns an array of textures
  54207. */
  54208. getActiveTextures(): BaseTexture[];
  54209. /**
  54210. * Specifies if the material uses a texture
  54211. * @param texture defines the texture to check against the material
  54212. * @returns a boolean specifying if the material uses the texture
  54213. */
  54214. hasTexture(texture: BaseTexture): boolean;
  54215. /**
  54216. * Disposes the material
  54217. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  54218. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  54219. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  54220. */
  54221. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  54222. /** Creates the node editor window. */
  54223. private _createNodeEditor;
  54224. /**
  54225. * Launch the node material editor
  54226. * @param config Define the configuration of the editor
  54227. * @return a promise fulfilled when the node editor is visible
  54228. */
  54229. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  54230. /**
  54231. * Clear the current material
  54232. */
  54233. clear(): void;
  54234. /**
  54235. * Clear the current material and set it to a default state
  54236. */
  54237. setToDefault(): void;
  54238. private _gatherBlocks;
  54239. /**
  54240. * Serializes this material in a JSON representation
  54241. * @returns the serialized material object
  54242. */
  54243. serialize(): any;
  54244. /**
  54245. * Clear the current graph and load a new one from a serialization object
  54246. * @param source defines the JSON representation of the material
  54247. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  54248. */
  54249. loadFromSerialization(source: any, rootUrl?: string): void;
  54250. /**
  54251. * Creates a node material from parsed material data
  54252. * @param source defines the JSON representation of the material
  54253. * @param scene defines the hosting scene
  54254. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  54255. * @returns a new node material
  54256. */
  54257. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  54258. }
  54259. }
  54260. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  54261. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54262. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54263. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54264. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54265. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54266. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  54267. import { Effect } from "babylonjs/Materials/effect";
  54268. import { Mesh } from "babylonjs/Meshes/mesh";
  54269. import { Nullable } from "babylonjs/types";
  54270. import { Scene } from "babylonjs/scene";
  54271. /**
  54272. * Block used to read a texture from a sampler
  54273. */
  54274. export class TextureBlock extends NodeMaterialBlock {
  54275. private _defineName;
  54276. private _samplerName;
  54277. private _transformedUVName;
  54278. private _textureTransformName;
  54279. private _textureInfoName;
  54280. private _mainUVName;
  54281. private _mainUVDefineName;
  54282. /**
  54283. * Gets or sets the texture associated with the node
  54284. */
  54285. texture: Nullable<BaseTexture>;
  54286. /**
  54287. * Create a new TextureBlock
  54288. * @param name defines the block name
  54289. */
  54290. constructor(name: string);
  54291. /**
  54292. * Gets the current class name
  54293. * @returns the class name
  54294. */
  54295. getClassName(): string;
  54296. /**
  54297. * Gets the uv input component
  54298. */
  54299. readonly uv: NodeMaterialConnectionPoint;
  54300. /**
  54301. * Gets the output component
  54302. */
  54303. readonly output: NodeMaterialConnectionPoint;
  54304. autoConfigure(): void;
  54305. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  54306. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  54307. isReady(): boolean;
  54308. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  54309. private _injectVertexCode;
  54310. private _writeOutput;
  54311. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  54312. serialize(): any;
  54313. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  54314. }
  54315. }
  54316. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  54317. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54318. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54319. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  54320. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  54321. /**
  54322. * Class used to store shared data between 2 NodeMaterialBuildState
  54323. */
  54324. export class NodeMaterialBuildStateSharedData {
  54325. /**
  54326. * Gets the list of emitted varyings
  54327. */
  54328. varyings: string[];
  54329. /**
  54330. * Gets the varying declaration string
  54331. */
  54332. varyingDeclaration: string;
  54333. /**
  54334. * Input blocks
  54335. */
  54336. inputBlocks: InputBlock[];
  54337. /**
  54338. * Input blocks
  54339. */
  54340. textureBlocks: TextureBlock[];
  54341. /**
  54342. * Bindable blocks (Blocks that need to set data to the effect)
  54343. */
  54344. bindableBlocks: NodeMaterialBlock[];
  54345. /**
  54346. * List of blocks that can provide a compilation fallback
  54347. */
  54348. blocksWithFallbacks: NodeMaterialBlock[];
  54349. /**
  54350. * List of blocks that can provide a define update
  54351. */
  54352. blocksWithDefines: NodeMaterialBlock[];
  54353. /**
  54354. * List of blocks that can provide a repeatable content
  54355. */
  54356. repeatableContentBlocks: NodeMaterialBlock[];
  54357. /**
  54358. * List of blocks that can provide a dynamic list of uniforms
  54359. */
  54360. dynamicUniformBlocks: NodeMaterialBlock[];
  54361. /**
  54362. * List of blocks that can block the isReady function for the material
  54363. */
  54364. blockingBlocks: NodeMaterialBlock[];
  54365. /**
  54366. * Build Id used to avoid multiple recompilations
  54367. */
  54368. buildId: number;
  54369. /** List of emitted variables */
  54370. variableNames: {
  54371. [key: string]: number;
  54372. };
  54373. /** List of emitted defines */
  54374. defineNames: {
  54375. [key: string]: number;
  54376. };
  54377. /** Should emit comments? */
  54378. emitComments: boolean;
  54379. /** Emit build activity */
  54380. verbose: boolean;
  54381. /**
  54382. * Gets the compilation hints emitted at compilation time
  54383. */
  54384. hints: {
  54385. needWorldViewMatrix: boolean;
  54386. needWorldViewProjectionMatrix: boolean;
  54387. needAlphaBlending: boolean;
  54388. needAlphaTesting: boolean;
  54389. };
  54390. /**
  54391. * List of compilation checks
  54392. */
  54393. checks: {
  54394. emitVertex: boolean;
  54395. emitFragment: boolean;
  54396. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  54397. };
  54398. /** Creates a new shared data */
  54399. constructor();
  54400. /**
  54401. * Emits console errors and exceptions if there is a failing check
  54402. */
  54403. emitErrors(): void;
  54404. }
  54405. }
  54406. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  54407. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  54408. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  54409. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  54410. /**
  54411. * Class used to store node based material build state
  54412. */
  54413. export class NodeMaterialBuildState {
  54414. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  54415. supportUniformBuffers: boolean;
  54416. /**
  54417. * Gets the list of emitted attributes
  54418. */
  54419. attributes: string[];
  54420. /**
  54421. * Gets the list of emitted uniforms
  54422. */
  54423. uniforms: string[];
  54424. /**
  54425. * Gets the list of emitted uniform buffers
  54426. */
  54427. uniformBuffers: string[];
  54428. /**
  54429. * Gets the list of emitted samplers
  54430. */
  54431. samplers: string[];
  54432. /**
  54433. * Gets the list of emitted functions
  54434. */
  54435. functions: {
  54436. [key: string]: string;
  54437. };
  54438. /**
  54439. * Gets the target of the compilation state
  54440. */
  54441. target: NodeMaterialBlockTargets;
  54442. /**
  54443. * Gets the list of emitted counters
  54444. */
  54445. counters: {
  54446. [key: string]: number;
  54447. };
  54448. /**
  54449. * Shared data between multiple NodeMaterialBuildState instances
  54450. */
  54451. sharedData: NodeMaterialBuildStateSharedData;
  54452. /** @hidden */
  54453. _vertexState: NodeMaterialBuildState;
  54454. /** @hidden */
  54455. _attributeDeclaration: string;
  54456. /** @hidden */
  54457. _uniformDeclaration: string;
  54458. /** @hidden */
  54459. _samplerDeclaration: string;
  54460. /** @hidden */
  54461. _varyingTransfer: string;
  54462. private _repeatableContentAnchorIndex;
  54463. /** @hidden */
  54464. _builtCompilationString: string;
  54465. /**
  54466. * Gets the emitted compilation strings
  54467. */
  54468. compilationString: string;
  54469. /**
  54470. * Finalize the compilation strings
  54471. * @param state defines the current compilation state
  54472. */
  54473. finalize(state: NodeMaterialBuildState): void;
  54474. /** @hidden */
  54475. readonly _repeatableContentAnchor: string;
  54476. /** @hidden */
  54477. _getFreeVariableName(prefix: string): string;
  54478. /** @hidden */
  54479. _getFreeDefineName(prefix: string): string;
  54480. /** @hidden */
  54481. _excludeVariableName(name: string): void;
  54482. /** @hidden */
  54483. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  54484. /** @hidden */
  54485. _emitFunction(name: string, code: string, comments: string): void;
  54486. /** @hidden */
  54487. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  54488. replaceStrings?: {
  54489. search: RegExp;
  54490. replace: string;
  54491. }[];
  54492. repeatKey?: string;
  54493. }): string;
  54494. /** @hidden */
  54495. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  54496. repeatKey?: string;
  54497. removeAttributes?: boolean;
  54498. removeUniforms?: boolean;
  54499. removeVaryings?: boolean;
  54500. removeIfDef?: boolean;
  54501. replaceStrings?: {
  54502. search: RegExp;
  54503. replace: string;
  54504. }[];
  54505. }, storeKey?: string): void;
  54506. /** @hidden */
  54507. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  54508. /** @hidden */
  54509. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  54510. }
  54511. }
  54512. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  54513. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  54514. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54515. import { Nullable } from "babylonjs/types";
  54516. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54517. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  54518. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  54519. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54520. import { Mesh } from "babylonjs/Meshes/mesh";
  54521. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  54522. import { Scene } from "babylonjs/scene";
  54523. /**
  54524. * Defines a block that can be used inside a node based material
  54525. */
  54526. export class NodeMaterialBlock {
  54527. private _buildId;
  54528. private _buildTarget;
  54529. private _target;
  54530. private _isFinalMerger;
  54531. private _isInput;
  54532. /** @hidden */
  54533. _inputs: NodeMaterialConnectionPoint[];
  54534. /** @hidden */
  54535. _outputs: NodeMaterialConnectionPoint[];
  54536. /**
  54537. * Gets or sets the name of the block
  54538. */
  54539. name: string;
  54540. /**
  54541. * Gets or sets the unique id of the node
  54542. */
  54543. uniqueId: number;
  54544. /**
  54545. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  54546. */
  54547. readonly isFinalMerger: boolean;
  54548. /**
  54549. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  54550. */
  54551. readonly isInput: boolean;
  54552. /**
  54553. * Gets or sets the build Id
  54554. */
  54555. buildId: number;
  54556. /**
  54557. * Gets or sets the target of the block
  54558. */
  54559. target: NodeMaterialBlockTargets;
  54560. /**
  54561. * Gets the list of input points
  54562. */
  54563. readonly inputs: NodeMaterialConnectionPoint[];
  54564. /** Gets the list of output points */
  54565. readonly outputs: NodeMaterialConnectionPoint[];
  54566. /**
  54567. * Find an input by its name
  54568. * @param name defines the name of the input to look for
  54569. * @returns the input or null if not found
  54570. */
  54571. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  54572. /**
  54573. * Find an output by its name
  54574. * @param name defines the name of the outputto look for
  54575. * @returns the output or null if not found
  54576. */
  54577. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  54578. /**
  54579. * Creates a new NodeMaterialBlock
  54580. * @param name defines the block name
  54581. * @param target defines the target of that block (Vertex by default)
  54582. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  54583. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  54584. */
  54585. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  54586. /**
  54587. * Initialize the block and prepare the context for build
  54588. * @param state defines the state that will be used for the build
  54589. */
  54590. initialize(state: NodeMaterialBuildState): void;
  54591. /**
  54592. * Bind data to effect. Will only be called for blocks with isBindable === true
  54593. * @param effect defines the effect to bind data to
  54594. * @param nodeMaterial defines the hosting NodeMaterial
  54595. * @param mesh defines the mesh that will be rendered
  54596. */
  54597. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  54598. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  54599. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  54600. protected _writeFloat(value: number): string;
  54601. /**
  54602. * Gets the current class name e.g. "NodeMaterialBlock"
  54603. * @returns the class name
  54604. */
  54605. getClassName(): string;
  54606. /**
  54607. * Register a new input. Must be called inside a block constructor
  54608. * @param name defines the connection point name
  54609. * @param type defines the connection point type
  54610. * @param isOptional defines a boolean indicating that this input can be omitted
  54611. * @param target defines the target to use to limit the connection point (will be VetexAndFragment by default)
  54612. * @returns the current block
  54613. */
  54614. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  54615. /**
  54616. * Register a new output. Must be called inside a block constructor
  54617. * @param name defines the connection point name
  54618. * @param type defines the connection point type
  54619. * @param target defines the target to use to limit the connection point (will be VetexAndFragment by default)
  54620. * @returns the current block
  54621. */
  54622. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  54623. /**
  54624. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  54625. * @param forOutput defines an optional connection point to check compatibility with
  54626. * @returns the first available input or null
  54627. */
  54628. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  54629. /**
  54630. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  54631. * @param forBlock defines an optional block to check compatibility with
  54632. * @returns the first available input or null
  54633. */
  54634. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  54635. /**
  54636. * Connect current block with another block
  54637. * @param other defines the block to connect with
  54638. * @param options define the various options to help pick the right connections
  54639. * @returns the current block
  54640. */
  54641. connectTo(other: NodeMaterialBlock, options?: {
  54642. input?: string;
  54643. output?: string;
  54644. outputSwizzle?: string;
  54645. }): this | undefined;
  54646. protected _buildBlock(state: NodeMaterialBuildState): void;
  54647. /**
  54648. * Add uniforms, samplers and uniform buffers at compilation time
  54649. * @param state defines the state to update
  54650. * @param nodeMaterial defines the node material requesting the update
  54651. * @param defines defines the material defines to update
  54652. */
  54653. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  54654. /**
  54655. * Add potential fallbacks if shader compilation fails
  54656. * @param mesh defines the mesh to be rendered
  54657. * @param fallbacks defines the current prioritized list of fallbacks
  54658. */
  54659. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  54660. /**
  54661. * Update defines for shader compilation
  54662. * @param mesh defines the mesh to be rendered
  54663. * @param nodeMaterial defines the node material requesting the update
  54664. * @param defines defines the material defines to update
  54665. * @param useInstances specifies that instances should be used
  54666. */
  54667. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  54668. /**
  54669. * Initialize defines for shader compilation
  54670. * @param mesh defines the mesh to be rendered
  54671. * @param nodeMaterial defines the node material requesting the update
  54672. * @param defines defines the material defines to be prepared
  54673. * @param useInstances specifies that instances should be used
  54674. */
  54675. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  54676. /**
  54677. * Lets the block try to connect some inputs automatically
  54678. */
  54679. autoConfigure(): void;
  54680. /**
  54681. * Function called when a block is declared as repeatable content generator
  54682. * @param vertexShaderState defines the current compilation state for the vertex shader
  54683. * @param fragmentShaderState defines the current compilation state for the fragment shader
  54684. * @param mesh defines the mesh to be rendered
  54685. * @param defines defines the material defines to update
  54686. */
  54687. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  54688. /**
  54689. * Checks if the block is ready
  54690. * @param mesh defines the mesh to be rendered
  54691. * @param nodeMaterial defines the node material requesting the update
  54692. * @param defines defines the material defines to update
  54693. * @param useInstances specifies that instances should be used
  54694. * @returns true if the block is ready
  54695. */
  54696. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  54697. private _processBuild;
  54698. /**
  54699. * Compile the current node and generate the shader code
  54700. * @param state defines the current compilation state (uniforms, samplers, current string)
  54701. * @param contextSwitched indicates that the previous block was built for a different context (vertex vs. fragment)
  54702. * @returns true if already built
  54703. */
  54704. build(state: NodeMaterialBuildState, contextSwitched?: boolean): boolean;
  54705. /**
  54706. * Serializes this block in a JSON representation
  54707. * @returns the serialized block object
  54708. */
  54709. serialize(): any;
  54710. /** @hidden */
  54711. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  54712. }
  54713. }
  54714. declare module "babylonjs/Materials/Node/NodeMaterialBlockConnectionPointMode" {
  54715. /**
  54716. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  54717. */
  54718. export enum NodeMaterialBlockConnectionPointMode {
  54719. /** Value is an uniform */
  54720. Uniform = 0,
  54721. /** Value is a mesh attribute */
  54722. Attribute = 1,
  54723. /** Value is a varying between vertex and fragment shaders */
  54724. Varying = 2,
  54725. /** Mode is undefined */
  54726. Undefined = 3
  54727. }
  54728. }
  54729. declare module "babylonjs/Materials/Node/nodeMaterialWellKnownValues" {
  54730. /**
  54731. * Enum used to define well known values e.g. values automatically provided by the system
  54732. */
  54733. export enum NodeMaterialWellKnownValues {
  54734. /** World */
  54735. World = 1,
  54736. /** View */
  54737. View = 2,
  54738. /** Projection */
  54739. Projection = 3,
  54740. /** ViewProjection */
  54741. ViewProjection = 4,
  54742. /** WorldView */
  54743. WorldView = 5,
  54744. /** WorldViewProjection */
  54745. WorldViewProjection = 6,
  54746. /** CameraPosition */
  54747. CameraPosition = 7,
  54748. /** Fog Color */
  54749. FogColor = 8
  54750. }
  54751. }
  54752. declare module "babylonjs/Maths/math.vertexFormat" {
  54753. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  54754. /**
  54755. * Contains position and normal vectors for a vertex
  54756. */
  54757. export class PositionNormalVertex {
  54758. /** the position of the vertex (defaut: 0,0,0) */
  54759. position: Vector3;
  54760. /** the normal of the vertex (defaut: 0,1,0) */
  54761. normal: Vector3;
  54762. /**
  54763. * Creates a PositionNormalVertex
  54764. * @param position the position of the vertex (defaut: 0,0,0)
  54765. * @param normal the normal of the vertex (defaut: 0,1,0)
  54766. */
  54767. constructor(
  54768. /** the position of the vertex (defaut: 0,0,0) */
  54769. position?: Vector3,
  54770. /** the normal of the vertex (defaut: 0,1,0) */
  54771. normal?: Vector3);
  54772. /**
  54773. * Clones the PositionNormalVertex
  54774. * @returns the cloned PositionNormalVertex
  54775. */
  54776. clone(): PositionNormalVertex;
  54777. }
  54778. /**
  54779. * Contains position, normal and uv vectors for a vertex
  54780. */
  54781. export class PositionNormalTextureVertex {
  54782. /** the position of the vertex (defaut: 0,0,0) */
  54783. position: Vector3;
  54784. /** the normal of the vertex (defaut: 0,1,0) */
  54785. normal: Vector3;
  54786. /** the uv of the vertex (default: 0,0) */
  54787. uv: Vector2;
  54788. /**
  54789. * Creates a PositionNormalTextureVertex
  54790. * @param position the position of the vertex (defaut: 0,0,0)
  54791. * @param normal the normal of the vertex (defaut: 0,1,0)
  54792. * @param uv the uv of the vertex (default: 0,0)
  54793. */
  54794. constructor(
  54795. /** the position of the vertex (defaut: 0,0,0) */
  54796. position?: Vector3,
  54797. /** the normal of the vertex (defaut: 0,1,0) */
  54798. normal?: Vector3,
  54799. /** the uv of the vertex (default: 0,0) */
  54800. uv?: Vector2);
  54801. /**
  54802. * Clones the PositionNormalTextureVertex
  54803. * @returns the cloned PositionNormalTextureVertex
  54804. */
  54805. clone(): PositionNormalTextureVertex;
  54806. }
  54807. }
  54808. declare module "babylonjs/Maths/math" {
  54809. export * from "babylonjs/Maths/math.axis";
  54810. export * from "babylonjs/Maths/math.color";
  54811. export * from "babylonjs/Maths/math.constants";
  54812. export * from "babylonjs/Maths/math.frustum";
  54813. export * from "babylonjs/Maths/math.path";
  54814. export * from "babylonjs/Maths/math.plane";
  54815. export * from "babylonjs/Maths/math.size";
  54816. export * from "babylonjs/Maths/math.vector";
  54817. export * from "babylonjs/Maths/math.vertexFormat";
  54818. export * from "babylonjs/Maths/math.viewport";
  54819. }
  54820. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  54821. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54822. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  54823. import { NodeMaterialWellKnownValues } from "babylonjs/Materials/Node/nodeMaterialWellKnownValues";
  54824. import { Nullable } from "babylonjs/types";
  54825. import { Effect } from "babylonjs/Materials/effect";
  54826. import { Matrix } from "babylonjs/Maths/math.vector";
  54827. import { Scene } from "babylonjs/scene";
  54828. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  54829. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  54830. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  54831. /**
  54832. * Block used to expose an input value
  54833. */
  54834. export class InputBlock extends NodeMaterialBlock {
  54835. private _mode;
  54836. private _associatedVariableName;
  54837. private _storedValue;
  54838. private _valueCallback;
  54839. private _type;
  54840. /** @hidden */
  54841. _wellKnownValue: Nullable<NodeMaterialWellKnownValues>;
  54842. /**
  54843. * Gets or sets the connection point type (default is float)
  54844. */
  54845. readonly type: NodeMaterialBlockConnectionPointTypes;
  54846. /**
  54847. * Creates a new InputBlock
  54848. * @param name defines the block name
  54849. * @param target defines the target of that block (Vertex by default)
  54850. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  54851. */
  54852. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  54853. /**
  54854. * Gets the output component
  54855. */
  54856. readonly output: NodeMaterialConnectionPoint;
  54857. /**
  54858. * Set the source of this connection point to a vertex attribute
  54859. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  54860. * @returns the current connection point
  54861. */
  54862. setAsAttribute(attributeName?: string): InputBlock;
  54863. /**
  54864. * Set the source of this connection point to a well known value
  54865. * @param value define the well known value to use (world, view, etc...) or null to switch to manual value
  54866. * @returns the current connection point
  54867. */
  54868. setAsWellKnownValue(value: Nullable<NodeMaterialWellKnownValues>): InputBlock;
  54869. /**
  54870. * Gets or sets the value of that point.
  54871. * Please note that this value will be ignored if valueCallback is defined
  54872. */
  54873. value: any;
  54874. /**
  54875. * Gets or sets a callback used to get the value of that point.
  54876. * Please note that setting this value will force the connection point to ignore the value property
  54877. */
  54878. valueCallback: () => any;
  54879. /**
  54880. * Gets or sets the associated variable name in the shader
  54881. */
  54882. associatedVariableName: string;
  54883. /**
  54884. * Gets a boolean indicating that this connection point not defined yet
  54885. */
  54886. readonly isUndefined: boolean;
  54887. /**
  54888. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  54889. * In this case the connection point name must be the name of the uniform to use.
  54890. * Can only be set on inputs
  54891. */
  54892. isUniform: boolean;
  54893. /**
  54894. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  54895. * In this case the connection point name must be the name of the attribute to use
  54896. * Can only be set on inputs
  54897. */
  54898. isAttribute: boolean;
  54899. /**
  54900. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  54901. * Can only be set on exit points
  54902. */
  54903. isVarying: boolean;
  54904. /**
  54905. * Gets a boolean indicating that the current connection point is a well known value
  54906. */
  54907. readonly isWellKnownValue: boolean;
  54908. /**
  54909. * Gets or sets the current well known value or null if not defined as well know value
  54910. */
  54911. wellKnownValue: Nullable<NodeMaterialWellKnownValues>;
  54912. /**
  54913. * Gets the current class name
  54914. * @returns the class name
  54915. */
  54916. getClassName(): string;
  54917. private _emitDefine;
  54918. /**
  54919. * Set the input block to its default value (based on its type)
  54920. */
  54921. setDefaultValue(): void;
  54922. private _emit;
  54923. /** @hidden */
  54924. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  54925. /** @hidden */
  54926. _transmit(effect: Effect, scene: Scene): void;
  54927. protected _buildBlock(state: NodeMaterialBuildState): void;
  54928. serialize(): any;
  54929. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  54930. }
  54931. }
  54932. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  54933. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  54934. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  54935. import { Nullable } from "babylonjs/types";
  54936. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  54937. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  54938. /**
  54939. * Defines a connection point for a block
  54940. */
  54941. export class NodeMaterialConnectionPoint {
  54942. /** @hidden */
  54943. _ownerBlock: NodeMaterialBlock;
  54944. /** @hidden */
  54945. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  54946. private _endpoints;
  54947. private _associatedVariableName;
  54948. /** @hidden */
  54949. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  54950. private _type;
  54951. /** @hidden */
  54952. _enforceAssociatedVariableName: boolean;
  54953. /**
  54954. * Gets or sets the additional types supported byt this connection point
  54955. */
  54956. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  54957. /**
  54958. * Gets or sets the associated variable name in the shader
  54959. */
  54960. associatedVariableName: string;
  54961. /**
  54962. * Gets or sets the connection point type (default is float)
  54963. */
  54964. type: NodeMaterialBlockConnectionPointTypes;
  54965. /**
  54966. * Gets or sets the connection point name
  54967. */
  54968. name: string;
  54969. /**
  54970. * Gets or sets a boolean indicating that this connection point can be omitted
  54971. */
  54972. isOptional: boolean;
  54973. /**
  54974. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  54975. */
  54976. define: string;
  54977. /** Gets or sets the target of that connection point */
  54978. target: NodeMaterialBlockTargets;
  54979. /**
  54980. * Gets a boolean indicating that the current point is connected
  54981. */
  54982. readonly isConnected: boolean;
  54983. /**
  54984. * Gets a boolean indicating that the current point is connected to an input block
  54985. */
  54986. readonly isConnectedToInput: boolean;
  54987. /**
  54988. * Gets a the connected input block (if any)
  54989. */
  54990. readonly connectInputBlock: Nullable<InputBlock>;
  54991. /** Get the other side of the connection (if any) */
  54992. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  54993. /** Get the block that owns this connection point */
  54994. readonly ownerBlock: NodeMaterialBlock;
  54995. /** Get the block connected on the other side of this connection (if any) */
  54996. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  54997. /** Get the block connected on the endpoints of this connection (if any) */
  54998. readonly connectedBlocks: Array<NodeMaterialBlock>;
  54999. /** Gets the list of connected endpoints */
  55000. readonly endpoints: NodeMaterialConnectionPoint[];
  55001. /**
  55002. * Creates a new connection point
  55003. * @param name defines the connection point name
  55004. * @param ownerBlock defines the block hosting this connection point
  55005. */
  55006. constructor(name: string, ownerBlock: NodeMaterialBlock);
  55007. /**
  55008. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  55009. * @returns the class name
  55010. */
  55011. getClassName(): string;
  55012. /**
  55013. * Gets an boolean indicating if the current point can be connected to another point
  55014. * @param connectionPoint defines the other connection point
  55015. * @returns true if the connection is possible
  55016. */
  55017. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  55018. /**
  55019. * Connect this point to another connection point
  55020. * @param connectionPoint defines the other connection point
  55021. * @returns the current connection point
  55022. */
  55023. connectTo(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  55024. /**
  55025. * Disconnect this point from one of his endpoint
  55026. * @param endpoint defines the other connection point
  55027. * @returns the current connection point
  55028. */
  55029. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  55030. /**
  55031. * Serializes this point in a JSON representation
  55032. * @returns the serialized point object
  55033. */
  55034. serialize(): any;
  55035. }
  55036. }
  55037. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  55038. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55039. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55040. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55041. import { Mesh } from "babylonjs/Meshes/mesh";
  55042. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  55043. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55044. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55045. /**
  55046. * Block used to add support for vertex skinning (bones)
  55047. */
  55048. export class BonesBlock extends NodeMaterialBlock {
  55049. /**
  55050. * Creates a new BonesBlock
  55051. * @param name defines the block name
  55052. */
  55053. constructor(name: string);
  55054. /**
  55055. * Initialize the block and prepare the context for build
  55056. * @param state defines the state that will be used for the build
  55057. */
  55058. initialize(state: NodeMaterialBuildState): void;
  55059. /**
  55060. * Gets the current class name
  55061. * @returns the class name
  55062. */
  55063. getClassName(): string;
  55064. /**
  55065. * Gets the matrix indices input component
  55066. */
  55067. readonly matricesIndices: NodeMaterialConnectionPoint;
  55068. /**
  55069. * Gets the matrix weights input component
  55070. */
  55071. readonly matricesWeights: NodeMaterialConnectionPoint;
  55072. /**
  55073. * Gets the extra matrix indices input component
  55074. */
  55075. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  55076. /**
  55077. * Gets the extra matrix weights input component
  55078. */
  55079. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  55080. /**
  55081. * Gets the world input component
  55082. */
  55083. readonly world: NodeMaterialConnectionPoint;
  55084. /**
  55085. * Gets the output component
  55086. */
  55087. readonly output: NodeMaterialConnectionPoint;
  55088. autoConfigure(): void;
  55089. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  55090. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55091. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55092. protected _buildBlock(state: NodeMaterialBuildState): this;
  55093. }
  55094. }
  55095. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  55096. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55097. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55098. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55100. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55101. /**
  55102. * Block used to add support for instances
  55103. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  55104. */
  55105. export class InstancesBlock extends NodeMaterialBlock {
  55106. /**
  55107. * Creates a new InstancesBlock
  55108. * @param name defines the block name
  55109. */
  55110. constructor(name: string);
  55111. /**
  55112. * Gets the current class name
  55113. * @returns the class name
  55114. */
  55115. getClassName(): string;
  55116. /**
  55117. * Gets the first world row input component
  55118. */
  55119. readonly world0: NodeMaterialConnectionPoint;
  55120. /**
  55121. * Gets the second world row input component
  55122. */
  55123. readonly world1: NodeMaterialConnectionPoint;
  55124. /**
  55125. * Gets the third world row input component
  55126. */
  55127. readonly world2: NodeMaterialConnectionPoint;
  55128. /**
  55129. * Gets the forth world row input component
  55130. */
  55131. readonly world3: NodeMaterialConnectionPoint;
  55132. /**
  55133. * Gets the world input component
  55134. */
  55135. readonly world: NodeMaterialConnectionPoint;
  55136. /**
  55137. * Gets the output component
  55138. */
  55139. readonly output: NodeMaterialConnectionPoint;
  55140. autoConfigure(): void;
  55141. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  55142. protected _buildBlock(state: NodeMaterialBuildState): this;
  55143. }
  55144. }
  55145. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  55146. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55147. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55148. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55149. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55150. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55151. import { Effect } from "babylonjs/Materials/effect";
  55152. import { Mesh } from "babylonjs/Meshes/mesh";
  55153. /**
  55154. * Block used to add morph targets support to vertex shader
  55155. */
  55156. export class MorphTargetsBlock extends NodeMaterialBlock {
  55157. private _repeatableContentAnchor;
  55158. private _repeatebleContentGenerated;
  55159. /**
  55160. * Create a new MorphTargetsBlock
  55161. * @param name defines the block name
  55162. */
  55163. constructor(name: string);
  55164. /**
  55165. * Gets the current class name
  55166. * @returns the class name
  55167. */
  55168. getClassName(): string;
  55169. /**
  55170. * Gets the position input component
  55171. */
  55172. readonly position: NodeMaterialConnectionPoint;
  55173. /**
  55174. * Gets the normal input component
  55175. */
  55176. readonly normal: NodeMaterialConnectionPoint;
  55177. /**
  55178. * Gets the tangent input component
  55179. */
  55180. readonly tangent: NodeMaterialConnectionPoint;
  55181. /**
  55182. * Gets the tangent input component
  55183. */
  55184. readonly uv: NodeMaterialConnectionPoint;
  55185. /**
  55186. * Gets the position output component
  55187. */
  55188. readonly positionOutput: NodeMaterialConnectionPoint;
  55189. /**
  55190. * Gets the normal output component
  55191. */
  55192. readonly normalOutput: NodeMaterialConnectionPoint;
  55193. /**
  55194. * Gets the tangent output component
  55195. */
  55196. readonly tangentOutput: NodeMaterialConnectionPoint;
  55197. /**
  55198. * Gets the tangent output component
  55199. */
  55200. readonly uvOutput: NodeMaterialConnectionPoint;
  55201. initialize(state: NodeMaterialBuildState): void;
  55202. autoConfigure(): void;
  55203. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55204. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55205. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  55206. protected _buildBlock(state: NodeMaterialBuildState): this;
  55207. }
  55208. }
  55209. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  55210. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  55211. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  55212. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  55213. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  55214. }
  55215. declare module "babylonjs/Materials/Node/Blocks/Fragment/alphaTestBlock" {
  55216. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55217. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55218. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55219. /**
  55220. * Block used to add an alpha test in the fragment shader
  55221. */
  55222. export class AlphaTestBlock extends NodeMaterialBlock {
  55223. /**
  55224. * Gets or sets the alpha value where alpha testing happens
  55225. */
  55226. alphaCutOff: number;
  55227. /**
  55228. * Create a new AlphaTestBlock
  55229. * @param name defines the block name
  55230. */
  55231. constructor(name: string);
  55232. /**
  55233. * Gets the current class name
  55234. * @returns the class name
  55235. */
  55236. getClassName(): string;
  55237. /**
  55238. * Gets the color input component
  55239. */
  55240. readonly color: NodeMaterialConnectionPoint;
  55241. /**
  55242. * Gets the alpha input component
  55243. */
  55244. readonly alpha: NodeMaterialConnectionPoint;
  55245. protected _buildBlock(state: NodeMaterialBuildState): this;
  55246. }
  55247. }
  55248. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  55249. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55250. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55251. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55252. /**
  55253. * Block used to create a Color3/4 out of individual inputs (one for each component)
  55254. */
  55255. export class ColorMergerBlock extends NodeMaterialBlock {
  55256. /**
  55257. * Create a new ColorMergerBlock
  55258. * @param name defines the block name
  55259. */
  55260. constructor(name: string);
  55261. /**
  55262. * Gets the current class name
  55263. * @returns the class name
  55264. */
  55265. getClassName(): string;
  55266. /**
  55267. * Gets the r component (input)
  55268. */
  55269. readonly r: NodeMaterialConnectionPoint;
  55270. /**
  55271. * Gets the g component (input)
  55272. */
  55273. readonly g: NodeMaterialConnectionPoint;
  55274. /**
  55275. * Gets the b component (input)
  55276. */
  55277. readonly b: NodeMaterialConnectionPoint;
  55278. /**
  55279. * Gets the a component (input)
  55280. */
  55281. readonly a: NodeMaterialConnectionPoint;
  55282. /**
  55283. * Gets the rgba component (output)
  55284. */
  55285. readonly rgba: NodeMaterialConnectionPoint;
  55286. /**
  55287. * Gets the rgb component (output)
  55288. */
  55289. readonly rgb: NodeMaterialConnectionPoint;
  55290. protected _buildBlock(state: NodeMaterialBuildState): this;
  55291. }
  55292. }
  55293. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  55294. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55295. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55296. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55297. /**
  55298. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  55299. */
  55300. export class VectorMergerBlock extends NodeMaterialBlock {
  55301. /**
  55302. * Create a new VectorMergerBlock
  55303. * @param name defines the block name
  55304. */
  55305. constructor(name: string);
  55306. /**
  55307. * Gets the current class name
  55308. * @returns the class name
  55309. */
  55310. getClassName(): string;
  55311. /**
  55312. * Gets the x component (input)
  55313. */
  55314. readonly x: NodeMaterialConnectionPoint;
  55315. /**
  55316. * Gets the y component (input)
  55317. */
  55318. readonly y: NodeMaterialConnectionPoint;
  55319. /**
  55320. * Gets the z component (input)
  55321. */
  55322. readonly z: NodeMaterialConnectionPoint;
  55323. /**
  55324. * Gets the w component (input)
  55325. */
  55326. readonly w: NodeMaterialConnectionPoint;
  55327. /**
  55328. * Gets the xyzw component (output)
  55329. */
  55330. readonly xyzw: NodeMaterialConnectionPoint;
  55331. /**
  55332. * Gets the xyz component (output)
  55333. */
  55334. readonly xyz: NodeMaterialConnectionPoint;
  55335. /**
  55336. * Gets the xy component (output)
  55337. */
  55338. readonly xy: NodeMaterialConnectionPoint;
  55339. protected _buildBlock(state: NodeMaterialBuildState): this;
  55340. }
  55341. }
  55342. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  55343. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55344. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55345. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55346. /**
  55347. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  55348. */
  55349. export class ColorSplitterBlock extends NodeMaterialBlock {
  55350. /**
  55351. * Create a new ColorSplitterBlock
  55352. * @param name defines the block name
  55353. */
  55354. constructor(name: string);
  55355. /**
  55356. * Gets the current class name
  55357. * @returns the class name
  55358. */
  55359. getClassName(): string;
  55360. /**
  55361. * Gets the rgba component (input)
  55362. */
  55363. readonly rgba: NodeMaterialConnectionPoint;
  55364. /**
  55365. * Gets the rgb component (input)
  55366. */
  55367. readonly rgbIn: NodeMaterialConnectionPoint;
  55368. /**
  55369. * Gets the rgb component (output)
  55370. */
  55371. readonly rgbOut: NodeMaterialConnectionPoint;
  55372. /**
  55373. * Gets the r component (output)
  55374. */
  55375. readonly r: NodeMaterialConnectionPoint;
  55376. /**
  55377. * Gets the g component (output)
  55378. */
  55379. readonly g: NodeMaterialConnectionPoint;
  55380. /**
  55381. * Gets the b component (output)
  55382. */
  55383. readonly b: NodeMaterialConnectionPoint;
  55384. /**
  55385. * Gets the a component (output)
  55386. */
  55387. readonly a: NodeMaterialConnectionPoint;
  55388. protected _buildBlock(state: NodeMaterialBuildState): this;
  55389. }
  55390. }
  55391. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  55392. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55393. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55394. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55395. /**
  55396. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  55397. */
  55398. export class VectorSplitterBlock extends NodeMaterialBlock {
  55399. /**
  55400. * Create a new VectorSplitterBlock
  55401. * @param name defines the block name
  55402. */
  55403. constructor(name: string);
  55404. /**
  55405. * Gets the current class name
  55406. * @returns the class name
  55407. */
  55408. getClassName(): string;
  55409. /**
  55410. * Gets the xyzw component (input)
  55411. */
  55412. readonly xyzw: NodeMaterialConnectionPoint;
  55413. /**
  55414. * Gets the xyz component (input)
  55415. */
  55416. readonly xyzIn: NodeMaterialConnectionPoint;
  55417. /**
  55418. * Gets the xyz component (output)
  55419. */
  55420. readonly xyzOut: NodeMaterialConnectionPoint;
  55421. /**
  55422. * Gets the xy component (output)
  55423. */
  55424. readonly xy: NodeMaterialConnectionPoint;
  55425. /**
  55426. * Gets the x component (output)
  55427. */
  55428. readonly x: NodeMaterialConnectionPoint;
  55429. /**
  55430. * Gets the y component (output)
  55431. */
  55432. readonly y: NodeMaterialConnectionPoint;
  55433. /**
  55434. * Gets the z component (output)
  55435. */
  55436. readonly z: NodeMaterialConnectionPoint;
  55437. /**
  55438. * Gets the w component (output)
  55439. */
  55440. readonly w: NodeMaterialConnectionPoint;
  55441. protected _buildBlock(state: NodeMaterialBuildState): this;
  55442. }
  55443. }
  55444. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  55445. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55446. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55447. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55448. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55449. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55450. import { Effect } from "babylonjs/Materials/effect";
  55451. import { Mesh } from "babylonjs/Meshes/mesh";
  55452. /**
  55453. * Block used to add image processing support to fragment shader
  55454. */
  55455. export class ImageProcessingBlock extends NodeMaterialBlock {
  55456. /**
  55457. * Create a new ImageProcessingBlock
  55458. * @param name defines the block name
  55459. */
  55460. constructor(name: string);
  55461. /**
  55462. * Gets the current class name
  55463. * @returns the class name
  55464. */
  55465. getClassName(): string;
  55466. /**
  55467. * Gets the color input component
  55468. */
  55469. readonly color: NodeMaterialConnectionPoint;
  55470. /**
  55471. * Gets the output component
  55472. */
  55473. readonly output: NodeMaterialConnectionPoint;
  55474. /**
  55475. * Initialize the block and prepare the context for build
  55476. * @param state defines the state that will be used for the build
  55477. */
  55478. initialize(state: NodeMaterialBuildState): void;
  55479. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  55480. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55481. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55482. protected _buildBlock(state: NodeMaterialBuildState): this;
  55483. }
  55484. }
  55485. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  55486. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  55487. export * from "babylonjs/Materials/Node/Blocks/Fragment/alphaTestBlock";
  55488. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  55489. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  55490. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  55491. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  55492. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  55493. }
  55494. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  55495. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55496. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55497. import { Mesh } from "babylonjs/Meshes/mesh";
  55498. import { Effect } from "babylonjs/Materials/effect";
  55499. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55500. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55501. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55502. /**
  55503. * Block used to add support for scene fog
  55504. */
  55505. export class FogBlock extends NodeMaterialBlock {
  55506. private _fogDistanceName;
  55507. private _fogParameters;
  55508. /**
  55509. * Create a new FogBlock
  55510. * @param name defines the block name
  55511. */
  55512. constructor(name: string);
  55513. /**
  55514. * Gets the current class name
  55515. * @returns the class name
  55516. */
  55517. getClassName(): string;
  55518. /**
  55519. * Gets the world position input component
  55520. */
  55521. readonly worldPosition: NodeMaterialConnectionPoint;
  55522. /**
  55523. * Gets the view input component
  55524. */
  55525. readonly view: NodeMaterialConnectionPoint;
  55526. /**
  55527. * Gets the color input component
  55528. */
  55529. readonly color: NodeMaterialConnectionPoint;
  55530. /**
  55531. * Gets the fog color input component
  55532. */
  55533. readonly fogColor: NodeMaterialConnectionPoint;
  55534. /**
  55535. * Gets the output component
  55536. */
  55537. readonly output: NodeMaterialConnectionPoint;
  55538. autoConfigure(): void;
  55539. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55540. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55541. protected _buildBlock(state: NodeMaterialBuildState): this;
  55542. }
  55543. }
  55544. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  55545. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55546. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55547. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55548. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55549. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55550. import { Effect } from "babylonjs/Materials/effect";
  55551. import { Mesh } from "babylonjs/Meshes/mesh";
  55552. import { Light } from "babylonjs/Lights/light";
  55553. import { Nullable } from "babylonjs/types";
  55554. import { Scene } from "babylonjs/scene";
  55555. /**
  55556. * Block used to add light in the fragment shader
  55557. */
  55558. export class LightBlock extends NodeMaterialBlock {
  55559. private _lightId;
  55560. /**
  55561. * Gets or sets the light associated with this block
  55562. */
  55563. light: Nullable<Light>;
  55564. /**
  55565. * Create a new LightBlock
  55566. * @param name defines the block name
  55567. */
  55568. constructor(name: string);
  55569. /**
  55570. * Gets the current class name
  55571. * @returns the class name
  55572. */
  55573. getClassName(): string;
  55574. /**
  55575. * Gets the world position input component
  55576. */
  55577. readonly worldPosition: NodeMaterialConnectionPoint;
  55578. /**
  55579. * Gets the world normal input component
  55580. */
  55581. readonly worldNormal: NodeMaterialConnectionPoint;
  55582. /**
  55583. * Gets the camera (or eye) position component
  55584. */
  55585. readonly cameraPosition: NodeMaterialConnectionPoint;
  55586. /**
  55587. * Gets the diffuse output component
  55588. */
  55589. readonly diffuseOutput: NodeMaterialConnectionPoint;
  55590. /**
  55591. * Gets the specular output component
  55592. */
  55593. readonly specularOutput: NodeMaterialConnectionPoint;
  55594. autoConfigure(): void;
  55595. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55596. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55597. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55598. private _injectVertexCode;
  55599. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  55600. serialize(): any;
  55601. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55602. }
  55603. }
  55604. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  55605. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  55606. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  55607. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  55608. }
  55609. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  55610. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  55611. }
  55612. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  55613. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55614. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55615. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55616. /**
  55617. * Block used to multiply 2 values
  55618. */
  55619. export class MultiplyBlock extends NodeMaterialBlock {
  55620. /**
  55621. * Creates a new MultiplyBlock
  55622. * @param name defines the block name
  55623. */
  55624. constructor(name: string);
  55625. /**
  55626. * Gets the current class name
  55627. * @returns the class name
  55628. */
  55629. getClassName(): string;
  55630. /**
  55631. * Gets the left operand input component
  55632. */
  55633. readonly left: NodeMaterialConnectionPoint;
  55634. /**
  55635. * Gets the right operand input component
  55636. */
  55637. readonly right: NodeMaterialConnectionPoint;
  55638. /**
  55639. * Gets the output component
  55640. */
  55641. readonly output: NodeMaterialConnectionPoint;
  55642. protected _buildBlock(state: NodeMaterialBuildState): this;
  55643. }
  55644. }
  55645. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  55646. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55647. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55648. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55649. /**
  55650. * Block used to add 2 vectors
  55651. */
  55652. export class AddBlock extends NodeMaterialBlock {
  55653. /**
  55654. * Creates a new AddBlock
  55655. * @param name defines the block name
  55656. */
  55657. constructor(name: string);
  55658. /**
  55659. * Gets the current class name
  55660. * @returns the class name
  55661. */
  55662. getClassName(): string;
  55663. /**
  55664. * Gets the left operand input component
  55665. */
  55666. readonly left: NodeMaterialConnectionPoint;
  55667. /**
  55668. * Gets the right operand input component
  55669. */
  55670. readonly right: NodeMaterialConnectionPoint;
  55671. /**
  55672. * Gets the output component
  55673. */
  55674. readonly output: NodeMaterialConnectionPoint;
  55675. protected _buildBlock(state: NodeMaterialBuildState): this;
  55676. }
  55677. }
  55678. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  55679. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55680. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55681. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55682. /**
  55683. * Block used to clamp a float
  55684. */
  55685. export class ClampBlock extends NodeMaterialBlock {
  55686. /** Gets or sets the minimum range */
  55687. minimum: number;
  55688. /** Gets or sets the maximum range */
  55689. maximum: number;
  55690. /**
  55691. * Creates a new ClampBlock
  55692. * @param name defines the block name
  55693. */
  55694. constructor(name: string);
  55695. /**
  55696. * Gets the current class name
  55697. * @returns the class name
  55698. */
  55699. getClassName(): string;
  55700. /**
  55701. * Gets the value input component
  55702. */
  55703. readonly value: NodeMaterialConnectionPoint;
  55704. /**
  55705. * Gets the output component
  55706. */
  55707. readonly output: NodeMaterialConnectionPoint;
  55708. protected _buildBlock(state: NodeMaterialBuildState): this;
  55709. }
  55710. }
  55711. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  55712. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55713. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55714. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55715. /**
  55716. * Block used to apply a cross product between 2 vectors
  55717. */
  55718. export class CrossBlock extends NodeMaterialBlock {
  55719. /**
  55720. * Creates a new CrossBlock
  55721. * @param name defines the block name
  55722. */
  55723. constructor(name: string);
  55724. /**
  55725. * Gets the current class name
  55726. * @returns the class name
  55727. */
  55728. getClassName(): string;
  55729. /**
  55730. * Gets the left operand input component
  55731. */
  55732. readonly left: NodeMaterialConnectionPoint;
  55733. /**
  55734. * Gets the right operand input component
  55735. */
  55736. readonly right: NodeMaterialConnectionPoint;
  55737. /**
  55738. * Gets the output component
  55739. */
  55740. readonly output: NodeMaterialConnectionPoint;
  55741. protected _buildBlock(state: NodeMaterialBuildState): this;
  55742. }
  55743. }
  55744. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  55745. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55746. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55747. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55748. /**
  55749. * Block used to apply a dot product between 2 vectors
  55750. */
  55751. export class DotBlock extends NodeMaterialBlock {
  55752. /**
  55753. * Creates a new DotBlock
  55754. * @param name defines the block name
  55755. */
  55756. constructor(name: string);
  55757. /**
  55758. * Gets the current class name
  55759. * @returns the class name
  55760. */
  55761. getClassName(): string;
  55762. /**
  55763. * Gets the left operand input component
  55764. */
  55765. readonly left: NodeMaterialConnectionPoint;
  55766. /**
  55767. * Gets the right operand input component
  55768. */
  55769. readonly right: NodeMaterialConnectionPoint;
  55770. /**
  55771. * Gets the output component
  55772. */
  55773. readonly output: NodeMaterialConnectionPoint;
  55774. protected _buildBlock(state: NodeMaterialBuildState): this;
  55775. }
  55776. }
  55777. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  55778. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55779. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55780. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55781. import { Vector2 } from "babylonjs/Maths/math.vector";
  55782. /**
  55783. * Block used to remap a float from a range to a new one
  55784. */
  55785. export class RemapBlock extends NodeMaterialBlock {
  55786. /**
  55787. * Gets or sets the source range
  55788. */
  55789. sourceRange: Vector2;
  55790. /**
  55791. * Gets or sets the target range
  55792. */
  55793. targetRange: Vector2;
  55794. /**
  55795. * Creates a new RemapBlock
  55796. * @param name defines the block name
  55797. */
  55798. constructor(name: string);
  55799. /**
  55800. * Gets the current class name
  55801. * @returns the class name
  55802. */
  55803. getClassName(): string;
  55804. /**
  55805. * Gets the input component
  55806. */
  55807. readonly input: NodeMaterialConnectionPoint;
  55808. /**
  55809. * Gets the output component
  55810. */
  55811. readonly output: NodeMaterialConnectionPoint;
  55812. protected _buildBlock(state: NodeMaterialBuildState): this;
  55813. }
  55814. }
  55815. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  55816. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55817. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55818. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55819. /**
  55820. * Block used to normalize a vector
  55821. */
  55822. export class NormalizeBlock extends NodeMaterialBlock {
  55823. /**
  55824. * Creates a new NormalizeBlock
  55825. * @param name defines the block name
  55826. */
  55827. constructor(name: string);
  55828. /**
  55829. * Gets the current class name
  55830. * @returns the class name
  55831. */
  55832. getClassName(): string;
  55833. /**
  55834. * Gets the input component
  55835. */
  55836. readonly input: NodeMaterialConnectionPoint;
  55837. /**
  55838. * Gets the output component
  55839. */
  55840. readonly output: NodeMaterialConnectionPoint;
  55841. protected _buildBlock(state: NodeMaterialBuildState): this;
  55842. }
  55843. }
  55844. declare module "babylonjs/Materials/Node/Blocks/index" {
  55845. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  55846. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  55847. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  55848. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  55849. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  55850. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  55851. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  55852. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  55853. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  55854. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  55855. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  55856. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  55857. }
  55858. declare module "babylonjs/Materials/Node/Optimizers/index" {
  55859. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  55860. }
  55861. declare module "babylonjs/Materials/Node/index" {
  55862. export * from "babylonjs/Materials/Node/nodeMaterialBlockTargets";
  55863. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPointTypes";
  55864. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55865. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  55866. export * from "babylonjs/Materials/Node/nodeMaterial";
  55867. export * from "babylonjs/Materials/Node/nodeMaterialWellKnownValues";
  55868. export * from "babylonjs/Materials/Node/Blocks/index";
  55869. export * from "babylonjs/Materials/Node/Optimizers/index";
  55870. }
  55871. declare module "babylonjs/Materials/effectRenderer" {
  55872. import { Nullable } from "babylonjs/types";
  55873. import { Texture } from "babylonjs/Materials/Textures/texture";
  55874. import { Engine } from "babylonjs/Engines/engine";
  55875. import { Viewport } from "babylonjs/Maths/math.viewport";
  55876. import { Observable } from "babylonjs/Misc/observable";
  55877. import { Effect } from "babylonjs/Materials/effect";
  55878. import "babylonjs/Shaders/postprocess.vertex";
  55879. /**
  55880. * Effect Render Options
  55881. */
  55882. export interface IEffectRendererOptions {
  55883. /**
  55884. * Defines the vertices positions.
  55885. */
  55886. positions?: number[];
  55887. /**
  55888. * Defines the indices.
  55889. */
  55890. indices?: number[];
  55891. }
  55892. /**
  55893. * Helper class to render one or more effects
  55894. */
  55895. export class EffectRenderer {
  55896. private engine;
  55897. private static _DefaultOptions;
  55898. private _vertexBuffers;
  55899. private _indexBuffer;
  55900. private _ringBufferIndex;
  55901. private _ringScreenBuffer;
  55902. private _fullscreenViewport;
  55903. private _getNextFrameBuffer;
  55904. /**
  55905. * Creates an effect renderer
  55906. * @param engine the engine to use for rendering
  55907. * @param options defines the options of the effect renderer
  55908. */
  55909. constructor(engine: Engine, options?: IEffectRendererOptions);
  55910. /**
  55911. * Sets the current viewport in normalized coordinates 0-1
  55912. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  55913. */
  55914. setViewport(viewport?: Viewport): void;
  55915. /**
  55916. * Sets the current effect wrapper to use during draw.
  55917. * The effect needs to be ready before calling this api.
  55918. * This also sets the default full screen position attribute.
  55919. * @param effectWrapper Defines the effect to draw with
  55920. */
  55921. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  55922. /**
  55923. * Draws a full screen quad.
  55924. */
  55925. draw(): void;
  55926. /**
  55927. * renders one or more effects to a specified texture
  55928. * @param effectWrappers list of effects to renderer
  55929. * @param outputTexture texture to draw to, if null it will render to the screen
  55930. */
  55931. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  55932. /**
  55933. * Disposes of the effect renderer
  55934. */
  55935. dispose(): void;
  55936. }
  55937. /**
  55938. * Options to create an EffectWrapper
  55939. */
  55940. interface EffectWrapperCreationOptions {
  55941. /**
  55942. * Engine to use to create the effect
  55943. */
  55944. engine: Engine;
  55945. /**
  55946. * Fragment shader for the effect
  55947. */
  55948. fragmentShader: string;
  55949. /**
  55950. * Vertex shader for the effect
  55951. */
  55952. vertexShader?: string;
  55953. /**
  55954. * Attributes to use in the shader
  55955. */
  55956. attributeNames?: Array<string>;
  55957. /**
  55958. * Uniforms to use in the shader
  55959. */
  55960. uniformNames?: Array<string>;
  55961. /**
  55962. * Texture sampler names to use in the shader
  55963. */
  55964. samplerNames?: Array<string>;
  55965. /**
  55966. * The friendly name of the effect displayed in Spector.
  55967. */
  55968. name?: string;
  55969. }
  55970. /**
  55971. * Wraps an effect to be used for rendering
  55972. */
  55973. export class EffectWrapper {
  55974. /**
  55975. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  55976. */
  55977. onApplyObservable: Observable<{}>;
  55978. /**
  55979. * The underlying effect
  55980. */
  55981. effect: Effect;
  55982. /**
  55983. * Creates an effect to be renderer
  55984. * @param creationOptions options to create the effect
  55985. */
  55986. constructor(creationOptions: EffectWrapperCreationOptions);
  55987. /**
  55988. * Disposes of the effect wrapper
  55989. */
  55990. dispose(): void;
  55991. }
  55992. }
  55993. declare module "babylonjs/Materials/index" {
  55994. export * from "babylonjs/Materials/Background/index";
  55995. export * from "babylonjs/Materials/colorCurves";
  55996. export * from "babylonjs/Materials/effect";
  55997. export * from "babylonjs/Materials/fresnelParameters";
  55998. export * from "babylonjs/Materials/imageProcessingConfiguration";
  55999. export * from "babylonjs/Materials/material";
  56000. export * from "babylonjs/Materials/materialDefines";
  56001. export * from "babylonjs/Materials/materialHelper";
  56002. export * from "babylonjs/Materials/multiMaterial";
  56003. export * from "babylonjs/Materials/PBR/index";
  56004. export * from "babylonjs/Materials/pushMaterial";
  56005. export * from "babylonjs/Materials/shaderMaterial";
  56006. export * from "babylonjs/Materials/standardMaterial";
  56007. export * from "babylonjs/Materials/Textures/index";
  56008. export * from "babylonjs/Materials/uniformBuffer";
  56009. export * from "babylonjs/Materials/materialFlags";
  56010. export * from "babylonjs/Materials/Node/index";
  56011. export * from "babylonjs/Materials/effectRenderer";
  56012. }
  56013. declare module "babylonjs/Maths/index" {
  56014. export * from "babylonjs/Maths/math.scalar";
  56015. export * from "babylonjs/Maths/math";
  56016. export * from "babylonjs/Maths/sphericalPolynomial";
  56017. }
  56018. declare module "babylonjs/Misc/workerPool" {
  56019. import { IDisposable } from "babylonjs/scene";
  56020. /**
  56021. * Helper class to push actions to a pool of workers.
  56022. */
  56023. export class WorkerPool implements IDisposable {
  56024. private _workerInfos;
  56025. private _pendingActions;
  56026. /**
  56027. * Constructor
  56028. * @param workers Array of workers to use for actions
  56029. */
  56030. constructor(workers: Array<Worker>);
  56031. /**
  56032. * Terminates all workers and clears any pending actions.
  56033. */
  56034. dispose(): void;
  56035. /**
  56036. * Pushes an action to the worker pool. If all the workers are active, the action will be
  56037. * pended until a worker has completed its action.
  56038. * @param action The action to perform. Call onComplete when the action is complete.
  56039. */
  56040. push(action: (worker: Worker, onComplete: () => void) => void): void;
  56041. private _execute;
  56042. }
  56043. }
  56044. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  56045. import { IDisposable } from "babylonjs/scene";
  56046. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  56047. /**
  56048. * Configuration for Draco compression
  56049. */
  56050. export interface IDracoCompressionConfiguration {
  56051. /**
  56052. * Configuration for the decoder.
  56053. */
  56054. decoder: {
  56055. /**
  56056. * The url to the WebAssembly module.
  56057. */
  56058. wasmUrl?: string;
  56059. /**
  56060. * The url to the WebAssembly binary.
  56061. */
  56062. wasmBinaryUrl?: string;
  56063. /**
  56064. * The url to the fallback JavaScript module.
  56065. */
  56066. fallbackUrl?: string;
  56067. };
  56068. }
  56069. /**
  56070. * Draco compression (https://google.github.io/draco/)
  56071. *
  56072. * This class wraps the Draco module.
  56073. *
  56074. * **Encoder**
  56075. *
  56076. * The encoder is not currently implemented.
  56077. *
  56078. * **Decoder**
  56079. *
  56080. * 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.
  56081. *
  56082. * To update the configuration, use the following code:
  56083. * ```javascript
  56084. * DracoCompression.Configuration = {
  56085. * decoder: {
  56086. * wasmUrl: "<url to the WebAssembly library>",
  56087. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  56088. * fallbackUrl: "<url to the fallback JavaScript library>",
  56089. * }
  56090. * };
  56091. * ```
  56092. *
  56093. * 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.
  56094. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  56095. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  56096. *
  56097. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  56098. * ```javascript
  56099. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  56100. * ```
  56101. *
  56102. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  56103. */
  56104. export class DracoCompression implements IDisposable {
  56105. private _workerPoolPromise?;
  56106. private _decoderModulePromise?;
  56107. /**
  56108. * The configuration. Defaults to the following urls:
  56109. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  56110. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  56111. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  56112. */
  56113. static Configuration: IDracoCompressionConfiguration;
  56114. /**
  56115. * Returns true if the decoder configuration is available.
  56116. */
  56117. static readonly DecoderAvailable: boolean;
  56118. /**
  56119. * Default number of workers to create when creating the draco compression object.
  56120. */
  56121. static DefaultNumWorkers: number;
  56122. private static GetDefaultNumWorkers;
  56123. private static _Default;
  56124. /**
  56125. * Default instance for the draco compression object.
  56126. */
  56127. static readonly Default: DracoCompression;
  56128. /**
  56129. * Constructor
  56130. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  56131. */
  56132. constructor(numWorkers?: number);
  56133. /**
  56134. * Stop all async operations and release resources.
  56135. */
  56136. dispose(): void;
  56137. /**
  56138. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  56139. * @returns a promise that resolves when ready
  56140. */
  56141. whenReadyAsync(): Promise<void>;
  56142. /**
  56143. * Decode Draco compressed mesh data to vertex data.
  56144. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  56145. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  56146. * @returns A promise that resolves with the decoded vertex data
  56147. */
  56148. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  56149. [kind: string]: number;
  56150. }): Promise<VertexData>;
  56151. }
  56152. }
  56153. declare module "babylonjs/Meshes/Compression/index" {
  56154. export * from "babylonjs/Meshes/Compression/dracoCompression";
  56155. }
  56156. declare module "babylonjs/Meshes/csg" {
  56157. import { Nullable } from "babylonjs/types";
  56158. import { Scene } from "babylonjs/scene";
  56159. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56160. import { Mesh } from "babylonjs/Meshes/mesh";
  56161. import { Material } from "babylonjs/Materials/material";
  56162. /**
  56163. * Class for building Constructive Solid Geometry
  56164. */
  56165. export class CSG {
  56166. private polygons;
  56167. /**
  56168. * The world matrix
  56169. */
  56170. matrix: Matrix;
  56171. /**
  56172. * Stores the position
  56173. */
  56174. position: Vector3;
  56175. /**
  56176. * Stores the rotation
  56177. */
  56178. rotation: Vector3;
  56179. /**
  56180. * Stores the rotation quaternion
  56181. */
  56182. rotationQuaternion: Nullable<Quaternion>;
  56183. /**
  56184. * Stores the scaling vector
  56185. */
  56186. scaling: Vector3;
  56187. /**
  56188. * Convert the Mesh to CSG
  56189. * @param mesh The Mesh to convert to CSG
  56190. * @returns A new CSG from the Mesh
  56191. */
  56192. static FromMesh(mesh: Mesh): CSG;
  56193. /**
  56194. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  56195. * @param polygons Polygons used to construct a CSG solid
  56196. */
  56197. private static FromPolygons;
  56198. /**
  56199. * Clones, or makes a deep copy, of the CSG
  56200. * @returns A new CSG
  56201. */
  56202. clone(): CSG;
  56203. /**
  56204. * Unions this CSG with another CSG
  56205. * @param csg The CSG to union against this CSG
  56206. * @returns The unioned CSG
  56207. */
  56208. union(csg: CSG): CSG;
  56209. /**
  56210. * Unions this CSG with another CSG in place
  56211. * @param csg The CSG to union against this CSG
  56212. */
  56213. unionInPlace(csg: CSG): void;
  56214. /**
  56215. * Subtracts this CSG with another CSG
  56216. * @param csg The CSG to subtract against this CSG
  56217. * @returns A new CSG
  56218. */
  56219. subtract(csg: CSG): CSG;
  56220. /**
  56221. * Subtracts this CSG with another CSG in place
  56222. * @param csg The CSG to subtact against this CSG
  56223. */
  56224. subtractInPlace(csg: CSG): void;
  56225. /**
  56226. * Intersect this CSG with another CSG
  56227. * @param csg The CSG to intersect against this CSG
  56228. * @returns A new CSG
  56229. */
  56230. intersect(csg: CSG): CSG;
  56231. /**
  56232. * Intersects this CSG with another CSG in place
  56233. * @param csg The CSG to intersect against this CSG
  56234. */
  56235. intersectInPlace(csg: CSG): void;
  56236. /**
  56237. * Return a new CSG solid with solid and empty space switched. This solid is
  56238. * not modified.
  56239. * @returns A new CSG solid with solid and empty space switched
  56240. */
  56241. inverse(): CSG;
  56242. /**
  56243. * Inverses the CSG in place
  56244. */
  56245. inverseInPlace(): void;
  56246. /**
  56247. * This is used to keep meshes transformations so they can be restored
  56248. * when we build back a Babylon Mesh
  56249. * NB : All CSG operations are performed in world coordinates
  56250. * @param csg The CSG to copy the transform attributes from
  56251. * @returns This CSG
  56252. */
  56253. copyTransformAttributes(csg: CSG): CSG;
  56254. /**
  56255. * Build Raw mesh from CSG
  56256. * Coordinates here are in world space
  56257. * @param name The name of the mesh geometry
  56258. * @param scene The Scene
  56259. * @param keepSubMeshes Specifies if the submeshes should be kept
  56260. * @returns A new Mesh
  56261. */
  56262. buildMeshGeometry(name: string, scene: Scene, keepSubMeshes: boolean): Mesh;
  56263. /**
  56264. * Build Mesh from CSG taking material and transforms into account
  56265. * @param name The name of the Mesh
  56266. * @param material The material of the Mesh
  56267. * @param scene The Scene
  56268. * @param keepSubMeshes Specifies if submeshes should be kept
  56269. * @returns The new Mesh
  56270. */
  56271. toMesh(name: string, material: Nullable<Material>, scene: Scene, keepSubMeshes: boolean): Mesh;
  56272. }
  56273. }
  56274. declare module "babylonjs/Meshes/trailMesh" {
  56275. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56276. import { Mesh } from "babylonjs/Meshes/mesh";
  56277. import { Scene } from "babylonjs/scene";
  56278. /**
  56279. * Class used to create a trail following a mesh
  56280. */
  56281. export class TrailMesh extends Mesh {
  56282. private _generator;
  56283. private _autoStart;
  56284. private _running;
  56285. private _diameter;
  56286. private _length;
  56287. private _sectionPolygonPointsCount;
  56288. private _sectionVectors;
  56289. private _sectionNormalVectors;
  56290. private _beforeRenderObserver;
  56291. /**
  56292. * @constructor
  56293. * @param name The value used by scene.getMeshByName() to do a lookup.
  56294. * @param generator The mesh to generate a trail.
  56295. * @param scene The scene to add this mesh to.
  56296. * @param diameter Diameter of trailing mesh. Default is 1.
  56297. * @param length Length of trailing mesh. Default is 60.
  56298. * @param autoStart Automatically start trailing mesh. Default true.
  56299. */
  56300. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  56301. /**
  56302. * "TrailMesh"
  56303. * @returns "TrailMesh"
  56304. */
  56305. getClassName(): string;
  56306. private _createMesh;
  56307. /**
  56308. * Start trailing mesh.
  56309. */
  56310. start(): void;
  56311. /**
  56312. * Stop trailing mesh.
  56313. */
  56314. stop(): void;
  56315. /**
  56316. * Update trailing mesh geometry.
  56317. */
  56318. update(): void;
  56319. /**
  56320. * Returns a new TrailMesh object.
  56321. * @param name is a string, the name given to the new mesh
  56322. * @param newGenerator use new generator object for cloned trail mesh
  56323. * @returns a new mesh
  56324. */
  56325. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  56326. /**
  56327. * Serializes this trail mesh
  56328. * @param serializationObject object to write serialization to
  56329. */
  56330. serialize(serializationObject: any): void;
  56331. /**
  56332. * Parses a serialized trail mesh
  56333. * @param parsedMesh the serialized mesh
  56334. * @param scene the scene to create the trail mesh in
  56335. * @returns the created trail mesh
  56336. */
  56337. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  56338. }
  56339. }
  56340. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  56341. import { Nullable } from "babylonjs/types";
  56342. import { Scene } from "babylonjs/scene";
  56343. import { Vector4 } from "babylonjs/Maths/math.vector";
  56344. import { Color4 } from "babylonjs/Maths/math.color";
  56345. import { Mesh } from "babylonjs/Meshes/mesh";
  56346. /**
  56347. * Class containing static functions to help procedurally build meshes
  56348. */
  56349. export class TiledBoxBuilder {
  56350. /**
  56351. * Creates a box mesh
  56352. * 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)
  56353. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  56354. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56355. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56356. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56357. * @param name defines the name of the mesh
  56358. * @param options defines the options used to create the mesh
  56359. * @param scene defines the hosting scene
  56360. * @returns the box mesh
  56361. */
  56362. static CreateTiledBox(name: string, options: {
  56363. pattern?: number;
  56364. width?: number;
  56365. height?: number;
  56366. depth?: number;
  56367. tileSize?: number;
  56368. tileWidth?: number;
  56369. tileHeight?: number;
  56370. alignHorizontal?: number;
  56371. alignVertical?: number;
  56372. faceUV?: Vector4[];
  56373. faceColors?: Color4[];
  56374. sideOrientation?: number;
  56375. updatable?: boolean;
  56376. }, scene?: Nullable<Scene>): Mesh;
  56377. }
  56378. }
  56379. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  56380. import { Vector4 } from "babylonjs/Maths/math.vector";
  56381. import { Mesh } from "babylonjs/Meshes/mesh";
  56382. /**
  56383. * Class containing static functions to help procedurally build meshes
  56384. */
  56385. export class TorusKnotBuilder {
  56386. /**
  56387. * Creates a torus knot mesh
  56388. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  56389. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  56390. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  56391. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  56392. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56393. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56394. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  56395. * @param name defines the name of the mesh
  56396. * @param options defines the options used to create the mesh
  56397. * @param scene defines the hosting scene
  56398. * @returns the torus knot mesh
  56399. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  56400. */
  56401. static CreateTorusKnot(name: string, options: {
  56402. radius?: number;
  56403. tube?: number;
  56404. radialSegments?: number;
  56405. tubularSegments?: number;
  56406. p?: number;
  56407. q?: number;
  56408. updatable?: boolean;
  56409. sideOrientation?: number;
  56410. frontUVs?: Vector4;
  56411. backUVs?: Vector4;
  56412. }, scene: any): Mesh;
  56413. }
  56414. }
  56415. declare module "babylonjs/Meshes/polygonMesh" {
  56416. import { Scene } from "babylonjs/scene";
  56417. import { Vector2 } from "babylonjs/Maths/math.vector";
  56418. import { Mesh } from "babylonjs/Meshes/mesh";
  56419. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  56420. import { Path2 } from "babylonjs/Maths/math.path";
  56421. /**
  56422. * Polygon
  56423. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  56424. */
  56425. export class Polygon {
  56426. /**
  56427. * Creates a rectangle
  56428. * @param xmin bottom X coord
  56429. * @param ymin bottom Y coord
  56430. * @param xmax top X coord
  56431. * @param ymax top Y coord
  56432. * @returns points that make the resulting rectation
  56433. */
  56434. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  56435. /**
  56436. * Creates a circle
  56437. * @param radius radius of circle
  56438. * @param cx scale in x
  56439. * @param cy scale in y
  56440. * @param numberOfSides number of sides that make up the circle
  56441. * @returns points that make the resulting circle
  56442. */
  56443. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  56444. /**
  56445. * Creates a polygon from input string
  56446. * @param input Input polygon data
  56447. * @returns the parsed points
  56448. */
  56449. static Parse(input: string): Vector2[];
  56450. /**
  56451. * Starts building a polygon from x and y coordinates
  56452. * @param x x coordinate
  56453. * @param y y coordinate
  56454. * @returns the started path2
  56455. */
  56456. static StartingAt(x: number, y: number): Path2;
  56457. }
  56458. /**
  56459. * Builds a polygon
  56460. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  56461. */
  56462. export class PolygonMeshBuilder {
  56463. private _points;
  56464. private _outlinepoints;
  56465. private _holes;
  56466. private _name;
  56467. private _scene;
  56468. private _epoints;
  56469. private _eholes;
  56470. private _addToepoint;
  56471. /**
  56472. * Babylon reference to the earcut plugin.
  56473. */
  56474. bjsEarcut: any;
  56475. /**
  56476. * Creates a PolygonMeshBuilder
  56477. * @param name name of the builder
  56478. * @param contours Path of the polygon
  56479. * @param scene scene to add to when creating the mesh
  56480. * @param earcutInjection can be used to inject your own earcut reference
  56481. */
  56482. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  56483. /**
  56484. * Adds a whole within the polygon
  56485. * @param hole Array of points defining the hole
  56486. * @returns this
  56487. */
  56488. addHole(hole: Vector2[]): PolygonMeshBuilder;
  56489. /**
  56490. * Creates the polygon
  56491. * @param updatable If the mesh should be updatable
  56492. * @param depth The depth of the mesh created
  56493. * @returns the created mesh
  56494. */
  56495. build(updatable?: boolean, depth?: number): Mesh;
  56496. /**
  56497. * Creates the polygon
  56498. * @param depth The depth of the mesh created
  56499. * @returns the created VertexData
  56500. */
  56501. buildVertexData(depth?: number): VertexData;
  56502. /**
  56503. * Adds a side to the polygon
  56504. * @param positions points that make the polygon
  56505. * @param normals normals of the polygon
  56506. * @param uvs uvs of the polygon
  56507. * @param indices indices of the polygon
  56508. * @param bounds bounds of the polygon
  56509. * @param points points of the polygon
  56510. * @param depth depth of the polygon
  56511. * @param flip flip of the polygon
  56512. */
  56513. private addSide;
  56514. }
  56515. }
  56516. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  56517. import { Scene } from "babylonjs/scene";
  56518. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  56519. import { Color4 } from "babylonjs/Maths/math.color";
  56520. import { Mesh } from "babylonjs/Meshes/mesh";
  56521. import { Nullable } from "babylonjs/types";
  56522. /**
  56523. * Class containing static functions to help procedurally build meshes
  56524. */
  56525. export class PolygonBuilder {
  56526. /**
  56527. * Creates a polygon mesh
  56528. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  56529. * * 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
  56530. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  56531. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56532. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  56533. * * Remember you can only change the shape positions, not their number when updating a polygon
  56534. * @param name defines the name of the mesh
  56535. * @param options defines the options used to create the mesh
  56536. * @param scene defines the hosting scene
  56537. * @param earcutInjection can be used to inject your own earcut reference
  56538. * @returns the polygon mesh
  56539. */
  56540. static CreatePolygon(name: string, options: {
  56541. shape: Vector3[];
  56542. holes?: Vector3[][];
  56543. depth?: number;
  56544. faceUV?: Vector4[];
  56545. faceColors?: Color4[];
  56546. updatable?: boolean;
  56547. sideOrientation?: number;
  56548. frontUVs?: Vector4;
  56549. backUVs?: Vector4;
  56550. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  56551. /**
  56552. * Creates an extruded polygon mesh, with depth in the Y direction.
  56553. * * 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)
  56554. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  56555. * @param name defines the name of the mesh
  56556. * @param options defines the options used to create the mesh
  56557. * @param scene defines the hosting scene
  56558. * @param earcutInjection can be used to inject your own earcut reference
  56559. * @returns the polygon mesh
  56560. */
  56561. static ExtrudePolygon(name: string, options: {
  56562. shape: Vector3[];
  56563. holes?: Vector3[][];
  56564. depth?: number;
  56565. faceUV?: Vector4[];
  56566. faceColors?: Color4[];
  56567. updatable?: boolean;
  56568. sideOrientation?: number;
  56569. frontUVs?: Vector4;
  56570. backUVs?: Vector4;
  56571. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  56572. }
  56573. }
  56574. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  56575. import { Scene } from "babylonjs/scene";
  56576. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  56577. import { Mesh } from "babylonjs/Meshes/mesh";
  56578. import { Nullable } from "babylonjs/types";
  56579. /**
  56580. * Class containing static functions to help procedurally build meshes
  56581. */
  56582. export class LatheBuilder {
  56583. /**
  56584. * Creates lathe mesh.
  56585. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  56586. * * 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
  56587. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  56588. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  56589. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  56590. * * 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
  56591. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  56592. * * 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
  56593. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56594. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56595. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  56596. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56597. * @param name defines the name of the mesh
  56598. * @param options defines the options used to create the mesh
  56599. * @param scene defines the hosting scene
  56600. * @returns the lathe mesh
  56601. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  56602. */
  56603. static CreateLathe(name: string, options: {
  56604. shape: Vector3[];
  56605. radius?: number;
  56606. tessellation?: number;
  56607. clip?: number;
  56608. arc?: number;
  56609. closed?: boolean;
  56610. updatable?: boolean;
  56611. sideOrientation?: number;
  56612. frontUVs?: Vector4;
  56613. backUVs?: Vector4;
  56614. cap?: number;
  56615. invertUV?: boolean;
  56616. }, scene?: Nullable<Scene>): Mesh;
  56617. }
  56618. }
  56619. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  56620. import { Nullable } from "babylonjs/types";
  56621. import { Scene } from "babylonjs/scene";
  56622. import { Vector4 } from "babylonjs/Maths/math.vector";
  56623. import { Mesh } from "babylonjs/Meshes/mesh";
  56624. /**
  56625. * Class containing static functions to help procedurally build meshes
  56626. */
  56627. export class TiledPlaneBuilder {
  56628. /**
  56629. * Creates a tiled plane mesh
  56630. * * The parameter `pattern` will, depending on value, do nothing or
  56631. * * * flip (reflect about central vertical) alternate tiles across and up
  56632. * * * flip every tile on alternate rows
  56633. * * * rotate (180 degs) alternate tiles across and up
  56634. * * * rotate every tile on alternate rows
  56635. * * * flip and rotate alternate tiles across and up
  56636. * * * flip and rotate every tile on alternate rows
  56637. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  56638. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  56639. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56640. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  56641. * * 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)
  56642. * * 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)
  56643. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  56644. * @param name defines the name of the mesh
  56645. * @param options defines the options used to create the mesh
  56646. * @param scene defines the hosting scene
  56647. * @returns the box mesh
  56648. */
  56649. static CreateTiledPlane(name: string, options: {
  56650. pattern?: number;
  56651. tileSize?: number;
  56652. tileWidth?: number;
  56653. tileHeight?: number;
  56654. size?: number;
  56655. width?: number;
  56656. height?: number;
  56657. alignHorizontal?: number;
  56658. alignVertical?: number;
  56659. sideOrientation?: number;
  56660. frontUVs?: Vector4;
  56661. backUVs?: Vector4;
  56662. updatable?: boolean;
  56663. }, scene?: Nullable<Scene>): Mesh;
  56664. }
  56665. }
  56666. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  56667. import { Nullable } from "babylonjs/types";
  56668. import { Scene } from "babylonjs/scene";
  56669. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  56670. import { Mesh } from "babylonjs/Meshes/mesh";
  56671. /**
  56672. * Class containing static functions to help procedurally build meshes
  56673. */
  56674. export class TubeBuilder {
  56675. /**
  56676. * Creates a tube mesh.
  56677. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  56678. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  56679. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  56680. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  56681. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  56682. * * 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)
  56683. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  56684. * * 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
  56685. * * 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
  56686. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56687. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56688. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  56689. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56690. * @param name defines the name of the mesh
  56691. * @param options defines the options used to create the mesh
  56692. * @param scene defines the hosting scene
  56693. * @returns the tube mesh
  56694. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  56695. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  56696. */
  56697. static CreateTube(name: string, options: {
  56698. path: Vector3[];
  56699. radius?: number;
  56700. tessellation?: number;
  56701. radiusFunction?: {
  56702. (i: number, distance: number): number;
  56703. };
  56704. cap?: number;
  56705. arc?: number;
  56706. updatable?: boolean;
  56707. sideOrientation?: number;
  56708. frontUVs?: Vector4;
  56709. backUVs?: Vector4;
  56710. instance?: Mesh;
  56711. invertUV?: boolean;
  56712. }, scene?: Nullable<Scene>): Mesh;
  56713. }
  56714. }
  56715. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  56716. import { Scene } from "babylonjs/scene";
  56717. import { Vector4 } from "babylonjs/Maths/math.vector";
  56718. import { Mesh } from "babylonjs/Meshes/mesh";
  56719. import { Nullable } from "babylonjs/types";
  56720. /**
  56721. * Class containing static functions to help procedurally build meshes
  56722. */
  56723. export class IcoSphereBuilder {
  56724. /**
  56725. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  56726. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  56727. * * 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`)
  56728. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  56729. * * 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
  56730. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56731. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56732. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56733. * @param name defines the name of the mesh
  56734. * @param options defines the options used to create the mesh
  56735. * @param scene defines the hosting scene
  56736. * @returns the icosahedron mesh
  56737. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  56738. */
  56739. static CreateIcoSphere(name: string, options: {
  56740. radius?: number;
  56741. radiusX?: number;
  56742. radiusY?: number;
  56743. radiusZ?: number;
  56744. flat?: boolean;
  56745. subdivisions?: number;
  56746. sideOrientation?: number;
  56747. frontUVs?: Vector4;
  56748. backUVs?: Vector4;
  56749. updatable?: boolean;
  56750. }, scene?: Nullable<Scene>): Mesh;
  56751. }
  56752. }
  56753. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  56754. import { Vector3 } from "babylonjs/Maths/math.vector";
  56755. import { Mesh } from "babylonjs/Meshes/mesh";
  56756. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56757. /**
  56758. * Class containing static functions to help procedurally build meshes
  56759. */
  56760. export class DecalBuilder {
  56761. /**
  56762. * Creates a decal mesh.
  56763. * 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
  56764. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  56765. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  56766. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  56767. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  56768. * @param name defines the name of the mesh
  56769. * @param sourceMesh defines the mesh where the decal must be applied
  56770. * @param options defines the options used to create the mesh
  56771. * @param scene defines the hosting scene
  56772. * @returns the decal mesh
  56773. * @see https://doc.babylonjs.com/how_to/decals
  56774. */
  56775. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  56776. position?: Vector3;
  56777. normal?: Vector3;
  56778. size?: Vector3;
  56779. angle?: number;
  56780. }): Mesh;
  56781. }
  56782. }
  56783. declare module "babylonjs/Meshes/meshBuilder" {
  56784. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  56785. import { Nullable } from "babylonjs/types";
  56786. import { Scene } from "babylonjs/scene";
  56787. import { Mesh } from "babylonjs/Meshes/mesh";
  56788. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  56789. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  56790. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56791. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  56792. import { Plane } from "babylonjs/Maths/math.plane";
  56793. /**
  56794. * Class containing static functions to help procedurally build meshes
  56795. */
  56796. export class MeshBuilder {
  56797. /**
  56798. * Creates a box mesh
  56799. * * The parameter `size` sets the size (float) of each box side (default 1)
  56800. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  56801. * * 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)
  56802. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  56803. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56804. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56805. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56806. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  56807. * @param name defines the name of the mesh
  56808. * @param options defines the options used to create the mesh
  56809. * @param scene defines the hosting scene
  56810. * @returns the box mesh
  56811. */
  56812. static CreateBox(name: string, options: {
  56813. size?: number;
  56814. width?: number;
  56815. height?: number;
  56816. depth?: number;
  56817. faceUV?: Vector4[];
  56818. faceColors?: Color4[];
  56819. sideOrientation?: number;
  56820. frontUVs?: Vector4;
  56821. backUVs?: Vector4;
  56822. updatable?: boolean;
  56823. }, scene?: Nullable<Scene>): Mesh;
  56824. /**
  56825. * Creates a tiled box mesh
  56826. * * faceTiles sets the pattern, tile size and number of tiles for a face
  56827. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56828. * @param name defines the name of the mesh
  56829. * @param options defines the options used to create the mesh
  56830. * @param scene defines the hosting scene
  56831. * @returns the tiled box mesh
  56832. */
  56833. static CreateTiledBox(name: string, options: {
  56834. pattern?: number;
  56835. size?: number;
  56836. width?: number;
  56837. height?: number;
  56838. depth: number;
  56839. tileSize?: number;
  56840. tileWidth?: number;
  56841. tileHeight?: number;
  56842. faceUV?: Vector4[];
  56843. faceColors?: Color4[];
  56844. alignHorizontal?: number;
  56845. alignVertical?: number;
  56846. sideOrientation?: number;
  56847. updatable?: boolean;
  56848. }, scene?: Nullable<Scene>): Mesh;
  56849. /**
  56850. * Creates a sphere mesh
  56851. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  56852. * * 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`)
  56853. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  56854. * * 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
  56855. * * 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)
  56856. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56857. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56858. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56859. * @param name defines the name of the mesh
  56860. * @param options defines the options used to create the mesh
  56861. * @param scene defines the hosting scene
  56862. * @returns the sphere mesh
  56863. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  56864. */
  56865. static CreateSphere(name: string, options: {
  56866. segments?: number;
  56867. diameter?: number;
  56868. diameterX?: number;
  56869. diameterY?: number;
  56870. diameterZ?: number;
  56871. arc?: number;
  56872. slice?: number;
  56873. sideOrientation?: number;
  56874. frontUVs?: Vector4;
  56875. backUVs?: Vector4;
  56876. updatable?: boolean;
  56877. }, scene?: Nullable<Scene>): Mesh;
  56878. /**
  56879. * Creates a plane polygonal mesh. By default, this is a disc
  56880. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  56881. * * 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
  56882. * * 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
  56883. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56884. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56885. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56886. * @param name defines the name of the mesh
  56887. * @param options defines the options used to create the mesh
  56888. * @param scene defines the hosting scene
  56889. * @returns the plane polygonal mesh
  56890. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  56891. */
  56892. static CreateDisc(name: string, options: {
  56893. radius?: number;
  56894. tessellation?: number;
  56895. arc?: number;
  56896. updatable?: boolean;
  56897. sideOrientation?: number;
  56898. frontUVs?: Vector4;
  56899. backUVs?: Vector4;
  56900. }, scene?: Nullable<Scene>): Mesh;
  56901. /**
  56902. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  56903. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  56904. * * 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`)
  56905. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  56906. * * 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
  56907. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56908. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56909. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56910. * @param name defines the name of the mesh
  56911. * @param options defines the options used to create the mesh
  56912. * @param scene defines the hosting scene
  56913. * @returns the icosahedron mesh
  56914. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  56915. */
  56916. static CreateIcoSphere(name: string, options: {
  56917. radius?: number;
  56918. radiusX?: number;
  56919. radiusY?: number;
  56920. radiusZ?: number;
  56921. flat?: boolean;
  56922. subdivisions?: number;
  56923. sideOrientation?: number;
  56924. frontUVs?: Vector4;
  56925. backUVs?: Vector4;
  56926. updatable?: boolean;
  56927. }, scene?: Nullable<Scene>): Mesh;
  56928. /**
  56929. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  56930. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  56931. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  56932. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  56933. * * 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
  56934. * * 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
  56935. * * 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
  56936. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56937. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56938. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  56939. * * 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
  56940. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  56941. * * 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
  56942. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  56943. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  56944. * @param name defines the name of the mesh
  56945. * @param options defines the options used to create the mesh
  56946. * @param scene defines the hosting scene
  56947. * @returns the ribbon mesh
  56948. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  56949. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  56950. */
  56951. static CreateRibbon(name: string, options: {
  56952. pathArray: Vector3[][];
  56953. closeArray?: boolean;
  56954. closePath?: boolean;
  56955. offset?: number;
  56956. updatable?: boolean;
  56957. sideOrientation?: number;
  56958. frontUVs?: Vector4;
  56959. backUVs?: Vector4;
  56960. instance?: Mesh;
  56961. invertUV?: boolean;
  56962. uvs?: Vector2[];
  56963. colors?: Color4[];
  56964. }, scene?: Nullable<Scene>): Mesh;
  56965. /**
  56966. * Creates a cylinder or a cone mesh
  56967. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  56968. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  56969. * * 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.
  56970. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  56971. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  56972. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  56973. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  56974. * * 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).
  56975. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  56976. * * 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).
  56977. * * 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
  56978. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  56979. * * 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
  56980. * * 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.
  56981. * * If `enclose` is false, a ring surface is one element.
  56982. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  56983. * * 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
  56984. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  56985. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  56986. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  56987. * @param name defines the name of the mesh
  56988. * @param options defines the options used to create the mesh
  56989. * @param scene defines the hosting scene
  56990. * @returns the cylinder mesh
  56991. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  56992. */
  56993. static CreateCylinder(name: string, options: {
  56994. height?: number;
  56995. diameterTop?: number;
  56996. diameterBottom?: number;
  56997. diameter?: number;
  56998. tessellation?: number;
  56999. subdivisions?: number;
  57000. arc?: number;
  57001. faceColors?: Color4[];
  57002. faceUV?: Vector4[];
  57003. updatable?: boolean;
  57004. hasRings?: boolean;
  57005. enclose?: boolean;
  57006. cap?: number;
  57007. sideOrientation?: number;
  57008. frontUVs?: Vector4;
  57009. backUVs?: Vector4;
  57010. }, scene?: Nullable<Scene>): Mesh;
  57011. /**
  57012. * Creates a torus mesh
  57013. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  57014. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  57015. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  57016. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57017. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57018. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  57019. * @param name defines the name of the mesh
  57020. * @param options defines the options used to create the mesh
  57021. * @param scene defines the hosting scene
  57022. * @returns the torus mesh
  57023. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  57024. */
  57025. static CreateTorus(name: string, options: {
  57026. diameter?: number;
  57027. thickness?: number;
  57028. tessellation?: number;
  57029. updatable?: boolean;
  57030. sideOrientation?: number;
  57031. frontUVs?: Vector4;
  57032. backUVs?: Vector4;
  57033. }, scene?: Nullable<Scene>): Mesh;
  57034. /**
  57035. * Creates a torus knot mesh
  57036. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  57037. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  57038. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  57039. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  57040. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57041. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57042. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  57043. * @param name defines the name of the mesh
  57044. * @param options defines the options used to create the mesh
  57045. * @param scene defines the hosting scene
  57046. * @returns the torus knot mesh
  57047. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  57048. */
  57049. static CreateTorusKnot(name: string, options: {
  57050. radius?: number;
  57051. tube?: number;
  57052. radialSegments?: number;
  57053. tubularSegments?: number;
  57054. p?: number;
  57055. q?: number;
  57056. updatable?: boolean;
  57057. sideOrientation?: number;
  57058. frontUVs?: Vector4;
  57059. backUVs?: Vector4;
  57060. }, scene?: Nullable<Scene>): Mesh;
  57061. /**
  57062. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  57063. * * 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
  57064. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  57065. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  57066. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  57067. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  57068. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  57069. * * 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
  57070. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  57071. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57072. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  57073. * @param name defines the name of the new line system
  57074. * @param options defines the options used to create the line system
  57075. * @param scene defines the hosting scene
  57076. * @returns a new line system mesh
  57077. */
  57078. static CreateLineSystem(name: string, options: {
  57079. lines: Vector3[][];
  57080. updatable?: boolean;
  57081. instance?: Nullable<LinesMesh>;
  57082. colors?: Nullable<Color4[][]>;
  57083. useVertexAlpha?: boolean;
  57084. }, scene: Nullable<Scene>): LinesMesh;
  57085. /**
  57086. * Creates a line mesh
  57087. * 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
  57088. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  57089. * * The parameter `points` is an array successive Vector3
  57090. * * 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
  57091. * * The optional parameter `colors` is an array of successive Color4, one per line point
  57092. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  57093. * * When updating an instance, remember that only point positions can change, not the number of points
  57094. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57095. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  57096. * @param name defines the name of the new line system
  57097. * @param options defines the options used to create the line system
  57098. * @param scene defines the hosting scene
  57099. * @returns a new line mesh
  57100. */
  57101. static CreateLines(name: string, options: {
  57102. points: Vector3[];
  57103. updatable?: boolean;
  57104. instance?: Nullable<LinesMesh>;
  57105. colors?: Color4[];
  57106. useVertexAlpha?: boolean;
  57107. }, scene?: Nullable<Scene>): LinesMesh;
  57108. /**
  57109. * Creates a dashed line mesh
  57110. * * 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
  57111. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  57112. * * The parameter `points` is an array successive Vector3
  57113. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  57114. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  57115. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  57116. * * 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
  57117. * * When updating an instance, remember that only point positions can change, not the number of points
  57118. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57119. * @param name defines the name of the mesh
  57120. * @param options defines the options used to create the mesh
  57121. * @param scene defines the hosting scene
  57122. * @returns the dashed line mesh
  57123. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  57124. */
  57125. static CreateDashedLines(name: string, options: {
  57126. points: Vector3[];
  57127. dashSize?: number;
  57128. gapSize?: number;
  57129. dashNb?: number;
  57130. updatable?: boolean;
  57131. instance?: LinesMesh;
  57132. }, scene?: Nullable<Scene>): LinesMesh;
  57133. /**
  57134. * 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.
  57135. * * 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.
  57136. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  57137. * * 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.
  57138. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  57139. * * 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
  57140. * * 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
  57141. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  57142. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57143. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57144. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  57145. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  57146. * @param name defines the name of the mesh
  57147. * @param options defines the options used to create the mesh
  57148. * @param scene defines the hosting scene
  57149. * @returns the extruded shape mesh
  57150. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  57151. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  57152. */
  57153. static ExtrudeShape(name: string, options: {
  57154. shape: Vector3[];
  57155. path: Vector3[];
  57156. scale?: number;
  57157. rotation?: number;
  57158. cap?: number;
  57159. updatable?: boolean;
  57160. sideOrientation?: number;
  57161. frontUVs?: Vector4;
  57162. backUVs?: Vector4;
  57163. instance?: Mesh;
  57164. invertUV?: boolean;
  57165. }, scene?: Nullable<Scene>): Mesh;
  57166. /**
  57167. * Creates an custom extruded shape mesh.
  57168. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  57169. * * 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.
  57170. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  57171. * * 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
  57172. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  57173. * * 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
  57174. * * It must returns a float value that will be the scale value applied to the shape on each path point
  57175. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  57176. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  57177. * * 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
  57178. * * 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
  57179. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  57180. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57181. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57182. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  57183. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57184. * @param name defines the name of the mesh
  57185. * @param options defines the options used to create the mesh
  57186. * @param scene defines the hosting scene
  57187. * @returns the custom extruded shape mesh
  57188. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  57189. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  57190. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  57191. */
  57192. static ExtrudeShapeCustom(name: string, options: {
  57193. shape: Vector3[];
  57194. path: Vector3[];
  57195. scaleFunction?: any;
  57196. rotationFunction?: any;
  57197. ribbonCloseArray?: boolean;
  57198. ribbonClosePath?: boolean;
  57199. cap?: number;
  57200. updatable?: boolean;
  57201. sideOrientation?: number;
  57202. frontUVs?: Vector4;
  57203. backUVs?: Vector4;
  57204. instance?: Mesh;
  57205. invertUV?: boolean;
  57206. }, scene?: Nullable<Scene>): Mesh;
  57207. /**
  57208. * Creates lathe mesh.
  57209. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  57210. * * 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
  57211. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  57212. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  57213. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  57214. * * 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
  57215. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  57216. * * 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
  57217. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57218. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57219. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  57220. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57221. * @param name defines the name of the mesh
  57222. * @param options defines the options used to create the mesh
  57223. * @param scene defines the hosting scene
  57224. * @returns the lathe mesh
  57225. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  57226. */
  57227. static CreateLathe(name: string, options: {
  57228. shape: Vector3[];
  57229. radius?: number;
  57230. tessellation?: number;
  57231. clip?: number;
  57232. arc?: number;
  57233. closed?: boolean;
  57234. updatable?: boolean;
  57235. sideOrientation?: number;
  57236. frontUVs?: Vector4;
  57237. backUVs?: Vector4;
  57238. cap?: number;
  57239. invertUV?: boolean;
  57240. }, scene?: Nullable<Scene>): Mesh;
  57241. /**
  57242. * Creates a tiled plane mesh
  57243. * * You can set a limited pattern arrangement with the tiles
  57244. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57245. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57246. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57247. * @param name defines the name of the mesh
  57248. * @param options defines the options used to create the mesh
  57249. * @param scene defines the hosting scene
  57250. * @returns the plane mesh
  57251. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  57252. */
  57253. static CreateTiledPlane(name: string, options: {
  57254. pattern?: number;
  57255. tileSize?: number;
  57256. tileWidth?: number;
  57257. tileHeight?: number;
  57258. size?: number;
  57259. width?: number;
  57260. height?: number;
  57261. alignHorizontal?: number;
  57262. alignVertical?: number;
  57263. sideOrientation?: number;
  57264. frontUVs?: Vector4;
  57265. backUVs?: Vector4;
  57266. updatable?: boolean;
  57267. }, scene?: Nullable<Scene>): Mesh;
  57268. /**
  57269. * Creates a plane mesh
  57270. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  57271. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  57272. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  57273. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57274. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57275. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57276. * @param name defines the name of the mesh
  57277. * @param options defines the options used to create the mesh
  57278. * @param scene defines the hosting scene
  57279. * @returns the plane mesh
  57280. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  57281. */
  57282. static CreatePlane(name: string, options: {
  57283. size?: number;
  57284. width?: number;
  57285. height?: number;
  57286. sideOrientation?: number;
  57287. frontUVs?: Vector4;
  57288. backUVs?: Vector4;
  57289. updatable?: boolean;
  57290. sourcePlane?: Plane;
  57291. }, scene?: Nullable<Scene>): Mesh;
  57292. /**
  57293. * Creates a ground mesh
  57294. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  57295. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  57296. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57297. * @param name defines the name of the mesh
  57298. * @param options defines the options used to create the mesh
  57299. * @param scene defines the hosting scene
  57300. * @returns the ground mesh
  57301. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  57302. */
  57303. static CreateGround(name: string, options: {
  57304. width?: number;
  57305. height?: number;
  57306. subdivisions?: number;
  57307. subdivisionsX?: number;
  57308. subdivisionsY?: number;
  57309. updatable?: boolean;
  57310. }, scene?: Nullable<Scene>): Mesh;
  57311. /**
  57312. * Creates a tiled ground mesh
  57313. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  57314. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  57315. * * 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
  57316. * * 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
  57317. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  57318. * @param name defines the name of the mesh
  57319. * @param options defines the options used to create the mesh
  57320. * @param scene defines the hosting scene
  57321. * @returns the tiled ground mesh
  57322. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  57323. */
  57324. static CreateTiledGround(name: string, options: {
  57325. xmin: number;
  57326. zmin: number;
  57327. xmax: number;
  57328. zmax: number;
  57329. subdivisions?: {
  57330. w: number;
  57331. h: number;
  57332. };
  57333. precision?: {
  57334. w: number;
  57335. h: number;
  57336. };
  57337. updatable?: boolean;
  57338. }, scene?: Nullable<Scene>): Mesh;
  57339. /**
  57340. * Creates a ground mesh from a height map
  57341. * * The parameter `url` sets the URL of the height map image resource.
  57342. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  57343. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  57344. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  57345. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  57346. * * 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.
  57347. * * 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).
  57348. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  57349. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  57350. * @param name defines the name of the mesh
  57351. * @param url defines the url to the height map
  57352. * @param options defines the options used to create the mesh
  57353. * @param scene defines the hosting scene
  57354. * @returns the ground mesh
  57355. * @see https://doc.babylonjs.com/babylon101/height_map
  57356. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  57357. */
  57358. static CreateGroundFromHeightMap(name: string, url: string, options: {
  57359. width?: number;
  57360. height?: number;
  57361. subdivisions?: number;
  57362. minHeight?: number;
  57363. maxHeight?: number;
  57364. colorFilter?: Color3;
  57365. alphaFilter?: number;
  57366. updatable?: boolean;
  57367. onReady?: (mesh: GroundMesh) => void;
  57368. }, scene?: Nullable<Scene>): GroundMesh;
  57369. /**
  57370. * Creates a polygon mesh
  57371. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  57372. * * 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
  57373. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  57374. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57375. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  57376. * * Remember you can only change the shape positions, not their number when updating a polygon
  57377. * @param name defines the name of the mesh
  57378. * @param options defines the options used to create the mesh
  57379. * @param scene defines the hosting scene
  57380. * @param earcutInjection can be used to inject your own earcut reference
  57381. * @returns the polygon mesh
  57382. */
  57383. static CreatePolygon(name: string, options: {
  57384. shape: Vector3[];
  57385. holes?: Vector3[][];
  57386. depth?: number;
  57387. faceUV?: Vector4[];
  57388. faceColors?: Color4[];
  57389. updatable?: boolean;
  57390. sideOrientation?: number;
  57391. frontUVs?: Vector4;
  57392. backUVs?: Vector4;
  57393. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  57394. /**
  57395. * Creates an extruded polygon mesh, with depth in the Y direction.
  57396. * * 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)
  57397. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  57398. * @param name defines the name of the mesh
  57399. * @param options defines the options used to create the mesh
  57400. * @param scene defines the hosting scene
  57401. * @param earcutInjection can be used to inject your own earcut reference
  57402. * @returns the polygon mesh
  57403. */
  57404. static ExtrudePolygon(name: string, options: {
  57405. shape: Vector3[];
  57406. holes?: Vector3[][];
  57407. depth?: number;
  57408. faceUV?: Vector4[];
  57409. faceColors?: Color4[];
  57410. updatable?: boolean;
  57411. sideOrientation?: number;
  57412. frontUVs?: Vector4;
  57413. backUVs?: Vector4;
  57414. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  57415. /**
  57416. * Creates a tube mesh.
  57417. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  57418. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  57419. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  57420. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  57421. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  57422. * * 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)
  57423. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  57424. * * 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
  57425. * * 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
  57426. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57427. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57428. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  57429. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57430. * @param name defines the name of the mesh
  57431. * @param options defines the options used to create the mesh
  57432. * @param scene defines the hosting scene
  57433. * @returns the tube mesh
  57434. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  57435. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  57436. */
  57437. static CreateTube(name: string, options: {
  57438. path: Vector3[];
  57439. radius?: number;
  57440. tessellation?: number;
  57441. radiusFunction?: {
  57442. (i: number, distance: number): number;
  57443. };
  57444. cap?: number;
  57445. arc?: number;
  57446. updatable?: boolean;
  57447. sideOrientation?: number;
  57448. frontUVs?: Vector4;
  57449. backUVs?: Vector4;
  57450. instance?: Mesh;
  57451. invertUV?: boolean;
  57452. }, scene?: Nullable<Scene>): Mesh;
  57453. /**
  57454. * Creates a polyhedron mesh
  57455. * * 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
  57456. * * The parameter `size` (positive float, default 1) sets the polygon size
  57457. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  57458. * * 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`
  57459. * * 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
  57460. * * 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)`)
  57461. * * 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
  57462. * * 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
  57463. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  57464. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  57465. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  57466. * @param name defines the name of the mesh
  57467. * @param options defines the options used to create the mesh
  57468. * @param scene defines the hosting scene
  57469. * @returns the polyhedron mesh
  57470. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  57471. */
  57472. static CreatePolyhedron(name: string, options: {
  57473. type?: number;
  57474. size?: number;
  57475. sizeX?: number;
  57476. sizeY?: number;
  57477. sizeZ?: number;
  57478. custom?: any;
  57479. faceUV?: Vector4[];
  57480. faceColors?: Color4[];
  57481. flat?: boolean;
  57482. updatable?: boolean;
  57483. sideOrientation?: number;
  57484. frontUVs?: Vector4;
  57485. backUVs?: Vector4;
  57486. }, scene?: Nullable<Scene>): Mesh;
  57487. /**
  57488. * Creates a decal mesh.
  57489. * 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
  57490. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  57491. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  57492. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  57493. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  57494. * @param name defines the name of the mesh
  57495. * @param sourceMesh defines the mesh where the decal must be applied
  57496. * @param options defines the options used to create the mesh
  57497. * @param scene defines the hosting scene
  57498. * @returns the decal mesh
  57499. * @see https://doc.babylonjs.com/how_to/decals
  57500. */
  57501. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  57502. position?: Vector3;
  57503. normal?: Vector3;
  57504. size?: Vector3;
  57505. angle?: number;
  57506. }): Mesh;
  57507. }
  57508. }
  57509. declare module "babylonjs/Meshes/meshSimplification" {
  57510. import { Mesh } from "babylonjs/Meshes/mesh";
  57511. /**
  57512. * A simplifier interface for future simplification implementations
  57513. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  57514. */
  57515. export interface ISimplifier {
  57516. /**
  57517. * Simplification of a given mesh according to the given settings.
  57518. * Since this requires computation, it is assumed that the function runs async.
  57519. * @param settings The settings of the simplification, including quality and distance
  57520. * @param successCallback A callback that will be called after the mesh was simplified.
  57521. * @param errorCallback in case of an error, this callback will be called. optional.
  57522. */
  57523. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  57524. }
  57525. /**
  57526. * Expected simplification settings.
  57527. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  57528. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  57529. */
  57530. export interface ISimplificationSettings {
  57531. /**
  57532. * Gets or sets the expected quality
  57533. */
  57534. quality: number;
  57535. /**
  57536. * Gets or sets the distance when this optimized version should be used
  57537. */
  57538. distance: number;
  57539. /**
  57540. * Gets an already optimized mesh
  57541. */
  57542. optimizeMesh?: boolean;
  57543. }
  57544. /**
  57545. * Class used to specify simplification options
  57546. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  57547. */
  57548. export class SimplificationSettings implements ISimplificationSettings {
  57549. /** expected quality */
  57550. quality: number;
  57551. /** distance when this optimized version should be used */
  57552. distance: number;
  57553. /** already optimized mesh */
  57554. optimizeMesh?: boolean | undefined;
  57555. /**
  57556. * Creates a SimplificationSettings
  57557. * @param quality expected quality
  57558. * @param distance distance when this optimized version should be used
  57559. * @param optimizeMesh already optimized mesh
  57560. */
  57561. constructor(
  57562. /** expected quality */
  57563. quality: number,
  57564. /** distance when this optimized version should be used */
  57565. distance: number,
  57566. /** already optimized mesh */
  57567. optimizeMesh?: boolean | undefined);
  57568. }
  57569. /**
  57570. * Interface used to define a simplification task
  57571. */
  57572. export interface ISimplificationTask {
  57573. /**
  57574. * Array of settings
  57575. */
  57576. settings: Array<ISimplificationSettings>;
  57577. /**
  57578. * Simplification type
  57579. */
  57580. simplificationType: SimplificationType;
  57581. /**
  57582. * Mesh to simplify
  57583. */
  57584. mesh: Mesh;
  57585. /**
  57586. * Callback called on success
  57587. */
  57588. successCallback?: () => void;
  57589. /**
  57590. * Defines if parallel processing can be used
  57591. */
  57592. parallelProcessing: boolean;
  57593. }
  57594. /**
  57595. * Queue used to order the simplification tasks
  57596. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  57597. */
  57598. export class SimplificationQueue {
  57599. private _simplificationArray;
  57600. /**
  57601. * Gets a boolean indicating that the process is still running
  57602. */
  57603. running: boolean;
  57604. /**
  57605. * Creates a new queue
  57606. */
  57607. constructor();
  57608. /**
  57609. * Adds a new simplification task
  57610. * @param task defines a task to add
  57611. */
  57612. addTask(task: ISimplificationTask): void;
  57613. /**
  57614. * Execute next task
  57615. */
  57616. executeNext(): void;
  57617. /**
  57618. * Execute a simplification task
  57619. * @param task defines the task to run
  57620. */
  57621. runSimplification(task: ISimplificationTask): void;
  57622. private getSimplifier;
  57623. }
  57624. /**
  57625. * The implemented types of simplification
  57626. * At the moment only Quadratic Error Decimation is implemented
  57627. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  57628. */
  57629. export enum SimplificationType {
  57630. /** Quadratic error decimation */
  57631. QUADRATIC = 0
  57632. }
  57633. }
  57634. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  57635. import { Scene } from "babylonjs/scene";
  57636. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  57637. import { ISceneComponent } from "babylonjs/sceneComponent";
  57638. module "babylonjs/scene" {
  57639. interface Scene {
  57640. /** @hidden (Backing field) */
  57641. _simplificationQueue: SimplificationQueue;
  57642. /**
  57643. * Gets or sets the simplification queue attached to the scene
  57644. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  57645. */
  57646. simplificationQueue: SimplificationQueue;
  57647. }
  57648. }
  57649. module "babylonjs/Meshes/mesh" {
  57650. interface Mesh {
  57651. /**
  57652. * Simplify the mesh according to the given array of settings.
  57653. * Function will return immediately and will simplify async
  57654. * @param settings a collection of simplification settings
  57655. * @param parallelProcessing should all levels calculate parallel or one after the other
  57656. * @param simplificationType the type of simplification to run
  57657. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  57658. * @returns the current mesh
  57659. */
  57660. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  57661. }
  57662. }
  57663. /**
  57664. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  57665. * created in a scene
  57666. */
  57667. export class SimplicationQueueSceneComponent implements ISceneComponent {
  57668. /**
  57669. * The component name helpfull to identify the component in the list of scene components.
  57670. */
  57671. readonly name: string;
  57672. /**
  57673. * The scene the component belongs to.
  57674. */
  57675. scene: Scene;
  57676. /**
  57677. * Creates a new instance of the component for the given scene
  57678. * @param scene Defines the scene to register the component in
  57679. */
  57680. constructor(scene: Scene);
  57681. /**
  57682. * Registers the component in a given scene
  57683. */
  57684. register(): void;
  57685. /**
  57686. * Rebuilds the elements related to this component in case of
  57687. * context lost for instance.
  57688. */
  57689. rebuild(): void;
  57690. /**
  57691. * Disposes the component and the associated ressources
  57692. */
  57693. dispose(): void;
  57694. private _beforeCameraUpdate;
  57695. }
  57696. }
  57697. declare module "babylonjs/Meshes/Builders/index" {
  57698. export * from "babylonjs/Meshes/Builders/boxBuilder";
  57699. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  57700. export * from "babylonjs/Meshes/Builders/discBuilder";
  57701. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  57702. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  57703. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  57704. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  57705. export * from "babylonjs/Meshes/Builders/torusBuilder";
  57706. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  57707. export * from "babylonjs/Meshes/Builders/linesBuilder";
  57708. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  57709. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  57710. export * from "babylonjs/Meshes/Builders/latheBuilder";
  57711. export * from "babylonjs/Meshes/Builders/planeBuilder";
  57712. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  57713. export * from "babylonjs/Meshes/Builders/groundBuilder";
  57714. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  57715. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  57716. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  57717. export * from "babylonjs/Meshes/Builders/decalBuilder";
  57718. }
  57719. declare module "babylonjs/Meshes/index" {
  57720. export * from "babylonjs/Meshes/abstractMesh";
  57721. export * from "babylonjs/Meshes/buffer";
  57722. export * from "babylonjs/Meshes/Compression/index";
  57723. export * from "babylonjs/Meshes/csg";
  57724. export * from "babylonjs/Meshes/geometry";
  57725. export * from "babylonjs/Meshes/groundMesh";
  57726. export * from "babylonjs/Meshes/trailMesh";
  57727. export * from "babylonjs/Meshes/instancedMesh";
  57728. export * from "babylonjs/Meshes/linesMesh";
  57729. export * from "babylonjs/Meshes/mesh";
  57730. export * from "babylonjs/Meshes/mesh.vertexData";
  57731. export * from "babylonjs/Meshes/meshBuilder";
  57732. export * from "babylonjs/Meshes/meshSimplification";
  57733. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  57734. export * from "babylonjs/Meshes/polygonMesh";
  57735. export * from "babylonjs/Meshes/subMesh";
  57736. export * from "babylonjs/Meshes/meshLODLevel";
  57737. export * from "babylonjs/Meshes/transformNode";
  57738. export * from "babylonjs/Meshes/Builders/index";
  57739. export * from "babylonjs/Meshes/dataBuffer";
  57740. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  57741. }
  57742. declare module "babylonjs/Morph/index" {
  57743. export * from "babylonjs/Morph/morphTarget";
  57744. export * from "babylonjs/Morph/morphTargetManager";
  57745. }
  57746. declare module "babylonjs/Navigation/INavigationEngine" {
  57747. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57748. import { Vector3 } from "babylonjs/Maths/math";
  57749. import { Mesh } from "babylonjs/Meshes/mesh";
  57750. import { Scene } from "babylonjs/scene";
  57751. /**
  57752. * Navigation plugin interface to add navigation constrained by a navigation mesh
  57753. */
  57754. export interface INavigationEnginePlugin {
  57755. /**
  57756. * plugin name
  57757. */
  57758. name: string;
  57759. /**
  57760. * Creates a navigation mesh
  57761. * @param meshes array of all the geometry used to compute the navigatio mesh
  57762. * @param parameters bunch of parameters used to filter geometry
  57763. */
  57764. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  57765. /**
  57766. * Create a navigation mesh debug mesh
  57767. * @param scene is where the mesh will be added
  57768. * @returns debug display mesh
  57769. */
  57770. createDebugNavMesh(scene: Scene): Mesh;
  57771. /**
  57772. * Get a navigation mesh constrained position, closest to the parameter position
  57773. * @param position world position
  57774. * @returns the closest point to position constrained by the navigation mesh
  57775. */
  57776. getClosestPoint(position: Vector3): Vector3;
  57777. /**
  57778. * Get a navigation mesh constrained position, within a particular radius
  57779. * @param position world position
  57780. * @param maxRadius the maximum distance to the constrained world position
  57781. * @returns the closest point to position constrained by the navigation mesh
  57782. */
  57783. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  57784. /**
  57785. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  57786. * @param start world position
  57787. * @param end world position
  57788. * @returns array containing world position composing the path
  57789. */
  57790. computePath(start: Vector3, end: Vector3): Vector3[];
  57791. /**
  57792. * If this plugin is supported
  57793. * @returns true if plugin is supported
  57794. */
  57795. isSupported(): boolean;
  57796. /**
  57797. * Create a new Crowd so you can add agents
  57798. * @param maxAgents the maximum agent count in the crowd
  57799. * @param maxAgentRadius the maximum radius an agent can have
  57800. * @param scene to attach the crowd to
  57801. * @returns the crowd you can add agents to
  57802. */
  57803. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  57804. /**
  57805. * Release all resources
  57806. */
  57807. dispose(): void;
  57808. }
  57809. /**
  57810. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  57811. */
  57812. export interface ICrowd {
  57813. /**
  57814. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  57815. * You can attach anything to that node. The node position is updated in the scene update tick.
  57816. * @param pos world position that will be constrained by the navigation mesh
  57817. * @param parameters agent parameters
  57818. * @param transform hooked to the agent that will be update by the scene
  57819. * @returns agent index
  57820. */
  57821. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  57822. /**
  57823. * Returns the agent position in world space
  57824. * @param index agent index returned by addAgent
  57825. * @returns world space position
  57826. */
  57827. getAgentPosition(index: number): Vector3;
  57828. /**
  57829. * Gets the agent velocity in world space
  57830. * @param index agent index returned by addAgent
  57831. * @returns world space velocity
  57832. */
  57833. getAgentVelocity(index: number): Vector3;
  57834. /**
  57835. * remove a particular agent previously created
  57836. * @param index agent index returned by addAgent
  57837. */
  57838. removeAgent(index: number): void;
  57839. /**
  57840. * get the list of all agents attached to this crowd
  57841. * @returns list of agent indices
  57842. */
  57843. getAgents(): number[];
  57844. /**
  57845. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  57846. * @param deltaTime in seconds
  57847. */
  57848. update(deltaTime: number): void;
  57849. /**
  57850. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  57851. * @param index agent index returned by addAgent
  57852. * @param destination targeted world position
  57853. */
  57854. agentGoto(index: number, destination: Vector3): void;
  57855. /**
  57856. * Release all resources
  57857. */
  57858. dispose(): void;
  57859. }
  57860. /**
  57861. * Configures an agent
  57862. */
  57863. export interface IAgentParameters {
  57864. /**
  57865. * Agent radius. [Limit: >= 0]
  57866. */
  57867. radius: number;
  57868. /**
  57869. * Agent height. [Limit: > 0]
  57870. */
  57871. height: number;
  57872. /**
  57873. * Maximum allowed acceleration. [Limit: >= 0]
  57874. */
  57875. maxAcceleration: number;
  57876. /**
  57877. * Maximum allowed speed. [Limit: >= 0]
  57878. */
  57879. maxSpeed: number;
  57880. /**
  57881. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  57882. */
  57883. collisionQueryRange: number;
  57884. /**
  57885. * The path visibility optimization range. [Limit: > 0]
  57886. */
  57887. pathOptimizationRange: number;
  57888. /**
  57889. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  57890. */
  57891. separationWeight: number;
  57892. }
  57893. /**
  57894. * Configures the navigation mesh creation
  57895. */
  57896. export interface INavMeshParameters {
  57897. /**
  57898. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  57899. */
  57900. cs: number;
  57901. /**
  57902. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  57903. */
  57904. ch: number;
  57905. /**
  57906. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  57907. */
  57908. walkableSlopeAngle: number;
  57909. /**
  57910. * Minimum floor to 'ceiling' height that will still allow the floor area to
  57911. * be considered walkable. [Limit: >= 3] [Units: vx]
  57912. */
  57913. walkableHeight: number;
  57914. /**
  57915. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  57916. */
  57917. walkableClimb: number;
  57918. /**
  57919. * The distance to erode/shrink the walkable area of the heightfield away from
  57920. * obstructions. [Limit: >=0] [Units: vx]
  57921. */
  57922. walkableRadius: number;
  57923. /**
  57924. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  57925. */
  57926. maxEdgeLen: number;
  57927. /**
  57928. * The maximum distance a simplfied contour's border edges should deviate
  57929. * the original raw contour. [Limit: >=0] [Units: vx]
  57930. */
  57931. maxSimplificationError: number;
  57932. /**
  57933. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  57934. */
  57935. minRegionArea: number;
  57936. /**
  57937. * Any regions with a span count smaller than this value will, if possible,
  57938. * be merged with larger regions. [Limit: >=0] [Units: vx]
  57939. */
  57940. mergeRegionArea: number;
  57941. /**
  57942. * The maximum number of vertices allowed for polygons generated during the
  57943. * contour to polygon conversion process. [Limit: >= 3]
  57944. */
  57945. maxVertsPerPoly: number;
  57946. /**
  57947. * Sets the sampling distance to use when generating the detail mesh.
  57948. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  57949. */
  57950. detailSampleDist: number;
  57951. /**
  57952. * The maximum distance the detail mesh surface should deviate from heightfield
  57953. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  57954. */
  57955. detailSampleMaxError: number;
  57956. }
  57957. }
  57958. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  57959. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  57960. import { Mesh } from "babylonjs/Meshes/mesh";
  57961. import { Scene } from "babylonjs/scene";
  57962. import { Vector3 } from "babylonjs/Maths/math";
  57963. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57964. /**
  57965. * RecastJS navigation plugin
  57966. */
  57967. export class RecastJSPlugin implements INavigationEnginePlugin {
  57968. /**
  57969. * Reference to the Recast library
  57970. */
  57971. bjsRECAST: any;
  57972. /**
  57973. * plugin name
  57974. */
  57975. name: string;
  57976. /**
  57977. * the first navmesh created. We might extend this to support multiple navmeshes
  57978. */
  57979. navMesh: any;
  57980. /**
  57981. * Initializes the recastJS plugin
  57982. * @param recastInjection can be used to inject your own recast reference
  57983. */
  57984. constructor(recastInjection?: any);
  57985. /**
  57986. * Creates a navigation mesh
  57987. * @param meshes array of all the geometry used to compute the navigatio mesh
  57988. * @param parameters bunch of parameters used to filter geometry
  57989. */
  57990. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  57991. /**
  57992. * Create a navigation mesh debug mesh
  57993. * @param scene is where the mesh will be added
  57994. * @returns debug display mesh
  57995. */
  57996. createDebugNavMesh(scene: Scene): Mesh;
  57997. /**
  57998. * Get a navigation mesh constrained position, closest to the parameter position
  57999. * @param position world position
  58000. * @returns the closest point to position constrained by the navigation mesh
  58001. */
  58002. getClosestPoint(position: Vector3): Vector3;
  58003. /**
  58004. * Get a navigation mesh constrained position, within a particular radius
  58005. * @param position world position
  58006. * @param maxRadius the maximum distance to the constrained world position
  58007. * @returns the closest point to position constrained by the navigation mesh
  58008. */
  58009. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  58010. /**
  58011. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  58012. * @param start world position
  58013. * @param end world position
  58014. * @returns array containing world position composing the path
  58015. */
  58016. computePath(start: Vector3, end: Vector3): Vector3[];
  58017. /**
  58018. * Create a new Crowd so you can add agents
  58019. * @param maxAgents the maximum agent count in the crowd
  58020. * @param maxAgentRadius the maximum radius an agent can have
  58021. * @param scene to attach the crowd to
  58022. * @returns the crowd you can add agents to
  58023. */
  58024. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  58025. /**
  58026. * Disposes
  58027. */
  58028. dispose(): void;
  58029. /**
  58030. * If this plugin is supported
  58031. * @returns true if plugin is supported
  58032. */
  58033. isSupported(): boolean;
  58034. }
  58035. /**
  58036. * Recast detour crowd implementation
  58037. */
  58038. export class RecastJSCrowd implements ICrowd {
  58039. /**
  58040. * Recast/detour plugin
  58041. */
  58042. bjsRECASTPlugin: RecastJSPlugin;
  58043. /**
  58044. * Link to the detour crowd
  58045. */
  58046. recastCrowd: any;
  58047. /**
  58048. * One transform per agent
  58049. */
  58050. transforms: TransformNode[];
  58051. /**
  58052. * All agents created
  58053. */
  58054. agents: number[];
  58055. /**
  58056. * Link to the scene is kept to unregister the crowd from the scene
  58057. */
  58058. private _scene;
  58059. /**
  58060. * Observer for crowd updates
  58061. */
  58062. private _onBeforeAnimationsObserver;
  58063. /**
  58064. * Constructor
  58065. * @param plugin recastJS plugin
  58066. * @param maxAgents the maximum agent count in the crowd
  58067. * @param maxAgentRadius the maximum radius an agent can have
  58068. * @param scene to attach the crowd to
  58069. * @returns the crowd you can add agents to
  58070. */
  58071. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  58072. /**
  58073. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  58074. * You can attach anything to that node. The node position is updated in the scene update tick.
  58075. * @param pos world position that will be constrained by the navigation mesh
  58076. * @param parameters agent parameters
  58077. * @param transform hooked to the agent that will be update by the scene
  58078. * @returns agent index
  58079. */
  58080. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  58081. /**
  58082. * Returns the agent position in world space
  58083. * @param index agent index returned by addAgent
  58084. * @returns world space position
  58085. */
  58086. getAgentPosition(index: number): Vector3;
  58087. /**
  58088. * Returns the agent velocity in world space
  58089. * @param index agent index returned by addAgent
  58090. * @returns world space velocity
  58091. */
  58092. getAgentVelocity(index: number): Vector3;
  58093. /**
  58094. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  58095. * @param index agent index returned by addAgent
  58096. * @param destination targeted world position
  58097. */
  58098. agentGoto(index: number, destination: Vector3): void;
  58099. /**
  58100. * remove a particular agent previously created
  58101. * @param index agent index returned by addAgent
  58102. */
  58103. removeAgent(index: number): void;
  58104. /**
  58105. * get the list of all agents attached to this crowd
  58106. * @returns list of agent indices
  58107. */
  58108. getAgents(): number[];
  58109. /**
  58110. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  58111. * @param deltaTime in seconds
  58112. */
  58113. update(deltaTime: number): void;
  58114. /**
  58115. * Release all resources
  58116. */
  58117. dispose(): void;
  58118. }
  58119. }
  58120. declare module "babylonjs/Navigation/Plugins/index" {
  58121. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  58122. }
  58123. declare module "babylonjs/Navigation/index" {
  58124. export * from "babylonjs/Navigation/INavigationEngine";
  58125. export * from "babylonjs/Navigation/Plugins/index";
  58126. }
  58127. declare module "babylonjs/Offline/database" {
  58128. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  58129. /**
  58130. * Class used to enable access to IndexedDB
  58131. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  58132. */
  58133. export class Database implements IOfflineProvider {
  58134. private _callbackManifestChecked;
  58135. private _currentSceneUrl;
  58136. private _db;
  58137. private _enableSceneOffline;
  58138. private _enableTexturesOffline;
  58139. private _manifestVersionFound;
  58140. private _mustUpdateRessources;
  58141. private _hasReachedQuota;
  58142. private _isSupported;
  58143. private _idbFactory;
  58144. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  58145. private static IsUASupportingBlobStorage;
  58146. /**
  58147. * Gets a boolean indicating if Database storate is enabled (off by default)
  58148. */
  58149. static IDBStorageEnabled: boolean;
  58150. /**
  58151. * Gets a boolean indicating if scene must be saved in the database
  58152. */
  58153. readonly enableSceneOffline: boolean;
  58154. /**
  58155. * Gets a boolean indicating if textures must be saved in the database
  58156. */
  58157. readonly enableTexturesOffline: boolean;
  58158. /**
  58159. * Creates a new Database
  58160. * @param urlToScene defines the url to load the scene
  58161. * @param callbackManifestChecked defines the callback to use when manifest is checked
  58162. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  58163. */
  58164. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  58165. private static _ParseURL;
  58166. private static _ReturnFullUrlLocation;
  58167. private _checkManifestFile;
  58168. /**
  58169. * Open the database and make it available
  58170. * @param successCallback defines the callback to call on success
  58171. * @param errorCallback defines the callback to call on error
  58172. */
  58173. open(successCallback: () => void, errorCallback: () => void): void;
  58174. /**
  58175. * Loads an image from the database
  58176. * @param url defines the url to load from
  58177. * @param image defines the target DOM image
  58178. */
  58179. loadImage(url: string, image: HTMLImageElement): void;
  58180. private _loadImageFromDBAsync;
  58181. private _saveImageIntoDBAsync;
  58182. private _checkVersionFromDB;
  58183. private _loadVersionFromDBAsync;
  58184. private _saveVersionIntoDBAsync;
  58185. /**
  58186. * Loads a file from database
  58187. * @param url defines the URL to load from
  58188. * @param sceneLoaded defines a callback to call on success
  58189. * @param progressCallBack defines a callback to call when progress changed
  58190. * @param errorCallback defines a callback to call on error
  58191. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  58192. */
  58193. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  58194. private _loadFileAsync;
  58195. private _saveFileAsync;
  58196. /**
  58197. * Validates if xhr data is correct
  58198. * @param xhr defines the request to validate
  58199. * @param dataType defines the expected data type
  58200. * @returns true if data is correct
  58201. */
  58202. private static _ValidateXHRData;
  58203. }
  58204. }
  58205. declare module "babylonjs/Offline/index" {
  58206. export * from "babylonjs/Offline/database";
  58207. export * from "babylonjs/Offline/IOfflineProvider";
  58208. }
  58209. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  58210. /** @hidden */
  58211. export var gpuUpdateParticlesPixelShader: {
  58212. name: string;
  58213. shader: string;
  58214. };
  58215. }
  58216. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  58217. /** @hidden */
  58218. export var gpuUpdateParticlesVertexShader: {
  58219. name: string;
  58220. shader: string;
  58221. };
  58222. }
  58223. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  58224. /** @hidden */
  58225. export var clipPlaneFragmentDeclaration2: {
  58226. name: string;
  58227. shader: string;
  58228. };
  58229. }
  58230. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  58231. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  58232. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58233. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58234. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58235. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58236. /** @hidden */
  58237. export var gpuRenderParticlesPixelShader: {
  58238. name: string;
  58239. shader: string;
  58240. };
  58241. }
  58242. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  58243. /** @hidden */
  58244. export var clipPlaneVertexDeclaration2: {
  58245. name: string;
  58246. shader: string;
  58247. };
  58248. }
  58249. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  58250. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  58251. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58252. /** @hidden */
  58253. export var gpuRenderParticlesVertexShader: {
  58254. name: string;
  58255. shader: string;
  58256. };
  58257. }
  58258. declare module "babylonjs/Particles/gpuParticleSystem" {
  58259. import { Nullable } from "babylonjs/types";
  58260. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  58261. import { Observable } from "babylonjs/Misc/observable";
  58262. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  58263. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  58264. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  58265. import { Scene, IDisposable } from "babylonjs/scene";
  58266. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  58267. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58268. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  58269. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  58270. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  58271. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  58272. /**
  58273. * This represents a GPU particle system in Babylon
  58274. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  58275. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  58276. */
  58277. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  58278. /**
  58279. * The layer mask we are rendering the particles through.
  58280. */
  58281. layerMask: number;
  58282. private _capacity;
  58283. private _activeCount;
  58284. private _currentActiveCount;
  58285. private _accumulatedCount;
  58286. private _renderEffect;
  58287. private _updateEffect;
  58288. private _buffer0;
  58289. private _buffer1;
  58290. private _spriteBuffer;
  58291. private _updateVAO;
  58292. private _renderVAO;
  58293. private _targetIndex;
  58294. private _sourceBuffer;
  58295. private _targetBuffer;
  58296. private _engine;
  58297. private _currentRenderId;
  58298. private _started;
  58299. private _stopped;
  58300. private _timeDelta;
  58301. private _randomTexture;
  58302. private _randomTexture2;
  58303. private _attributesStrideSize;
  58304. private _updateEffectOptions;
  58305. private _randomTextureSize;
  58306. private _actualFrame;
  58307. private readonly _rawTextureWidth;
  58308. /**
  58309. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  58310. */
  58311. static readonly IsSupported: boolean;
  58312. /**
  58313. * An event triggered when the system is disposed.
  58314. */
  58315. onDisposeObservable: Observable<GPUParticleSystem>;
  58316. /**
  58317. * Gets the maximum number of particles active at the same time.
  58318. * @returns The max number of active particles.
  58319. */
  58320. getCapacity(): number;
  58321. /**
  58322. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  58323. * to override the particles.
  58324. */
  58325. forceDepthWrite: boolean;
  58326. /**
  58327. * Gets or set the number of active particles
  58328. */
  58329. activeParticleCount: number;
  58330. private _preWarmDone;
  58331. /**
  58332. * Is this system ready to be used/rendered
  58333. * @return true if the system is ready
  58334. */
  58335. isReady(): boolean;
  58336. /**
  58337. * Gets if the system has been started. (Note: this will still be true after stop is called)
  58338. * @returns True if it has been started, otherwise false.
  58339. */
  58340. isStarted(): boolean;
  58341. /**
  58342. * Starts the particle system and begins to emit
  58343. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  58344. */
  58345. start(delay?: number): void;
  58346. /**
  58347. * Stops the particle system.
  58348. */
  58349. stop(): void;
  58350. /**
  58351. * Remove all active particles
  58352. */
  58353. reset(): void;
  58354. /**
  58355. * Returns the string "GPUParticleSystem"
  58356. * @returns a string containing the class name
  58357. */
  58358. getClassName(): string;
  58359. private _colorGradientsTexture;
  58360. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  58361. /**
  58362. * Adds a new color gradient
  58363. * @param gradient defines the gradient to use (between 0 and 1)
  58364. * @param color1 defines the color to affect to the specified gradient
  58365. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  58366. * @returns the current particle system
  58367. */
  58368. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  58369. /**
  58370. * Remove a specific color gradient
  58371. * @param gradient defines the gradient to remove
  58372. * @returns the current particle system
  58373. */
  58374. removeColorGradient(gradient: number): GPUParticleSystem;
  58375. private _angularSpeedGradientsTexture;
  58376. private _sizeGradientsTexture;
  58377. private _velocityGradientsTexture;
  58378. private _limitVelocityGradientsTexture;
  58379. private _dragGradientsTexture;
  58380. private _addFactorGradient;
  58381. /**
  58382. * Adds a new size gradient
  58383. * @param gradient defines the gradient to use (between 0 and 1)
  58384. * @param factor defines the size factor to affect to the specified gradient
  58385. * @returns the current particle system
  58386. */
  58387. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  58388. /**
  58389. * Remove a specific size gradient
  58390. * @param gradient defines the gradient to remove
  58391. * @returns the current particle system
  58392. */
  58393. removeSizeGradient(gradient: number): GPUParticleSystem;
  58394. /**
  58395. * Adds a new angular speed gradient
  58396. * @param gradient defines the gradient to use (between 0 and 1)
  58397. * @param factor defines the angular speed to affect to the specified gradient
  58398. * @returns the current particle system
  58399. */
  58400. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  58401. /**
  58402. * Remove a specific angular speed gradient
  58403. * @param gradient defines the gradient to remove
  58404. * @returns the current particle system
  58405. */
  58406. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  58407. /**
  58408. * Adds a new velocity gradient
  58409. * @param gradient defines the gradient to use (between 0 and 1)
  58410. * @param factor defines the velocity to affect to the specified gradient
  58411. * @returns the current particle system
  58412. */
  58413. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  58414. /**
  58415. * Remove a specific velocity gradient
  58416. * @param gradient defines the gradient to remove
  58417. * @returns the current particle system
  58418. */
  58419. removeVelocityGradient(gradient: number): GPUParticleSystem;
  58420. /**
  58421. * Adds a new limit velocity gradient
  58422. * @param gradient defines the gradient to use (between 0 and 1)
  58423. * @param factor defines the limit velocity value to affect to the specified gradient
  58424. * @returns the current particle system
  58425. */
  58426. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  58427. /**
  58428. * Remove a specific limit velocity gradient
  58429. * @param gradient defines the gradient to remove
  58430. * @returns the current particle system
  58431. */
  58432. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  58433. /**
  58434. * Adds a new drag gradient
  58435. * @param gradient defines the gradient to use (between 0 and 1)
  58436. * @param factor defines the drag value to affect to the specified gradient
  58437. * @returns the current particle system
  58438. */
  58439. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  58440. /**
  58441. * Remove a specific drag gradient
  58442. * @param gradient defines the gradient to remove
  58443. * @returns the current particle system
  58444. */
  58445. removeDragGradient(gradient: number): GPUParticleSystem;
  58446. /**
  58447. * Not supported by GPUParticleSystem
  58448. * @param gradient defines the gradient to use (between 0 and 1)
  58449. * @param factor defines the emit rate value to affect to the specified gradient
  58450. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  58451. * @returns the current particle system
  58452. */
  58453. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  58454. /**
  58455. * Not supported by GPUParticleSystem
  58456. * @param gradient defines the gradient to remove
  58457. * @returns the current particle system
  58458. */
  58459. removeEmitRateGradient(gradient: number): IParticleSystem;
  58460. /**
  58461. * Not supported by GPUParticleSystem
  58462. * @param gradient defines the gradient to use (between 0 and 1)
  58463. * @param factor defines the start size value to affect to the specified gradient
  58464. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  58465. * @returns the current particle system
  58466. */
  58467. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  58468. /**
  58469. * Not supported by GPUParticleSystem
  58470. * @param gradient defines the gradient to remove
  58471. * @returns the current particle system
  58472. */
  58473. removeStartSizeGradient(gradient: number): IParticleSystem;
  58474. /**
  58475. * Not supported by GPUParticleSystem
  58476. * @param gradient defines the gradient to use (between 0 and 1)
  58477. * @param min defines the color remap minimal range
  58478. * @param max defines the color remap maximal range
  58479. * @returns the current particle system
  58480. */
  58481. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  58482. /**
  58483. * Not supported by GPUParticleSystem
  58484. * @param gradient defines the gradient to remove
  58485. * @returns the current particle system
  58486. */
  58487. removeColorRemapGradient(): IParticleSystem;
  58488. /**
  58489. * Not supported by GPUParticleSystem
  58490. * @param gradient defines the gradient to use (between 0 and 1)
  58491. * @param min defines the alpha remap minimal range
  58492. * @param max defines the alpha remap maximal range
  58493. * @returns the current particle system
  58494. */
  58495. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  58496. /**
  58497. * Not supported by GPUParticleSystem
  58498. * @param gradient defines the gradient to remove
  58499. * @returns the current particle system
  58500. */
  58501. removeAlphaRemapGradient(): IParticleSystem;
  58502. /**
  58503. * Not supported by GPUParticleSystem
  58504. * @param gradient defines the gradient to use (between 0 and 1)
  58505. * @param color defines the color to affect to the specified gradient
  58506. * @returns the current particle system
  58507. */
  58508. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  58509. /**
  58510. * Not supported by GPUParticleSystem
  58511. * @param gradient defines the gradient to remove
  58512. * @returns the current particle system
  58513. */
  58514. removeRampGradient(): IParticleSystem;
  58515. /**
  58516. * Not supported by GPUParticleSystem
  58517. * @returns the list of ramp gradients
  58518. */
  58519. getRampGradients(): Nullable<Array<Color3Gradient>>;
  58520. /**
  58521. * Not supported by GPUParticleSystem
  58522. * Gets or sets a boolean indicating that ramp gradients must be used
  58523. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  58524. */
  58525. useRampGradients: boolean;
  58526. /**
  58527. * Not supported by GPUParticleSystem
  58528. * @param gradient defines the gradient to use (between 0 and 1)
  58529. * @param factor defines the life time factor to affect to the specified gradient
  58530. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  58531. * @returns the current particle system
  58532. */
  58533. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  58534. /**
  58535. * Not supported by GPUParticleSystem
  58536. * @param gradient defines the gradient to remove
  58537. * @returns the current particle system
  58538. */
  58539. removeLifeTimeGradient(gradient: number): IParticleSystem;
  58540. /**
  58541. * Instantiates a GPU particle system.
  58542. * 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.
  58543. * @param name The name of the particle system
  58544. * @param options The options used to create the system
  58545. * @param scene The scene the particle system belongs to
  58546. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  58547. */
  58548. constructor(name: string, options: Partial<{
  58549. capacity: number;
  58550. randomTextureSize: number;
  58551. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  58552. protected _reset(): void;
  58553. private _createUpdateVAO;
  58554. private _createRenderVAO;
  58555. private _initialize;
  58556. /** @hidden */
  58557. _recreateUpdateEffect(): void;
  58558. /** @hidden */
  58559. _recreateRenderEffect(): void;
  58560. /**
  58561. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  58562. * @param preWarm defines if we are in the pre-warmimg phase
  58563. */
  58564. animate(preWarm?: boolean): void;
  58565. private _createFactorGradientTexture;
  58566. private _createSizeGradientTexture;
  58567. private _createAngularSpeedGradientTexture;
  58568. private _createVelocityGradientTexture;
  58569. private _createLimitVelocityGradientTexture;
  58570. private _createDragGradientTexture;
  58571. private _createColorGradientTexture;
  58572. /**
  58573. * Renders the particle system in its current state
  58574. * @param preWarm defines if the system should only update the particles but not render them
  58575. * @returns the current number of particles
  58576. */
  58577. render(preWarm?: boolean): number;
  58578. /**
  58579. * Rebuilds the particle system
  58580. */
  58581. rebuild(): void;
  58582. private _releaseBuffers;
  58583. private _releaseVAOs;
  58584. /**
  58585. * Disposes the particle system and free the associated resources
  58586. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  58587. */
  58588. dispose(disposeTexture?: boolean): void;
  58589. /**
  58590. * Clones the particle system.
  58591. * @param name The name of the cloned object
  58592. * @param newEmitter The new emitter to use
  58593. * @returns the cloned particle system
  58594. */
  58595. clone(name: string, newEmitter: any): GPUParticleSystem;
  58596. /**
  58597. * Serializes the particle system to a JSON object.
  58598. * @returns the JSON object
  58599. */
  58600. serialize(): any;
  58601. /**
  58602. * Parses a JSON object to create a GPU particle system.
  58603. * @param parsedParticleSystem The JSON object to parse
  58604. * @param scene The scene to create the particle system in
  58605. * @param rootUrl The root url to use to load external dependencies like texture
  58606. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  58607. * @returns the parsed GPU particle system
  58608. */
  58609. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  58610. }
  58611. }
  58612. declare module "babylonjs/Particles/particleSystemSet" {
  58613. import { Nullable } from "babylonjs/types";
  58614. import { Color3 } from "babylonjs/Maths/math.color";
  58615. import { TransformNode } from "babylonjs/Meshes/transformNode";
  58616. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  58618. import { Scene, IDisposable } from "babylonjs/scene";
  58619. /**
  58620. * Represents a set of particle systems working together to create a specific effect
  58621. */
  58622. export class ParticleSystemSet implements IDisposable {
  58623. private _emitterCreationOptions;
  58624. private _emitterNode;
  58625. /**
  58626. * Gets the particle system list
  58627. */
  58628. systems: IParticleSystem[];
  58629. /**
  58630. * Gets the emitter node used with this set
  58631. */
  58632. readonly emitterNode: Nullable<TransformNode>;
  58633. /**
  58634. * Creates a new emitter mesh as a sphere
  58635. * @param options defines the options used to create the sphere
  58636. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  58637. * @param scene defines the hosting scene
  58638. */
  58639. setEmitterAsSphere(options: {
  58640. diameter: number;
  58641. segments: number;
  58642. color: Color3;
  58643. }, renderingGroupId: number, scene: Scene): void;
  58644. /**
  58645. * Starts all particle systems of the set
  58646. * @param emitter defines an optional mesh to use as emitter for the particle systems
  58647. */
  58648. start(emitter?: AbstractMesh): void;
  58649. /**
  58650. * Release all associated resources
  58651. */
  58652. dispose(): void;
  58653. /**
  58654. * Serialize the set into a JSON compatible object
  58655. * @returns a JSON compatible representation of the set
  58656. */
  58657. serialize(): any;
  58658. /**
  58659. * Parse a new ParticleSystemSet from a serialized source
  58660. * @param data defines a JSON compatible representation of the set
  58661. * @param scene defines the hosting scene
  58662. * @param gpu defines if we want GPU particles or CPU particles
  58663. * @returns a new ParticleSystemSet
  58664. */
  58665. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  58666. }
  58667. }
  58668. declare module "babylonjs/Particles/particleHelper" {
  58669. import { Nullable } from "babylonjs/types";
  58670. import { Scene } from "babylonjs/scene";
  58671. import { Vector3 } from "babylonjs/Maths/math.vector";
  58672. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58673. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  58674. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  58675. /**
  58676. * This class is made for on one-liner static method to help creating particle system set.
  58677. */
  58678. export class ParticleHelper {
  58679. /**
  58680. * Gets or sets base Assets URL
  58681. */
  58682. static BaseAssetsUrl: string;
  58683. /**
  58684. * Create a default particle system that you can tweak
  58685. * @param emitter defines the emitter to use
  58686. * @param capacity defines the system capacity (default is 500 particles)
  58687. * @param scene defines the hosting scene
  58688. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  58689. * @returns the new Particle system
  58690. */
  58691. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  58692. /**
  58693. * This is the main static method (one-liner) of this helper to create different particle systems
  58694. * @param type This string represents the type to the particle system to create
  58695. * @param scene The scene where the particle system should live
  58696. * @param gpu If the system will use gpu
  58697. * @returns the ParticleSystemSet created
  58698. */
  58699. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  58700. /**
  58701. * Static function used to export a particle system to a ParticleSystemSet variable.
  58702. * Please note that the emitter shape is not exported
  58703. * @param systems defines the particle systems to export
  58704. * @returns the created particle system set
  58705. */
  58706. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  58707. }
  58708. }
  58709. declare module "babylonjs/Particles/particleSystemComponent" {
  58710. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  58711. import { Effect, EffectFallbacks } from "babylonjs/Materials/effect";
  58712. import "babylonjs/Shaders/particles.vertex";
  58713. module "babylonjs/Engines/engine" {
  58714. interface Engine {
  58715. /**
  58716. * Create an effect to use with particle systems.
  58717. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  58718. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  58719. * @param uniformsNames defines a list of attribute names
  58720. * @param samplers defines an array of string used to represent textures
  58721. * @param defines defines the string containing the defines to use to compile the shaders
  58722. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  58723. * @param onCompiled defines a function to call when the effect creation is successful
  58724. * @param onError defines a function to call when the effect creation has failed
  58725. * @returns the new Effect
  58726. */
  58727. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  58728. }
  58729. }
  58730. module "babylonjs/Meshes/mesh" {
  58731. interface Mesh {
  58732. /**
  58733. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  58734. * @returns an array of IParticleSystem
  58735. */
  58736. getEmittedParticleSystems(): IParticleSystem[];
  58737. /**
  58738. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  58739. * @returns an array of IParticleSystem
  58740. */
  58741. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  58742. }
  58743. }
  58744. /**
  58745. * @hidden
  58746. */
  58747. export var _IDoNeedToBeInTheBuild: number;
  58748. }
  58749. declare module "babylonjs/Particles/index" {
  58750. export * from "babylonjs/Particles/baseParticleSystem";
  58751. export * from "babylonjs/Particles/EmitterTypes/index";
  58752. export * from "babylonjs/Particles/gpuParticleSystem";
  58753. export * from "babylonjs/Particles/IParticleSystem";
  58754. export * from "babylonjs/Particles/particle";
  58755. export * from "babylonjs/Particles/particleHelper";
  58756. export * from "babylonjs/Particles/particleSystem";
  58757. export * from "babylonjs/Particles/particleSystemComponent";
  58758. export * from "babylonjs/Particles/particleSystemSet";
  58759. export * from "babylonjs/Particles/solidParticle";
  58760. export * from "babylonjs/Particles/solidParticleSystem";
  58761. export * from "babylonjs/Particles/subEmitter";
  58762. }
  58763. declare module "babylonjs/Physics/physicsEngineComponent" {
  58764. import { Nullable } from "babylonjs/types";
  58765. import { Observable, Observer } from "babylonjs/Misc/observable";
  58766. import { Vector3 } from "babylonjs/Maths/math.vector";
  58767. import { Mesh } from "babylonjs/Meshes/mesh";
  58768. import { ISceneComponent } from "babylonjs/sceneComponent";
  58769. import { Scene } from "babylonjs/scene";
  58770. import { Node } from "babylonjs/node";
  58771. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  58772. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  58773. module "babylonjs/scene" {
  58774. interface Scene {
  58775. /** @hidden (Backing field) */
  58776. _physicsEngine: Nullable<IPhysicsEngine>;
  58777. /**
  58778. * Gets the current physics engine
  58779. * @returns a IPhysicsEngine or null if none attached
  58780. */
  58781. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  58782. /**
  58783. * Enables physics to the current scene
  58784. * @param gravity defines the scene's gravity for the physics engine
  58785. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  58786. * @return a boolean indicating if the physics engine was initialized
  58787. */
  58788. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  58789. /**
  58790. * Disables and disposes the physics engine associated with the scene
  58791. */
  58792. disablePhysicsEngine(): void;
  58793. /**
  58794. * Gets a boolean indicating if there is an active physics engine
  58795. * @returns a boolean indicating if there is an active physics engine
  58796. */
  58797. isPhysicsEnabled(): boolean;
  58798. /**
  58799. * Deletes a physics compound impostor
  58800. * @param compound defines the compound to delete
  58801. */
  58802. deleteCompoundImpostor(compound: any): void;
  58803. /**
  58804. * An event triggered when physic simulation is about to be run
  58805. */
  58806. onBeforePhysicsObservable: Observable<Scene>;
  58807. /**
  58808. * An event triggered when physic simulation has been done
  58809. */
  58810. onAfterPhysicsObservable: Observable<Scene>;
  58811. }
  58812. }
  58813. module "babylonjs/Meshes/abstractMesh" {
  58814. interface AbstractMesh {
  58815. /** @hidden */
  58816. _physicsImpostor: Nullable<PhysicsImpostor>;
  58817. /**
  58818. * Gets or sets impostor used for physic simulation
  58819. * @see http://doc.babylonjs.com/features/physics_engine
  58820. */
  58821. physicsImpostor: Nullable<PhysicsImpostor>;
  58822. /**
  58823. * Gets the current physics impostor
  58824. * @see http://doc.babylonjs.com/features/physics_engine
  58825. * @returns a physics impostor or null
  58826. */
  58827. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  58828. /** Apply a physic impulse to the mesh
  58829. * @param force defines the force to apply
  58830. * @param contactPoint defines where to apply the force
  58831. * @returns the current mesh
  58832. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  58833. */
  58834. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  58835. /**
  58836. * Creates a physic joint between two meshes
  58837. * @param otherMesh defines the other mesh to use
  58838. * @param pivot1 defines the pivot to use on this mesh
  58839. * @param pivot2 defines the pivot to use on the other mesh
  58840. * @param options defines additional options (can be plugin dependent)
  58841. * @returns the current mesh
  58842. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  58843. */
  58844. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  58845. /** @hidden */
  58846. _disposePhysicsObserver: Nullable<Observer<Node>>;
  58847. }
  58848. }
  58849. /**
  58850. * Defines the physics engine scene component responsible to manage a physics engine
  58851. */
  58852. export class PhysicsEngineSceneComponent implements ISceneComponent {
  58853. /**
  58854. * The component name helpful to identify the component in the list of scene components.
  58855. */
  58856. readonly name: string;
  58857. /**
  58858. * The scene the component belongs to.
  58859. */
  58860. scene: Scene;
  58861. /**
  58862. * Creates a new instance of the component for the given scene
  58863. * @param scene Defines the scene to register the component in
  58864. */
  58865. constructor(scene: Scene);
  58866. /**
  58867. * Registers the component in a given scene
  58868. */
  58869. register(): void;
  58870. /**
  58871. * Rebuilds the elements related to this component in case of
  58872. * context lost for instance.
  58873. */
  58874. rebuild(): void;
  58875. /**
  58876. * Disposes the component and the associated ressources
  58877. */
  58878. dispose(): void;
  58879. }
  58880. }
  58881. declare module "babylonjs/Physics/physicsHelper" {
  58882. import { Nullable } from "babylonjs/types";
  58883. import { Vector3 } from "babylonjs/Maths/math.vector";
  58884. import { Mesh } from "babylonjs/Meshes/mesh";
  58885. import { Scene } from "babylonjs/scene";
  58886. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  58887. /**
  58888. * A helper for physics simulations
  58889. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  58890. */
  58891. export class PhysicsHelper {
  58892. private _scene;
  58893. private _physicsEngine;
  58894. /**
  58895. * Initializes the Physics helper
  58896. * @param scene Babylon.js scene
  58897. */
  58898. constructor(scene: Scene);
  58899. /**
  58900. * Applies a radial explosion impulse
  58901. * @param origin the origin of the explosion
  58902. * @param radiusOrEventOptions the radius or the options of radial explosion
  58903. * @param strength the explosion strength
  58904. * @param falloff possible options: Constant & Linear. Defaults to Constant
  58905. * @returns A physics radial explosion event, or null
  58906. */
  58907. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  58908. /**
  58909. * Applies a radial explosion force
  58910. * @param origin the origin of the explosion
  58911. * @param radiusOrEventOptions the radius or the options of radial explosion
  58912. * @param strength the explosion strength
  58913. * @param falloff possible options: Constant & Linear. Defaults to Constant
  58914. * @returns A physics radial explosion event, or null
  58915. */
  58916. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  58917. /**
  58918. * Creates a gravitational field
  58919. * @param origin the origin of the explosion
  58920. * @param radiusOrEventOptions the radius or the options of radial explosion
  58921. * @param strength the explosion strength
  58922. * @param falloff possible options: Constant & Linear. Defaults to Constant
  58923. * @returns A physics gravitational field event, or null
  58924. */
  58925. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  58926. /**
  58927. * Creates a physics updraft event
  58928. * @param origin the origin of the updraft
  58929. * @param radiusOrEventOptions the radius or the options of the updraft
  58930. * @param strength the strength of the updraft
  58931. * @param height the height of the updraft
  58932. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  58933. * @returns A physics updraft event, or null
  58934. */
  58935. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  58936. /**
  58937. * Creates a physics vortex event
  58938. * @param origin the of the vortex
  58939. * @param radiusOrEventOptions the radius or the options of the vortex
  58940. * @param strength the strength of the vortex
  58941. * @param height the height of the vortex
  58942. * @returns a Physics vortex event, or null
  58943. * A physics vortex event or null
  58944. */
  58945. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  58946. }
  58947. /**
  58948. * Represents a physics radial explosion event
  58949. */
  58950. class PhysicsRadialExplosionEvent {
  58951. private _scene;
  58952. private _options;
  58953. private _sphere;
  58954. private _dataFetched;
  58955. /**
  58956. * Initializes a radial explosioin event
  58957. * @param _scene BabylonJS scene
  58958. * @param _options The options for the vortex event
  58959. */
  58960. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  58961. /**
  58962. * Returns the data related to the radial explosion event (sphere).
  58963. * @returns The radial explosion event data
  58964. */
  58965. getData(): PhysicsRadialExplosionEventData;
  58966. /**
  58967. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  58968. * @param impostor A physics imposter
  58969. * @param origin the origin of the explosion
  58970. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  58971. */
  58972. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  58973. /**
  58974. * Triggers affecterd impostors callbacks
  58975. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  58976. */
  58977. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  58978. /**
  58979. * Disposes the sphere.
  58980. * @param force Specifies if the sphere should be disposed by force
  58981. */
  58982. dispose(force?: boolean): void;
  58983. /*** Helpers ***/
  58984. private _prepareSphere;
  58985. private _intersectsWithSphere;
  58986. }
  58987. /**
  58988. * Represents a gravitational field event
  58989. */
  58990. class PhysicsGravitationalFieldEvent {
  58991. private _physicsHelper;
  58992. private _scene;
  58993. private _origin;
  58994. private _options;
  58995. private _tickCallback;
  58996. private _sphere;
  58997. private _dataFetched;
  58998. /**
  58999. * Initializes the physics gravitational field event
  59000. * @param _physicsHelper A physics helper
  59001. * @param _scene BabylonJS scene
  59002. * @param _origin The origin position of the gravitational field event
  59003. * @param _options The options for the vortex event
  59004. */
  59005. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  59006. /**
  59007. * Returns the data related to the gravitational field event (sphere).
  59008. * @returns A gravitational field event
  59009. */
  59010. getData(): PhysicsGravitationalFieldEventData;
  59011. /**
  59012. * Enables the gravitational field.
  59013. */
  59014. enable(): void;
  59015. /**
  59016. * Disables the gravitational field.
  59017. */
  59018. disable(): void;
  59019. /**
  59020. * Disposes the sphere.
  59021. * @param force The force to dispose from the gravitational field event
  59022. */
  59023. dispose(force?: boolean): void;
  59024. private _tick;
  59025. }
  59026. /**
  59027. * Represents a physics updraft event
  59028. */
  59029. class PhysicsUpdraftEvent {
  59030. private _scene;
  59031. private _origin;
  59032. private _options;
  59033. private _physicsEngine;
  59034. private _originTop;
  59035. private _originDirection;
  59036. private _tickCallback;
  59037. private _cylinder;
  59038. private _cylinderPosition;
  59039. private _dataFetched;
  59040. /**
  59041. * Initializes the physics updraft event
  59042. * @param _scene BabylonJS scene
  59043. * @param _origin The origin position of the updraft
  59044. * @param _options The options for the updraft event
  59045. */
  59046. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  59047. /**
  59048. * Returns the data related to the updraft event (cylinder).
  59049. * @returns A physics updraft event
  59050. */
  59051. getData(): PhysicsUpdraftEventData;
  59052. /**
  59053. * Enables the updraft.
  59054. */
  59055. enable(): void;
  59056. /**
  59057. * Disables the updraft.
  59058. */
  59059. disable(): void;
  59060. /**
  59061. * Disposes the cylinder.
  59062. * @param force Specifies if the updraft should be disposed by force
  59063. */
  59064. dispose(force?: boolean): void;
  59065. private getImpostorHitData;
  59066. private _tick;
  59067. /*** Helpers ***/
  59068. private _prepareCylinder;
  59069. private _intersectsWithCylinder;
  59070. }
  59071. /**
  59072. * Represents a physics vortex event
  59073. */
  59074. class PhysicsVortexEvent {
  59075. private _scene;
  59076. private _origin;
  59077. private _options;
  59078. private _physicsEngine;
  59079. private _originTop;
  59080. private _tickCallback;
  59081. private _cylinder;
  59082. private _cylinderPosition;
  59083. private _dataFetched;
  59084. /**
  59085. * Initializes the physics vortex event
  59086. * @param _scene The BabylonJS scene
  59087. * @param _origin The origin position of the vortex
  59088. * @param _options The options for the vortex event
  59089. */
  59090. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  59091. /**
  59092. * Returns the data related to the vortex event (cylinder).
  59093. * @returns The physics vortex event data
  59094. */
  59095. getData(): PhysicsVortexEventData;
  59096. /**
  59097. * Enables the vortex.
  59098. */
  59099. enable(): void;
  59100. /**
  59101. * Disables the cortex.
  59102. */
  59103. disable(): void;
  59104. /**
  59105. * Disposes the sphere.
  59106. * @param force
  59107. */
  59108. dispose(force?: boolean): void;
  59109. private getImpostorHitData;
  59110. private _tick;
  59111. /*** Helpers ***/
  59112. private _prepareCylinder;
  59113. private _intersectsWithCylinder;
  59114. }
  59115. /**
  59116. * Options fot the radial explosion event
  59117. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59118. */
  59119. export class PhysicsRadialExplosionEventOptions {
  59120. /**
  59121. * The radius of the sphere for the radial explosion.
  59122. */
  59123. radius: number;
  59124. /**
  59125. * The strenth of the explosion.
  59126. */
  59127. strength: number;
  59128. /**
  59129. * The strenght of the force in correspondence to the distance of the affected object
  59130. */
  59131. falloff: PhysicsRadialImpulseFalloff;
  59132. /**
  59133. * Sphere options for the radial explosion.
  59134. */
  59135. sphere: {
  59136. segments: number;
  59137. diameter: number;
  59138. };
  59139. /**
  59140. * Sphere options for the radial explosion.
  59141. */
  59142. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  59143. }
  59144. /**
  59145. * Options fot the updraft event
  59146. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59147. */
  59148. export class PhysicsUpdraftEventOptions {
  59149. /**
  59150. * The radius of the cylinder for the vortex
  59151. */
  59152. radius: number;
  59153. /**
  59154. * The strenth of the updraft.
  59155. */
  59156. strength: number;
  59157. /**
  59158. * The height of the cylinder for the updraft.
  59159. */
  59160. height: number;
  59161. /**
  59162. * The mode for the the updraft.
  59163. */
  59164. updraftMode: PhysicsUpdraftMode;
  59165. }
  59166. /**
  59167. * Options fot the vortex event
  59168. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59169. */
  59170. export class PhysicsVortexEventOptions {
  59171. /**
  59172. * The radius of the cylinder for the vortex
  59173. */
  59174. radius: number;
  59175. /**
  59176. * The strenth of the vortex.
  59177. */
  59178. strength: number;
  59179. /**
  59180. * The height of the cylinder for the vortex.
  59181. */
  59182. height: number;
  59183. /**
  59184. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  59185. */
  59186. centripetalForceThreshold: number;
  59187. /**
  59188. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  59189. */
  59190. centripetalForceMultiplier: number;
  59191. /**
  59192. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  59193. */
  59194. centrifugalForceMultiplier: number;
  59195. /**
  59196. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  59197. */
  59198. updraftForceMultiplier: number;
  59199. }
  59200. /**
  59201. * The strenght of the force in correspondence to the distance of the affected object
  59202. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59203. */
  59204. export enum PhysicsRadialImpulseFalloff {
  59205. /** Defines that impulse is constant in strength across it's whole radius */
  59206. Constant = 0,
  59207. /** Defines that impulse gets weaker if it's further from the origin */
  59208. Linear = 1
  59209. }
  59210. /**
  59211. * The strength of the force in correspondence to the distance of the affected object
  59212. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59213. */
  59214. export enum PhysicsUpdraftMode {
  59215. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  59216. Center = 0,
  59217. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  59218. Perpendicular = 1
  59219. }
  59220. /**
  59221. * Interface for a physics hit data
  59222. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59223. */
  59224. export interface PhysicsHitData {
  59225. /**
  59226. * The force applied at the contact point
  59227. */
  59228. force: Vector3;
  59229. /**
  59230. * The contact point
  59231. */
  59232. contactPoint: Vector3;
  59233. /**
  59234. * The distance from the origin to the contact point
  59235. */
  59236. distanceFromOrigin: number;
  59237. }
  59238. /**
  59239. * Interface for radial explosion event data
  59240. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59241. */
  59242. export interface PhysicsRadialExplosionEventData {
  59243. /**
  59244. * A sphere used for the radial explosion event
  59245. */
  59246. sphere: Mesh;
  59247. }
  59248. /**
  59249. * Interface for gravitational field event data
  59250. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59251. */
  59252. export interface PhysicsGravitationalFieldEventData {
  59253. /**
  59254. * A sphere mesh used for the gravitational field event
  59255. */
  59256. sphere: Mesh;
  59257. }
  59258. /**
  59259. * Interface for updraft event data
  59260. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59261. */
  59262. export interface PhysicsUpdraftEventData {
  59263. /**
  59264. * A cylinder used for the updraft event
  59265. */
  59266. cylinder: Mesh;
  59267. }
  59268. /**
  59269. * Interface for vortex event data
  59270. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59271. */
  59272. export interface PhysicsVortexEventData {
  59273. /**
  59274. * A cylinder used for the vortex event
  59275. */
  59276. cylinder: Mesh;
  59277. }
  59278. /**
  59279. * Interface for an affected physics impostor
  59280. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  59281. */
  59282. export interface PhysicsAffectedImpostorWithData {
  59283. /**
  59284. * The impostor affected by the effect
  59285. */
  59286. impostor: PhysicsImpostor;
  59287. /**
  59288. * The data about the hit/horce from the explosion
  59289. */
  59290. hitData: PhysicsHitData;
  59291. }
  59292. }
  59293. declare module "babylonjs/Physics/Plugins/index" {
  59294. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  59295. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  59296. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  59297. }
  59298. declare module "babylonjs/Physics/index" {
  59299. export * from "babylonjs/Physics/IPhysicsEngine";
  59300. export * from "babylonjs/Physics/physicsEngine";
  59301. export * from "babylonjs/Physics/physicsEngineComponent";
  59302. export * from "babylonjs/Physics/physicsHelper";
  59303. export * from "babylonjs/Physics/physicsImpostor";
  59304. export * from "babylonjs/Physics/physicsJoint";
  59305. export * from "babylonjs/Physics/Plugins/index";
  59306. }
  59307. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  59308. /** @hidden */
  59309. export var blackAndWhitePixelShader: {
  59310. name: string;
  59311. shader: string;
  59312. };
  59313. }
  59314. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  59315. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59316. import { Camera } from "babylonjs/Cameras/camera";
  59317. import { Engine } from "babylonjs/Engines/engine";
  59318. import "babylonjs/Shaders/blackAndWhite.fragment";
  59319. /**
  59320. * Post process used to render in black and white
  59321. */
  59322. export class BlackAndWhitePostProcess extends PostProcess {
  59323. /**
  59324. * Linear about to convert he result to black and white (default: 1)
  59325. */
  59326. degree: number;
  59327. /**
  59328. * Creates a black and white post process
  59329. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  59330. * @param name The name of the effect.
  59331. * @param options The required width/height ratio to downsize to before computing the render pass.
  59332. * @param camera The camera to apply the render pass to.
  59333. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59334. * @param engine The engine which the post process will be applied. (default: current engine)
  59335. * @param reusable If the post process can be reused on the same frame. (default: false)
  59336. */
  59337. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  59338. }
  59339. }
  59340. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  59341. import { Nullable } from "babylonjs/types";
  59342. import { Camera } from "babylonjs/Cameras/camera";
  59343. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  59344. import { Engine } from "babylonjs/Engines/engine";
  59345. /**
  59346. * This represents a set of one or more post processes in Babylon.
  59347. * A post process can be used to apply a shader to a texture after it is rendered.
  59348. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  59349. */
  59350. export class PostProcessRenderEffect {
  59351. private _postProcesses;
  59352. private _getPostProcesses;
  59353. private _singleInstance;
  59354. private _cameras;
  59355. private _indicesForCamera;
  59356. /**
  59357. * Name of the effect
  59358. * @hidden
  59359. */
  59360. _name: string;
  59361. /**
  59362. * Instantiates a post process render effect.
  59363. * A post process can be used to apply a shader to a texture after it is rendered.
  59364. * @param engine The engine the effect is tied to
  59365. * @param name The name of the effect
  59366. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  59367. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  59368. */
  59369. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  59370. /**
  59371. * Checks if all the post processes in the effect are supported.
  59372. */
  59373. readonly isSupported: boolean;
  59374. /**
  59375. * Updates the current state of the effect
  59376. * @hidden
  59377. */
  59378. _update(): void;
  59379. /**
  59380. * Attaches the effect on cameras
  59381. * @param cameras The camera to attach to.
  59382. * @hidden
  59383. */
  59384. _attachCameras(cameras: Camera): void;
  59385. /**
  59386. * Attaches the effect on cameras
  59387. * @param cameras The camera to attach to.
  59388. * @hidden
  59389. */
  59390. _attachCameras(cameras: Camera[]): void;
  59391. /**
  59392. * Detaches the effect on cameras
  59393. * @param cameras The camera to detatch from.
  59394. * @hidden
  59395. */
  59396. _detachCameras(cameras: Camera): void;
  59397. /**
  59398. * Detatches the effect on cameras
  59399. * @param cameras The camera to detatch from.
  59400. * @hidden
  59401. */
  59402. _detachCameras(cameras: Camera[]): void;
  59403. /**
  59404. * Enables the effect on given cameras
  59405. * @param cameras The camera to enable.
  59406. * @hidden
  59407. */
  59408. _enable(cameras: Camera): void;
  59409. /**
  59410. * Enables the effect on given cameras
  59411. * @param cameras The camera to enable.
  59412. * @hidden
  59413. */
  59414. _enable(cameras: Nullable<Camera[]>): void;
  59415. /**
  59416. * Disables the effect on the given cameras
  59417. * @param cameras The camera to disable.
  59418. * @hidden
  59419. */
  59420. _disable(cameras: Camera): void;
  59421. /**
  59422. * Disables the effect on the given cameras
  59423. * @param cameras The camera to disable.
  59424. * @hidden
  59425. */
  59426. _disable(cameras: Nullable<Camera[]>): void;
  59427. /**
  59428. * Gets a list of the post processes contained in the effect.
  59429. * @param camera The camera to get the post processes on.
  59430. * @returns The list of the post processes in the effect.
  59431. */
  59432. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  59433. }
  59434. }
  59435. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  59436. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  59437. /** @hidden */
  59438. export var extractHighlightsPixelShader: {
  59439. name: string;
  59440. shader: string;
  59441. };
  59442. }
  59443. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  59444. import { Nullable } from "babylonjs/types";
  59445. import { Camera } from "babylonjs/Cameras/camera";
  59446. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59447. import { Engine } from "babylonjs/Engines/engine";
  59448. import "babylonjs/Shaders/extractHighlights.fragment";
  59449. /**
  59450. * 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.
  59451. */
  59452. export class ExtractHighlightsPostProcess extends PostProcess {
  59453. /**
  59454. * The luminance threshold, pixels below this value will be set to black.
  59455. */
  59456. threshold: number;
  59457. /** @hidden */
  59458. _exposure: number;
  59459. /**
  59460. * Post process which has the input texture to be used when performing highlight extraction
  59461. * @hidden
  59462. */
  59463. _inputPostProcess: Nullable<PostProcess>;
  59464. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  59465. }
  59466. }
  59467. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  59468. /** @hidden */
  59469. export var bloomMergePixelShader: {
  59470. name: string;
  59471. shader: string;
  59472. };
  59473. }
  59474. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  59475. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59476. import { Nullable } from "babylonjs/types";
  59477. import { Engine } from "babylonjs/Engines/engine";
  59478. import { Camera } from "babylonjs/Cameras/camera";
  59479. import "babylonjs/Shaders/bloomMerge.fragment";
  59480. /**
  59481. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  59482. */
  59483. export class BloomMergePostProcess extends PostProcess {
  59484. /** Weight of the bloom to be added to the original input. */
  59485. weight: number;
  59486. /**
  59487. * Creates a new instance of @see BloomMergePostProcess
  59488. * @param name The name of the effect.
  59489. * @param originalFromInput Post process which's input will be used for the merge.
  59490. * @param blurred Blurred highlights post process which's output will be used.
  59491. * @param weight Weight of the bloom to be added to the original input.
  59492. * @param options The required width/height ratio to downsize to before computing the render pass.
  59493. * @param camera The camera to apply the render pass to.
  59494. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59495. * @param engine The engine which the post process will be applied. (default: current engine)
  59496. * @param reusable If the post process can be reused on the same frame. (default: false)
  59497. * @param textureType Type of textures used when performing the post process. (default: 0)
  59498. * @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)
  59499. */
  59500. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  59501. /** Weight of the bloom to be added to the original input. */
  59502. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  59503. }
  59504. }
  59505. declare module "babylonjs/PostProcesses/bloomEffect" {
  59506. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  59507. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  59508. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  59509. import { Camera } from "babylonjs/Cameras/camera";
  59510. import { Scene } from "babylonjs/scene";
  59511. /**
  59512. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  59513. */
  59514. export class BloomEffect extends PostProcessRenderEffect {
  59515. private bloomScale;
  59516. /**
  59517. * @hidden Internal
  59518. */
  59519. _effects: Array<PostProcess>;
  59520. /**
  59521. * @hidden Internal
  59522. */
  59523. _downscale: ExtractHighlightsPostProcess;
  59524. private _blurX;
  59525. private _blurY;
  59526. private _merge;
  59527. /**
  59528. * The luminance threshold to find bright areas of the image to bloom.
  59529. */
  59530. threshold: number;
  59531. /**
  59532. * The strength of the bloom.
  59533. */
  59534. weight: number;
  59535. /**
  59536. * Specifies the size of the bloom blur kernel, relative to the final output size
  59537. */
  59538. kernel: number;
  59539. /**
  59540. * Creates a new instance of @see BloomEffect
  59541. * @param scene The scene the effect belongs to.
  59542. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  59543. * @param bloomKernel The size of the kernel to be used when applying the blur.
  59544. * @param bloomWeight The the strength of bloom.
  59545. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  59546. * @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)
  59547. */
  59548. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  59549. /**
  59550. * Disposes each of the internal effects for a given camera.
  59551. * @param camera The camera to dispose the effect on.
  59552. */
  59553. disposeEffects(camera: Camera): void;
  59554. /**
  59555. * @hidden Internal
  59556. */
  59557. _updateEffects(): void;
  59558. /**
  59559. * Internal
  59560. * @returns if all the contained post processes are ready.
  59561. * @hidden
  59562. */
  59563. _isReady(): boolean;
  59564. }
  59565. }
  59566. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  59567. /** @hidden */
  59568. export var chromaticAberrationPixelShader: {
  59569. name: string;
  59570. shader: string;
  59571. };
  59572. }
  59573. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  59574. import { Vector2 } from "babylonjs/Maths/math.vector";
  59575. import { Nullable } from "babylonjs/types";
  59576. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59577. import { Camera } from "babylonjs/Cameras/camera";
  59578. import { Engine } from "babylonjs/Engines/engine";
  59579. import "babylonjs/Shaders/chromaticAberration.fragment";
  59580. /**
  59581. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  59582. */
  59583. export class ChromaticAberrationPostProcess extends PostProcess {
  59584. /**
  59585. * The amount of seperation of rgb channels (default: 30)
  59586. */
  59587. aberrationAmount: number;
  59588. /**
  59589. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  59590. */
  59591. radialIntensity: number;
  59592. /**
  59593. * 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))
  59594. */
  59595. direction: Vector2;
  59596. /**
  59597. * 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))
  59598. */
  59599. centerPosition: Vector2;
  59600. /**
  59601. * Creates a new instance ChromaticAberrationPostProcess
  59602. * @param name The name of the effect.
  59603. * @param screenWidth The width of the screen to apply the effect on.
  59604. * @param screenHeight The height of the screen to apply the effect on.
  59605. * @param options The required width/height ratio to downsize to before computing the render pass.
  59606. * @param camera The camera to apply the render pass to.
  59607. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59608. * @param engine The engine which the post process will be applied. (default: current engine)
  59609. * @param reusable If the post process can be reused on the same frame. (default: false)
  59610. * @param textureType Type of textures used when performing the post process. (default: 0)
  59611. * @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)
  59612. */
  59613. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  59614. }
  59615. }
  59616. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  59617. /** @hidden */
  59618. export var circleOfConfusionPixelShader: {
  59619. name: string;
  59620. shader: string;
  59621. };
  59622. }
  59623. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  59624. import { Nullable } from "babylonjs/types";
  59625. import { Engine } from "babylonjs/Engines/engine";
  59626. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59627. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  59628. import { Camera } from "babylonjs/Cameras/camera";
  59629. import "babylonjs/Shaders/circleOfConfusion.fragment";
  59630. /**
  59631. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  59632. */
  59633. export class CircleOfConfusionPostProcess extends PostProcess {
  59634. /**
  59635. * 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.
  59636. */
  59637. lensSize: number;
  59638. /**
  59639. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  59640. */
  59641. fStop: number;
  59642. /**
  59643. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  59644. */
  59645. focusDistance: number;
  59646. /**
  59647. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  59648. */
  59649. focalLength: number;
  59650. private _depthTexture;
  59651. /**
  59652. * Creates a new instance CircleOfConfusionPostProcess
  59653. * @param name The name of the effect.
  59654. * @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.
  59655. * @param options The required width/height ratio to downsize to before computing the render pass.
  59656. * @param camera The camera to apply the render pass to.
  59657. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59658. * @param engine The engine which the post process will be applied. (default: current engine)
  59659. * @param reusable If the post process can be reused on the same frame. (default: false)
  59660. * @param textureType Type of textures used when performing the post process. (default: 0)
  59661. * @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)
  59662. */
  59663. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  59664. /**
  59665. * 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.
  59666. */
  59667. depthTexture: RenderTargetTexture;
  59668. }
  59669. }
  59670. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  59671. /** @hidden */
  59672. export var colorCorrectionPixelShader: {
  59673. name: string;
  59674. shader: string;
  59675. };
  59676. }
  59677. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  59678. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59679. import { Engine } from "babylonjs/Engines/engine";
  59680. import { Camera } from "babylonjs/Cameras/camera";
  59681. import "babylonjs/Shaders/colorCorrection.fragment";
  59682. /**
  59683. *
  59684. * This post-process allows the modification of rendered colors by using
  59685. * a 'look-up table' (LUT). This effect is also called Color Grading.
  59686. *
  59687. * The object needs to be provided an url to a texture containing the color
  59688. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  59689. * Use an image editing software to tweak the LUT to match your needs.
  59690. *
  59691. * For an example of a color LUT, see here:
  59692. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  59693. * For explanations on color grading, see here:
  59694. * @see http://udn.epicgames.com/Three/ColorGrading.html
  59695. *
  59696. */
  59697. export class ColorCorrectionPostProcess extends PostProcess {
  59698. private _colorTableTexture;
  59699. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  59700. }
  59701. }
  59702. declare module "babylonjs/Shaders/convolution.fragment" {
  59703. /** @hidden */
  59704. export var convolutionPixelShader: {
  59705. name: string;
  59706. shader: string;
  59707. };
  59708. }
  59709. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  59710. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59711. import { Nullable } from "babylonjs/types";
  59712. import { Camera } from "babylonjs/Cameras/camera";
  59713. import { Engine } from "babylonjs/Engines/engine";
  59714. import "babylonjs/Shaders/convolution.fragment";
  59715. /**
  59716. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  59717. * input texture to perform effects such as edge detection or sharpening
  59718. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  59719. */
  59720. export class ConvolutionPostProcess extends PostProcess {
  59721. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  59722. kernel: number[];
  59723. /**
  59724. * Creates a new instance ConvolutionPostProcess
  59725. * @param name The name of the effect.
  59726. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  59727. * @param options The required width/height ratio to downsize to before computing the render pass.
  59728. * @param camera The camera to apply the render pass to.
  59729. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59730. * @param engine The engine which the post process will be applied. (default: current engine)
  59731. * @param reusable If the post process can be reused on the same frame. (default: false)
  59732. * @param textureType Type of textures used when performing the post process. (default: 0)
  59733. */
  59734. constructor(name: string,
  59735. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  59736. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  59737. /**
  59738. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  59739. */
  59740. static EdgeDetect0Kernel: number[];
  59741. /**
  59742. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  59743. */
  59744. static EdgeDetect1Kernel: number[];
  59745. /**
  59746. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  59747. */
  59748. static EdgeDetect2Kernel: number[];
  59749. /**
  59750. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  59751. */
  59752. static SharpenKernel: number[];
  59753. /**
  59754. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  59755. */
  59756. static EmbossKernel: number[];
  59757. /**
  59758. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  59759. */
  59760. static GaussianKernel: number[];
  59761. }
  59762. }
  59763. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  59764. import { Nullable } from "babylonjs/types";
  59765. import { Vector2 } from "babylonjs/Maths/math.vector";
  59766. import { Camera } from "babylonjs/Cameras/camera";
  59767. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59768. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  59769. import { Engine } from "babylonjs/Engines/engine";
  59770. import { Scene } from "babylonjs/scene";
  59771. /**
  59772. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  59773. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  59774. * based on samples that have a large difference in distance than the center pixel.
  59775. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  59776. */
  59777. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  59778. direction: Vector2;
  59779. /**
  59780. * Creates a new instance CircleOfConfusionPostProcess
  59781. * @param name The name of the effect.
  59782. * @param scene The scene the effect belongs to.
  59783. * @param direction The direction the blur should be applied.
  59784. * @param kernel The size of the kernel used to blur.
  59785. * @param options The required width/height ratio to downsize to before computing the render pass.
  59786. * @param camera The camera to apply the render pass to.
  59787. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  59788. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  59789. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59790. * @param engine The engine which the post process will be applied. (default: current engine)
  59791. * @param reusable If the post process can be reused on the same frame. (default: false)
  59792. * @param textureType Type of textures used when performing the post process. (default: 0)
  59793. * @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)
  59794. */
  59795. 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);
  59796. }
  59797. }
  59798. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  59799. /** @hidden */
  59800. export var depthOfFieldMergePixelShader: {
  59801. name: string;
  59802. shader: string;
  59803. };
  59804. }
  59805. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  59806. import { Nullable } from "babylonjs/types";
  59807. import { Camera } from "babylonjs/Cameras/camera";
  59808. import { Effect } from "babylonjs/Materials/effect";
  59809. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59810. import { Engine } from "babylonjs/Engines/engine";
  59811. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  59812. /**
  59813. * Options to be set when merging outputs from the default pipeline.
  59814. */
  59815. export class DepthOfFieldMergePostProcessOptions {
  59816. /**
  59817. * The original image to merge on top of
  59818. */
  59819. originalFromInput: PostProcess;
  59820. /**
  59821. * Parameters to perform the merge of the depth of field effect
  59822. */
  59823. depthOfField?: {
  59824. circleOfConfusion: PostProcess;
  59825. blurSteps: Array<PostProcess>;
  59826. };
  59827. /**
  59828. * Parameters to perform the merge of bloom effect
  59829. */
  59830. bloom?: {
  59831. blurred: PostProcess;
  59832. weight: number;
  59833. };
  59834. }
  59835. /**
  59836. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  59837. */
  59838. export class DepthOfFieldMergePostProcess extends PostProcess {
  59839. private blurSteps;
  59840. /**
  59841. * Creates a new instance of DepthOfFieldMergePostProcess
  59842. * @param name The name of the effect.
  59843. * @param originalFromInput Post process which's input will be used for the merge.
  59844. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  59845. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  59846. * @param options The required width/height ratio to downsize to before computing the render pass.
  59847. * @param camera The camera to apply the render pass to.
  59848. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59849. * @param engine The engine which the post process will be applied. (default: current engine)
  59850. * @param reusable If the post process can be reused on the same frame. (default: false)
  59851. * @param textureType Type of textures used when performing the post process. (default: 0)
  59852. * @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)
  59853. */
  59854. 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);
  59855. /**
  59856. * Updates the effect with the current post process compile time values and recompiles the shader.
  59857. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  59858. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  59859. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  59860. * @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
  59861. * @param onCompiled Called when the shader has been compiled.
  59862. * @param onError Called if there is an error when compiling a shader.
  59863. */
  59864. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  59865. }
  59866. }
  59867. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  59868. import { Nullable } from "babylonjs/types";
  59869. import { Camera } from "babylonjs/Cameras/camera";
  59870. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  59871. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  59872. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  59873. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  59874. import { Scene } from "babylonjs/scene";
  59875. /**
  59876. * Specifies the level of max blur that should be applied when using the depth of field effect
  59877. */
  59878. export enum DepthOfFieldEffectBlurLevel {
  59879. /**
  59880. * Subtle blur
  59881. */
  59882. Low = 0,
  59883. /**
  59884. * Medium blur
  59885. */
  59886. Medium = 1,
  59887. /**
  59888. * Large blur
  59889. */
  59890. High = 2
  59891. }
  59892. /**
  59893. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  59894. */
  59895. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  59896. private _circleOfConfusion;
  59897. /**
  59898. * @hidden Internal, blurs from high to low
  59899. */
  59900. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  59901. private _depthOfFieldBlurY;
  59902. private _dofMerge;
  59903. /**
  59904. * @hidden Internal post processes in depth of field effect
  59905. */
  59906. _effects: Array<PostProcess>;
  59907. /**
  59908. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  59909. */
  59910. focalLength: number;
  59911. /**
  59912. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  59913. */
  59914. fStop: number;
  59915. /**
  59916. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  59917. */
  59918. focusDistance: number;
  59919. /**
  59920. * 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.
  59921. */
  59922. lensSize: number;
  59923. /**
  59924. * Creates a new instance DepthOfFieldEffect
  59925. * @param scene The scene the effect belongs to.
  59926. * @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.
  59927. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  59928. * @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)
  59929. */
  59930. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  59931. /**
  59932. * Get the current class name of the current effet
  59933. * @returns "DepthOfFieldEffect"
  59934. */
  59935. getClassName(): string;
  59936. /**
  59937. * 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.
  59938. */
  59939. depthTexture: RenderTargetTexture;
  59940. /**
  59941. * Disposes each of the internal effects for a given camera.
  59942. * @param camera The camera to dispose the effect on.
  59943. */
  59944. disposeEffects(camera: Camera): void;
  59945. /**
  59946. * @hidden Internal
  59947. */
  59948. _updateEffects(): void;
  59949. /**
  59950. * Internal
  59951. * @returns if all the contained post processes are ready.
  59952. * @hidden
  59953. */
  59954. _isReady(): boolean;
  59955. }
  59956. }
  59957. declare module "babylonjs/Shaders/displayPass.fragment" {
  59958. /** @hidden */
  59959. export var displayPassPixelShader: {
  59960. name: string;
  59961. shader: string;
  59962. };
  59963. }
  59964. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  59965. import { Nullable } from "babylonjs/types";
  59966. import { Camera } from "babylonjs/Cameras/camera";
  59967. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59968. import { Engine } from "babylonjs/Engines/engine";
  59969. import "babylonjs/Shaders/displayPass.fragment";
  59970. /**
  59971. * DisplayPassPostProcess which produces an output the same as it's input
  59972. */
  59973. export class DisplayPassPostProcess extends PostProcess {
  59974. /**
  59975. * Creates the DisplayPassPostProcess
  59976. * @param name The name of the effect.
  59977. * @param options The required width/height ratio to downsize to before computing the render pass.
  59978. * @param camera The camera to apply the render pass to.
  59979. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  59980. * @param engine The engine which the post process will be applied. (default: current engine)
  59981. * @param reusable If the post process can be reused on the same frame. (default: false)
  59982. */
  59983. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  59984. }
  59985. }
  59986. declare module "babylonjs/Shaders/filter.fragment" {
  59987. /** @hidden */
  59988. export var filterPixelShader: {
  59989. name: string;
  59990. shader: string;
  59991. };
  59992. }
  59993. declare module "babylonjs/PostProcesses/filterPostProcess" {
  59994. import { Nullable } from "babylonjs/types";
  59995. import { Matrix } from "babylonjs/Maths/math.vector";
  59996. import { Camera } from "babylonjs/Cameras/camera";
  59997. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  59998. import { Engine } from "babylonjs/Engines/engine";
  59999. import "babylonjs/Shaders/filter.fragment";
  60000. /**
  60001. * Applies a kernel filter to the image
  60002. */
  60003. export class FilterPostProcess extends PostProcess {
  60004. /** The matrix to be applied to the image */
  60005. kernelMatrix: Matrix;
  60006. /**
  60007. *
  60008. * @param name The name of the effect.
  60009. * @param kernelMatrix The matrix to be applied to the image
  60010. * @param options The required width/height ratio to downsize to before computing the render pass.
  60011. * @param camera The camera to apply the render pass to.
  60012. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60013. * @param engine The engine which the post process will be applied. (default: current engine)
  60014. * @param reusable If the post process can be reused on the same frame. (default: false)
  60015. */
  60016. constructor(name: string,
  60017. /** The matrix to be applied to the image */
  60018. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  60019. }
  60020. }
  60021. declare module "babylonjs/Shaders/fxaa.fragment" {
  60022. /** @hidden */
  60023. export var fxaaPixelShader: {
  60024. name: string;
  60025. shader: string;
  60026. };
  60027. }
  60028. declare module "babylonjs/Shaders/fxaa.vertex" {
  60029. /** @hidden */
  60030. export var fxaaVertexShader: {
  60031. name: string;
  60032. shader: string;
  60033. };
  60034. }
  60035. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  60036. import { Nullable } from "babylonjs/types";
  60037. import { Camera } from "babylonjs/Cameras/camera";
  60038. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60039. import { Engine } from "babylonjs/Engines/engine";
  60040. import "babylonjs/Shaders/fxaa.fragment";
  60041. import "babylonjs/Shaders/fxaa.vertex";
  60042. /**
  60043. * Fxaa post process
  60044. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  60045. */
  60046. export class FxaaPostProcess extends PostProcess {
  60047. /** @hidden */
  60048. texelWidth: number;
  60049. /** @hidden */
  60050. texelHeight: number;
  60051. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  60052. private _getDefines;
  60053. }
  60054. }
  60055. declare module "babylonjs/Shaders/grain.fragment" {
  60056. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  60057. /** @hidden */
  60058. export var grainPixelShader: {
  60059. name: string;
  60060. shader: string;
  60061. };
  60062. }
  60063. declare module "babylonjs/PostProcesses/grainPostProcess" {
  60064. import { Nullable } from "babylonjs/types";
  60065. import { Camera } from "babylonjs/Cameras/camera";
  60066. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60067. import { Engine } from "babylonjs/Engines/engine";
  60068. import "babylonjs/Shaders/grain.fragment";
  60069. /**
  60070. * The GrainPostProcess adds noise to the image at mid luminance levels
  60071. */
  60072. export class GrainPostProcess extends PostProcess {
  60073. /**
  60074. * The intensity of the grain added (default: 30)
  60075. */
  60076. intensity: number;
  60077. /**
  60078. * If the grain should be randomized on every frame
  60079. */
  60080. animated: boolean;
  60081. /**
  60082. * Creates a new instance of @see GrainPostProcess
  60083. * @param name The name of the effect.
  60084. * @param options The required width/height ratio to downsize to before computing the render pass.
  60085. * @param camera The camera to apply the render pass to.
  60086. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60087. * @param engine The engine which the post process will be applied. (default: current engine)
  60088. * @param reusable If the post process can be reused on the same frame. (default: false)
  60089. * @param textureType Type of textures used when performing the post process. (default: 0)
  60090. * @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)
  60091. */
  60092. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  60093. }
  60094. }
  60095. declare module "babylonjs/Shaders/highlights.fragment" {
  60096. /** @hidden */
  60097. export var highlightsPixelShader: {
  60098. name: string;
  60099. shader: string;
  60100. };
  60101. }
  60102. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  60103. import { Nullable } from "babylonjs/types";
  60104. import { Camera } from "babylonjs/Cameras/camera";
  60105. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60106. import { Engine } from "babylonjs/Engines/engine";
  60107. import "babylonjs/Shaders/highlights.fragment";
  60108. /**
  60109. * Extracts highlights from the image
  60110. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  60111. */
  60112. export class HighlightsPostProcess extends PostProcess {
  60113. /**
  60114. * Extracts highlights from the image
  60115. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  60116. * @param name The name of the effect.
  60117. * @param options The required width/height ratio to downsize to before computing the render pass.
  60118. * @param camera The camera to apply the render pass to.
  60119. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60120. * @param engine The engine which the post process will be applied. (default: current engine)
  60121. * @param reusable If the post process can be reused on the same frame. (default: false)
  60122. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  60123. */
  60124. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  60125. }
  60126. }
  60127. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  60128. /** @hidden */
  60129. export var mrtFragmentDeclaration: {
  60130. name: string;
  60131. shader: string;
  60132. };
  60133. }
  60134. declare module "babylonjs/Shaders/geometry.fragment" {
  60135. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  60136. /** @hidden */
  60137. export var geometryPixelShader: {
  60138. name: string;
  60139. shader: string;
  60140. };
  60141. }
  60142. declare module "babylonjs/Shaders/geometry.vertex" {
  60143. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60144. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60145. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60146. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60147. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60148. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60149. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60150. /** @hidden */
  60151. export var geometryVertexShader: {
  60152. name: string;
  60153. shader: string;
  60154. };
  60155. }
  60156. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  60157. import { Matrix } from "babylonjs/Maths/math.vector";
  60158. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60159. import { Mesh } from "babylonjs/Meshes/mesh";
  60160. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  60161. import { Effect } from "babylonjs/Materials/effect";
  60162. import { Scene } from "babylonjs/scene";
  60163. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60164. import "babylonjs/Shaders/geometry.fragment";
  60165. import "babylonjs/Shaders/geometry.vertex";
  60166. /** @hidden */
  60167. interface ISavedTransformationMatrix {
  60168. world: Matrix;
  60169. viewProjection: Matrix;
  60170. }
  60171. /**
  60172. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  60173. */
  60174. export class GeometryBufferRenderer {
  60175. /**
  60176. * Constant used to retrieve the position texture index in the G-Buffer textures array
  60177. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  60178. */
  60179. static readonly POSITION_TEXTURE_TYPE: number;
  60180. /**
  60181. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  60182. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  60183. */
  60184. static readonly VELOCITY_TEXTURE_TYPE: number;
  60185. /**
  60186. * Dictionary used to store the previous transformation matrices of each rendered mesh
  60187. * in order to compute objects velocities when enableVelocity is set to "true"
  60188. * @hidden
  60189. */
  60190. _previousTransformationMatrices: {
  60191. [index: number]: ISavedTransformationMatrix;
  60192. };
  60193. /**
  60194. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  60195. * in order to compute objects velocities when enableVelocity is set to "true"
  60196. * @hidden
  60197. */
  60198. _previousBonesTransformationMatrices: {
  60199. [index: number]: Float32Array;
  60200. };
  60201. /**
  60202. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  60203. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  60204. */
  60205. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  60206. private _scene;
  60207. private _multiRenderTarget;
  60208. private _ratio;
  60209. private _enablePosition;
  60210. private _enableVelocity;
  60211. private _positionIndex;
  60212. private _velocityIndex;
  60213. protected _effect: Effect;
  60214. protected _cachedDefines: string;
  60215. /**
  60216. * Set the render list (meshes to be rendered) used in the G buffer.
  60217. */
  60218. renderList: Mesh[];
  60219. /**
  60220. * Gets wether or not G buffer are supported by the running hardware.
  60221. * This requires draw buffer supports
  60222. */
  60223. readonly isSupported: boolean;
  60224. /**
  60225. * Returns the index of the given texture type in the G-Buffer textures array
  60226. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  60227. * @returns the index of the given texture type in the G-Buffer textures array
  60228. */
  60229. getTextureIndex(textureType: number): number;
  60230. /**
  60231. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  60232. */
  60233. /**
  60234. * Sets whether or not objects positions are enabled for the G buffer.
  60235. */
  60236. enablePosition: boolean;
  60237. /**
  60238. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  60239. */
  60240. /**
  60241. * Sets wether or not objects velocities are enabled for the G buffer.
  60242. */
  60243. enableVelocity: boolean;
  60244. /**
  60245. * Gets the scene associated with the buffer.
  60246. */
  60247. readonly scene: Scene;
  60248. /**
  60249. * Gets the ratio used by the buffer during its creation.
  60250. * How big is the buffer related to the main canvas.
  60251. */
  60252. readonly ratio: number;
  60253. /** @hidden */
  60254. static _SceneComponentInitialization: (scene: Scene) => void;
  60255. /**
  60256. * Creates a new G Buffer for the scene
  60257. * @param scene The scene the buffer belongs to
  60258. * @param ratio How big is the buffer related to the main canvas.
  60259. */
  60260. constructor(scene: Scene, ratio?: number);
  60261. /**
  60262. * Checks wether everything is ready to render a submesh to the G buffer.
  60263. * @param subMesh the submesh to check readiness for
  60264. * @param useInstances is the mesh drawn using instance or not
  60265. * @returns true if ready otherwise false
  60266. */
  60267. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60268. /**
  60269. * Gets the current underlying G Buffer.
  60270. * @returns the buffer
  60271. */
  60272. getGBuffer(): MultiRenderTarget;
  60273. /**
  60274. * Gets the number of samples used to render the buffer (anti aliasing).
  60275. */
  60276. /**
  60277. * Sets the number of samples used to render the buffer (anti aliasing).
  60278. */
  60279. samples: number;
  60280. /**
  60281. * Disposes the renderer and frees up associated resources.
  60282. */
  60283. dispose(): void;
  60284. protected _createRenderTargets(): void;
  60285. private _copyBonesTransformationMatrices;
  60286. }
  60287. }
  60288. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  60289. import { Nullable } from "babylonjs/types";
  60290. import { Scene } from "babylonjs/scene";
  60291. import { ISceneComponent } from "babylonjs/sceneComponent";
  60292. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  60293. module "babylonjs/scene" {
  60294. interface Scene {
  60295. /** @hidden (Backing field) */
  60296. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  60297. /**
  60298. * Gets or Sets the current geometry buffer associated to the scene.
  60299. */
  60300. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  60301. /**
  60302. * Enables a GeometryBufferRender and associates it with the scene
  60303. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  60304. * @returns the GeometryBufferRenderer
  60305. */
  60306. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  60307. /**
  60308. * Disables the GeometryBufferRender associated with the scene
  60309. */
  60310. disableGeometryBufferRenderer(): void;
  60311. }
  60312. }
  60313. /**
  60314. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  60315. * in several rendering techniques.
  60316. */
  60317. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  60318. /**
  60319. * The component name helpful to identify the component in the list of scene components.
  60320. */
  60321. readonly name: string;
  60322. /**
  60323. * The scene the component belongs to.
  60324. */
  60325. scene: Scene;
  60326. /**
  60327. * Creates a new instance of the component for the given scene
  60328. * @param scene Defines the scene to register the component in
  60329. */
  60330. constructor(scene: Scene);
  60331. /**
  60332. * Registers the component in a given scene
  60333. */
  60334. register(): void;
  60335. /**
  60336. * Rebuilds the elements related to this component in case of
  60337. * context lost for instance.
  60338. */
  60339. rebuild(): void;
  60340. /**
  60341. * Disposes the component and the associated ressources
  60342. */
  60343. dispose(): void;
  60344. private _gatherRenderTargets;
  60345. }
  60346. }
  60347. declare module "babylonjs/Shaders/motionBlur.fragment" {
  60348. /** @hidden */
  60349. export var motionBlurPixelShader: {
  60350. name: string;
  60351. shader: string;
  60352. };
  60353. }
  60354. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  60355. import { Nullable } from "babylonjs/types";
  60356. import { Camera } from "babylonjs/Cameras/camera";
  60357. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60358. import { Scene } from "babylonjs/scene";
  60359. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60360. import "babylonjs/Animations/animatable";
  60361. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  60362. import "babylonjs/Shaders/motionBlur.fragment";
  60363. import { Engine } from "babylonjs/Engines/engine";
  60364. /**
  60365. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  60366. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  60367. * As an example, all you have to do is to create the post-process:
  60368. * var mb = new BABYLON.MotionBlurPostProcess(
  60369. * 'mb', // The name of the effect.
  60370. * scene, // The scene containing the objects to blur according to their velocity.
  60371. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  60372. * camera // The camera to apply the render pass to.
  60373. * );
  60374. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  60375. */
  60376. export class MotionBlurPostProcess extends PostProcess {
  60377. /**
  60378. * Defines how much the image is blurred by the movement. Default value is equal to 1
  60379. */
  60380. motionStrength: number;
  60381. /**
  60382. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  60383. */
  60384. /**
  60385. * Sets the number of iterations to be used for motion blur quality
  60386. */
  60387. motionBlurSamples: number;
  60388. private _motionBlurSamples;
  60389. private _geometryBufferRenderer;
  60390. /**
  60391. * Creates a new instance MotionBlurPostProcess
  60392. * @param name The name of the effect.
  60393. * @param scene The scene containing the objects to blur according to their velocity.
  60394. * @param options The required width/height ratio to downsize to before computing the render pass.
  60395. * @param camera The camera to apply the render pass to.
  60396. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60397. * @param engine The engine which the post process will be applied. (default: current engine)
  60398. * @param reusable If the post process can be reused on the same frame. (default: false)
  60399. * @param textureType Type of textures used when performing the post process. (default: 0)
  60400. * @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)
  60401. */
  60402. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  60403. /**
  60404. * Excludes the given skinned mesh from computing bones velocities.
  60405. * 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.
  60406. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  60407. */
  60408. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  60409. /**
  60410. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  60411. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  60412. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  60413. */
  60414. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  60415. /**
  60416. * Disposes the post process.
  60417. * @param camera The camera to dispose the post process on.
  60418. */
  60419. dispose(camera?: Camera): void;
  60420. }
  60421. }
  60422. declare module "babylonjs/Shaders/refraction.fragment" {
  60423. /** @hidden */
  60424. export var refractionPixelShader: {
  60425. name: string;
  60426. shader: string;
  60427. };
  60428. }
  60429. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  60430. import { Color3 } from "babylonjs/Maths/math.color";
  60431. import { Camera } from "babylonjs/Cameras/camera";
  60432. import { Texture } from "babylonjs/Materials/Textures/texture";
  60433. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60434. import { Engine } from "babylonjs/Engines/engine";
  60435. import "babylonjs/Shaders/refraction.fragment";
  60436. /**
  60437. * Post process which applies a refractin texture
  60438. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  60439. */
  60440. export class RefractionPostProcess extends PostProcess {
  60441. /** the base color of the refraction (used to taint the rendering) */
  60442. color: Color3;
  60443. /** simulated refraction depth */
  60444. depth: number;
  60445. /** the coefficient of the base color (0 to remove base color tainting) */
  60446. colorLevel: number;
  60447. private _refTexture;
  60448. private _ownRefractionTexture;
  60449. /**
  60450. * Gets or sets the refraction texture
  60451. * Please note that you are responsible for disposing the texture if you set it manually
  60452. */
  60453. refractionTexture: Texture;
  60454. /**
  60455. * Initializes the RefractionPostProcess
  60456. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  60457. * @param name The name of the effect.
  60458. * @param refractionTextureUrl Url of the refraction texture to use
  60459. * @param color the base color of the refraction (used to taint the rendering)
  60460. * @param depth simulated refraction depth
  60461. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  60462. * @param camera The camera to apply the render pass to.
  60463. * @param options The required width/height ratio to downsize to before computing the render pass.
  60464. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60465. * @param engine The engine which the post process will be applied. (default: current engine)
  60466. * @param reusable If the post process can be reused on the same frame. (default: false)
  60467. */
  60468. constructor(name: string, refractionTextureUrl: string,
  60469. /** the base color of the refraction (used to taint the rendering) */
  60470. color: Color3,
  60471. /** simulated refraction depth */
  60472. depth: number,
  60473. /** the coefficient of the base color (0 to remove base color tainting) */
  60474. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  60475. /**
  60476. * Disposes of the post process
  60477. * @param camera Camera to dispose post process on
  60478. */
  60479. dispose(camera: Camera): void;
  60480. }
  60481. }
  60482. declare module "babylonjs/Shaders/sharpen.fragment" {
  60483. /** @hidden */
  60484. export var sharpenPixelShader: {
  60485. name: string;
  60486. shader: string;
  60487. };
  60488. }
  60489. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  60490. import { Nullable } from "babylonjs/types";
  60491. import { Camera } from "babylonjs/Cameras/camera";
  60492. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  60493. import "babylonjs/Shaders/sharpen.fragment";
  60494. import { Engine } from "babylonjs/Engines/engine";
  60495. /**
  60496. * The SharpenPostProcess applies a sharpen kernel to every pixel
  60497. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  60498. */
  60499. export class SharpenPostProcess extends PostProcess {
  60500. /**
  60501. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  60502. */
  60503. colorAmount: number;
  60504. /**
  60505. * How much sharpness should be applied (default: 0.3)
  60506. */
  60507. edgeAmount: number;
  60508. /**
  60509. * Creates a new instance ConvolutionPostProcess
  60510. * @param name The name of the effect.
  60511. * @param options The required width/height ratio to downsize to before computing the render pass.
  60512. * @param camera The camera to apply the render pass to.
  60513. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  60514. * @param engine The engine which the post process will be applied. (default: current engine)
  60515. * @param reusable If the post process can be reused on the same frame. (default: false)
  60516. * @param textureType Type of textures used when performing the post process. (default: 0)
  60517. * @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)
  60518. */
  60519. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  60520. }
  60521. }
  60522. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  60523. import { Nullable } from "babylonjs/types";
  60524. import { Camera } from "babylonjs/Cameras/camera";
  60525. import { Engine } from "babylonjs/Engines/engine";
  60526. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  60527. import { IInspectable } from "babylonjs/Misc/iInspectable";
  60528. /**
  60529. * PostProcessRenderPipeline
  60530. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  60531. */
  60532. export class PostProcessRenderPipeline {
  60533. private engine;
  60534. private _renderEffects;
  60535. private _renderEffectsForIsolatedPass;
  60536. /**
  60537. * List of inspectable custom properties (used by the Inspector)
  60538. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  60539. */
  60540. inspectableCustomProperties: IInspectable[];
  60541. /**
  60542. * @hidden
  60543. */
  60544. protected _cameras: Camera[];
  60545. /** @hidden */
  60546. _name: string;
  60547. /**
  60548. * Gets pipeline name
  60549. */
  60550. readonly name: string;
  60551. /**
  60552. * Initializes a PostProcessRenderPipeline
  60553. * @param engine engine to add the pipeline to
  60554. * @param name name of the pipeline
  60555. */
  60556. constructor(engine: Engine, name: string);
  60557. /**
  60558. * Gets the class name
  60559. * @returns "PostProcessRenderPipeline"
  60560. */
  60561. getClassName(): string;
  60562. /**
  60563. * If all the render effects in the pipeline are supported
  60564. */
  60565. readonly isSupported: boolean;
  60566. /**
  60567. * Adds an effect to the pipeline
  60568. * @param renderEffect the effect to add
  60569. */
  60570. addEffect(renderEffect: PostProcessRenderEffect): void;
  60571. /** @hidden */
  60572. _rebuild(): void;
  60573. /** @hidden */
  60574. _enableEffect(renderEffectName: string, cameras: Camera): void;
  60575. /** @hidden */
  60576. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  60577. /** @hidden */
  60578. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  60579. /** @hidden */
  60580. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  60581. /** @hidden */
  60582. _attachCameras(cameras: Camera, unique: boolean): void;
  60583. /** @hidden */
  60584. _attachCameras(cameras: Camera[], unique: boolean): void;
  60585. /** @hidden */
  60586. _detachCameras(cameras: Camera): void;
  60587. /** @hidden */
  60588. _detachCameras(cameras: Nullable<Camera[]>): void;
  60589. /** @hidden */
  60590. _update(): void;
  60591. /** @hidden */
  60592. _reset(): void;
  60593. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  60594. /**
  60595. * Disposes of the pipeline
  60596. */
  60597. dispose(): void;
  60598. }
  60599. }
  60600. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  60601. import { Camera } from "babylonjs/Cameras/camera";
  60602. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  60603. /**
  60604. * PostProcessRenderPipelineManager class
  60605. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  60606. */
  60607. export class PostProcessRenderPipelineManager {
  60608. private _renderPipelines;
  60609. /**
  60610. * Initializes a PostProcessRenderPipelineManager
  60611. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  60612. */
  60613. constructor();
  60614. /**
  60615. * Gets the list of supported render pipelines
  60616. */
  60617. readonly supportedPipelines: PostProcessRenderPipeline[];
  60618. /**
  60619. * Adds a pipeline to the manager
  60620. * @param renderPipeline The pipeline to add
  60621. */
  60622. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  60623. /**
  60624. * Attaches a camera to the pipeline
  60625. * @param renderPipelineName The name of the pipeline to attach to
  60626. * @param cameras the camera to attach
  60627. * @param unique if the camera can be attached multiple times to the pipeline
  60628. */
  60629. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  60630. /**
  60631. * Detaches a camera from the pipeline
  60632. * @param renderPipelineName The name of the pipeline to detach from
  60633. * @param cameras the camera to detach
  60634. */
  60635. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  60636. /**
  60637. * Enables an effect by name on a pipeline
  60638. * @param renderPipelineName the name of the pipeline to enable the effect in
  60639. * @param renderEffectName the name of the effect to enable
  60640. * @param cameras the cameras that the effect should be enabled on
  60641. */
  60642. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  60643. /**
  60644. * Disables an effect by name on a pipeline
  60645. * @param renderPipelineName the name of the pipeline to disable the effect in
  60646. * @param renderEffectName the name of the effect to disable
  60647. * @param cameras the cameras that the effect should be disabled on
  60648. */
  60649. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  60650. /**
  60651. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  60652. */
  60653. update(): void;
  60654. /** @hidden */
  60655. _rebuild(): void;
  60656. /**
  60657. * Disposes of the manager and pipelines
  60658. */
  60659. dispose(): void;
  60660. }
  60661. }
  60662. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  60663. import { ISceneComponent } from "babylonjs/sceneComponent";
  60664. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  60665. import { Scene } from "babylonjs/scene";
  60666. module "babylonjs/scene" {
  60667. interface Scene {
  60668. /** @hidden (Backing field) */
  60669. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  60670. /**
  60671. * Gets the postprocess render pipeline manager
  60672. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  60673. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  60674. */
  60675. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  60676. }
  60677. }
  60678. /**
  60679. * Defines the Render Pipeline scene component responsible to rendering pipelines
  60680. */
  60681. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  60682. /**
  60683. * The component name helpfull to identify the component in the list of scene components.
  60684. */
  60685. readonly name: string;
  60686. /**
  60687. * The scene the component belongs to.
  60688. */
  60689. scene: Scene;
  60690. /**
  60691. * Creates a new instance of the component for the given scene
  60692. * @param scene Defines the scene to register the component in
  60693. */
  60694. constructor(scene: Scene);
  60695. /**
  60696. * Registers the component in a given scene
  60697. */
  60698. register(): void;
  60699. /**
  60700. * Rebuilds the elements related to this component in case of
  60701. * context lost for instance.
  60702. */
  60703. rebuild(): void;
  60704. /**
  60705. * Disposes the component and the associated ressources
  60706. */
  60707. dispose(): void;
  60708. private _gatherRenderTargets;
  60709. }
  60710. }
  60711. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  60712. import { Nullable } from "babylonjs/types";
  60713. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  60714. import { Camera } from "babylonjs/Cameras/camera";
  60715. import { IDisposable } from "babylonjs/scene";
  60716. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  60717. import { Scene } from "babylonjs/scene";
  60718. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  60719. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  60720. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  60721. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  60722. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  60723. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  60724. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  60725. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  60726. import { Animation } from "babylonjs/Animations/animation";
  60727. /**
  60728. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  60729. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  60730. */
  60731. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  60732. private _scene;
  60733. private _camerasToBeAttached;
  60734. /**
  60735. * ID of the sharpen post process,
  60736. */
  60737. private readonly SharpenPostProcessId;
  60738. /**
  60739. * @ignore
  60740. * ID of the image processing post process;
  60741. */
  60742. readonly ImageProcessingPostProcessId: string;
  60743. /**
  60744. * @ignore
  60745. * ID of the Fast Approximate Anti-Aliasing post process;
  60746. */
  60747. readonly FxaaPostProcessId: string;
  60748. /**
  60749. * ID of the chromatic aberration post process,
  60750. */
  60751. private readonly ChromaticAberrationPostProcessId;
  60752. /**
  60753. * ID of the grain post process
  60754. */
  60755. private readonly GrainPostProcessId;
  60756. /**
  60757. * Sharpen post process which will apply a sharpen convolution to enhance edges
  60758. */
  60759. sharpen: SharpenPostProcess;
  60760. private _sharpenEffect;
  60761. private bloom;
  60762. /**
  60763. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  60764. */
  60765. depthOfField: DepthOfFieldEffect;
  60766. /**
  60767. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  60768. */
  60769. fxaa: FxaaPostProcess;
  60770. /**
  60771. * Image post processing pass used to perform operations such as tone mapping or color grading.
  60772. */
  60773. imageProcessing: ImageProcessingPostProcess;
  60774. /**
  60775. * Chromatic aberration post process which will shift rgb colors in the image
  60776. */
  60777. chromaticAberration: ChromaticAberrationPostProcess;
  60778. private _chromaticAberrationEffect;
  60779. /**
  60780. * Grain post process which add noise to the image
  60781. */
  60782. grain: GrainPostProcess;
  60783. private _grainEffect;
  60784. /**
  60785. * Glow post process which adds a glow to emissive areas of the image
  60786. */
  60787. private _glowLayer;
  60788. /**
  60789. * Animations which can be used to tweak settings over a period of time
  60790. */
  60791. animations: Animation[];
  60792. private _imageProcessingConfigurationObserver;
  60793. private _sharpenEnabled;
  60794. private _bloomEnabled;
  60795. private _depthOfFieldEnabled;
  60796. private _depthOfFieldBlurLevel;
  60797. private _fxaaEnabled;
  60798. private _imageProcessingEnabled;
  60799. private _defaultPipelineTextureType;
  60800. private _bloomScale;
  60801. private _chromaticAberrationEnabled;
  60802. private _grainEnabled;
  60803. private _buildAllowed;
  60804. /**
  60805. * Gets active scene
  60806. */
  60807. readonly scene: Scene;
  60808. /**
  60809. * Enable or disable the sharpen process from the pipeline
  60810. */
  60811. sharpenEnabled: boolean;
  60812. private _resizeObserver;
  60813. private _hardwareScaleLevel;
  60814. private _bloomKernel;
  60815. /**
  60816. * Specifies the size of the bloom blur kernel, relative to the final output size
  60817. */
  60818. bloomKernel: number;
  60819. /**
  60820. * Specifies the weight of the bloom in the final rendering
  60821. */
  60822. private _bloomWeight;
  60823. /**
  60824. * Specifies the luma threshold for the area that will be blurred by the bloom
  60825. */
  60826. private _bloomThreshold;
  60827. private _hdr;
  60828. /**
  60829. * The strength of the bloom.
  60830. */
  60831. bloomWeight: number;
  60832. /**
  60833. * The strength of the bloom.
  60834. */
  60835. bloomThreshold: number;
  60836. /**
  60837. * The scale of the bloom, lower value will provide better performance.
  60838. */
  60839. bloomScale: number;
  60840. /**
  60841. * Enable or disable the bloom from the pipeline
  60842. */
  60843. bloomEnabled: boolean;
  60844. private _rebuildBloom;
  60845. /**
  60846. * If the depth of field is enabled.
  60847. */
  60848. depthOfFieldEnabled: boolean;
  60849. /**
  60850. * Blur level of the depth of field effect. (Higher blur will effect performance)
  60851. */
  60852. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  60853. /**
  60854. * If the anti aliasing is enabled.
  60855. */
  60856. fxaaEnabled: boolean;
  60857. private _samples;
  60858. /**
  60859. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  60860. */
  60861. samples: number;
  60862. /**
  60863. * If image processing is enabled.
  60864. */
  60865. imageProcessingEnabled: boolean;
  60866. /**
  60867. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  60868. */
  60869. glowLayerEnabled: boolean;
  60870. /**
  60871. * Gets the glow layer (or null if not defined)
  60872. */
  60873. readonly glowLayer: Nullable<GlowLayer>;
  60874. /**
  60875. * Enable or disable the chromaticAberration process from the pipeline
  60876. */
  60877. chromaticAberrationEnabled: boolean;
  60878. /**
  60879. * Enable or disable the grain process from the pipeline
  60880. */
  60881. grainEnabled: boolean;
  60882. /**
  60883. * @constructor
  60884. * @param name - The rendering pipeline name (default: "")
  60885. * @param hdr - If high dynamic range textures should be used (default: true)
  60886. * @param scene - The scene linked to this pipeline (default: the last created scene)
  60887. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  60888. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  60889. */
  60890. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  60891. /**
  60892. * Get the class name
  60893. * @returns "DefaultRenderingPipeline"
  60894. */
  60895. getClassName(): string;
  60896. /**
  60897. * Force the compilation of the entire pipeline.
  60898. */
  60899. prepare(): void;
  60900. private _hasCleared;
  60901. private _prevPostProcess;
  60902. private _prevPrevPostProcess;
  60903. private _setAutoClearAndTextureSharing;
  60904. private _depthOfFieldSceneObserver;
  60905. private _buildPipeline;
  60906. private _disposePostProcesses;
  60907. /**
  60908. * Adds a camera to the pipeline
  60909. * @param camera the camera to be added
  60910. */
  60911. addCamera(camera: Camera): void;
  60912. /**
  60913. * Removes a camera from the pipeline
  60914. * @param camera the camera to remove
  60915. */
  60916. removeCamera(camera: Camera): void;
  60917. /**
  60918. * Dispose of the pipeline and stop all post processes
  60919. */
  60920. dispose(): void;
  60921. /**
  60922. * Serialize the rendering pipeline (Used when exporting)
  60923. * @returns the serialized object
  60924. */
  60925. serialize(): any;
  60926. /**
  60927. * Parse the serialized pipeline
  60928. * @param source Source pipeline.
  60929. * @param scene The scene to load the pipeline to.
  60930. * @param rootUrl The URL of the serialized pipeline.
  60931. * @returns An instantiated pipeline from the serialized object.
  60932. */
  60933. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  60934. }
  60935. }
  60936. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  60937. /** @hidden */
  60938. export var lensHighlightsPixelShader: {
  60939. name: string;
  60940. shader: string;
  60941. };
  60942. }
  60943. declare module "babylonjs/Shaders/depthOfField.fragment" {
  60944. /** @hidden */
  60945. export var depthOfFieldPixelShader: {
  60946. name: string;
  60947. shader: string;
  60948. };
  60949. }
  60950. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  60951. import { Camera } from "babylonjs/Cameras/camera";
  60952. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  60953. import { Scene } from "babylonjs/scene";
  60954. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  60955. import "babylonjs/Shaders/chromaticAberration.fragment";
  60956. import "babylonjs/Shaders/lensHighlights.fragment";
  60957. import "babylonjs/Shaders/depthOfField.fragment";
  60958. /**
  60959. * BABYLON.JS Chromatic Aberration GLSL Shader
  60960. * Author: Olivier Guyot
  60961. * Separates very slightly R, G and B colors on the edges of the screen
  60962. * Inspired by Francois Tarlier & Martins Upitis
  60963. */
  60964. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  60965. /**
  60966. * @ignore
  60967. * The chromatic aberration PostProcess id in the pipeline
  60968. */
  60969. LensChromaticAberrationEffect: string;
  60970. /**
  60971. * @ignore
  60972. * The highlights enhancing PostProcess id in the pipeline
  60973. */
  60974. HighlightsEnhancingEffect: string;
  60975. /**
  60976. * @ignore
  60977. * The depth-of-field PostProcess id in the pipeline
  60978. */
  60979. LensDepthOfFieldEffect: string;
  60980. private _scene;
  60981. private _depthTexture;
  60982. private _grainTexture;
  60983. private _chromaticAberrationPostProcess;
  60984. private _highlightsPostProcess;
  60985. private _depthOfFieldPostProcess;
  60986. private _edgeBlur;
  60987. private _grainAmount;
  60988. private _chromaticAberration;
  60989. private _distortion;
  60990. private _highlightsGain;
  60991. private _highlightsThreshold;
  60992. private _dofDistance;
  60993. private _dofAperture;
  60994. private _dofDarken;
  60995. private _dofPentagon;
  60996. private _blurNoise;
  60997. /**
  60998. * @constructor
  60999. *
  61000. * Effect parameters are as follow:
  61001. * {
  61002. * chromatic_aberration: number; // from 0 to x (1 for realism)
  61003. * edge_blur: number; // from 0 to x (1 for realism)
  61004. * distortion: number; // from 0 to x (1 for realism)
  61005. * grain_amount: number; // from 0 to 1
  61006. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  61007. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  61008. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  61009. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  61010. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  61011. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  61012. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  61013. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  61014. * }
  61015. * Note: if an effect parameter is unset, effect is disabled
  61016. *
  61017. * @param name The rendering pipeline name
  61018. * @param parameters - An object containing all parameters (see above)
  61019. * @param scene The scene linked to this pipeline
  61020. * @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)
  61021. * @param cameras The array of cameras that the rendering pipeline will be attached to
  61022. */
  61023. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  61024. /**
  61025. * Get the class name
  61026. * @returns "LensRenderingPipeline"
  61027. */
  61028. getClassName(): string;
  61029. /**
  61030. * Gets associated scene
  61031. */
  61032. readonly scene: Scene;
  61033. /**
  61034. * Gets or sets the edge blur
  61035. */
  61036. edgeBlur: number;
  61037. /**
  61038. * Gets or sets the grain amount
  61039. */
  61040. grainAmount: number;
  61041. /**
  61042. * Gets or sets the chromatic aberration amount
  61043. */
  61044. chromaticAberration: number;
  61045. /**
  61046. * Gets or sets the depth of field aperture
  61047. */
  61048. dofAperture: number;
  61049. /**
  61050. * Gets or sets the edge distortion
  61051. */
  61052. edgeDistortion: number;
  61053. /**
  61054. * Gets or sets the depth of field distortion
  61055. */
  61056. dofDistortion: number;
  61057. /**
  61058. * Gets or sets the darken out of focus amount
  61059. */
  61060. darkenOutOfFocus: number;
  61061. /**
  61062. * Gets or sets a boolean indicating if blur noise is enabled
  61063. */
  61064. blurNoise: boolean;
  61065. /**
  61066. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  61067. */
  61068. pentagonBokeh: boolean;
  61069. /**
  61070. * Gets or sets the highlight grain amount
  61071. */
  61072. highlightsGain: number;
  61073. /**
  61074. * Gets or sets the highlight threshold
  61075. */
  61076. highlightsThreshold: number;
  61077. /**
  61078. * Sets the amount of blur at the edges
  61079. * @param amount blur amount
  61080. */
  61081. setEdgeBlur(amount: number): void;
  61082. /**
  61083. * Sets edge blur to 0
  61084. */
  61085. disableEdgeBlur(): void;
  61086. /**
  61087. * Sets the amout of grain
  61088. * @param amount Amount of grain
  61089. */
  61090. setGrainAmount(amount: number): void;
  61091. /**
  61092. * Set grain amount to 0
  61093. */
  61094. disableGrain(): void;
  61095. /**
  61096. * Sets the chromatic aberration amount
  61097. * @param amount amount of chromatic aberration
  61098. */
  61099. setChromaticAberration(amount: number): void;
  61100. /**
  61101. * Sets chromatic aberration amount to 0
  61102. */
  61103. disableChromaticAberration(): void;
  61104. /**
  61105. * Sets the EdgeDistortion amount
  61106. * @param amount amount of EdgeDistortion
  61107. */
  61108. setEdgeDistortion(amount: number): void;
  61109. /**
  61110. * Sets edge distortion to 0
  61111. */
  61112. disableEdgeDistortion(): void;
  61113. /**
  61114. * Sets the FocusDistance amount
  61115. * @param amount amount of FocusDistance
  61116. */
  61117. setFocusDistance(amount: number): void;
  61118. /**
  61119. * Disables depth of field
  61120. */
  61121. disableDepthOfField(): void;
  61122. /**
  61123. * Sets the Aperture amount
  61124. * @param amount amount of Aperture
  61125. */
  61126. setAperture(amount: number): void;
  61127. /**
  61128. * Sets the DarkenOutOfFocus amount
  61129. * @param amount amount of DarkenOutOfFocus
  61130. */
  61131. setDarkenOutOfFocus(amount: number): void;
  61132. private _pentagonBokehIsEnabled;
  61133. /**
  61134. * Creates a pentagon bokeh effect
  61135. */
  61136. enablePentagonBokeh(): void;
  61137. /**
  61138. * Disables the pentagon bokeh effect
  61139. */
  61140. disablePentagonBokeh(): void;
  61141. /**
  61142. * Enables noise blur
  61143. */
  61144. enableNoiseBlur(): void;
  61145. /**
  61146. * Disables noise blur
  61147. */
  61148. disableNoiseBlur(): void;
  61149. /**
  61150. * Sets the HighlightsGain amount
  61151. * @param amount amount of HighlightsGain
  61152. */
  61153. setHighlightsGain(amount: number): void;
  61154. /**
  61155. * Sets the HighlightsThreshold amount
  61156. * @param amount amount of HighlightsThreshold
  61157. */
  61158. setHighlightsThreshold(amount: number): void;
  61159. /**
  61160. * Disables highlights
  61161. */
  61162. disableHighlights(): void;
  61163. /**
  61164. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  61165. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  61166. */
  61167. dispose(disableDepthRender?: boolean): void;
  61168. private _createChromaticAberrationPostProcess;
  61169. private _createHighlightsPostProcess;
  61170. private _createDepthOfFieldPostProcess;
  61171. private _createGrainTexture;
  61172. }
  61173. }
  61174. declare module "babylonjs/Shaders/ssao2.fragment" {
  61175. /** @hidden */
  61176. export var ssao2PixelShader: {
  61177. name: string;
  61178. shader: string;
  61179. };
  61180. }
  61181. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  61182. /** @hidden */
  61183. export var ssaoCombinePixelShader: {
  61184. name: string;
  61185. shader: string;
  61186. };
  61187. }
  61188. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  61189. import { Camera } from "babylonjs/Cameras/camera";
  61190. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  61191. import { Scene } from "babylonjs/scene";
  61192. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  61193. import "babylonjs/Shaders/ssao2.fragment";
  61194. import "babylonjs/Shaders/ssaoCombine.fragment";
  61195. /**
  61196. * Render pipeline to produce ssao effect
  61197. */
  61198. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  61199. /**
  61200. * @ignore
  61201. * The PassPostProcess id in the pipeline that contains the original scene color
  61202. */
  61203. SSAOOriginalSceneColorEffect: string;
  61204. /**
  61205. * @ignore
  61206. * The SSAO PostProcess id in the pipeline
  61207. */
  61208. SSAORenderEffect: string;
  61209. /**
  61210. * @ignore
  61211. * The horizontal blur PostProcess id in the pipeline
  61212. */
  61213. SSAOBlurHRenderEffect: string;
  61214. /**
  61215. * @ignore
  61216. * The vertical blur PostProcess id in the pipeline
  61217. */
  61218. SSAOBlurVRenderEffect: string;
  61219. /**
  61220. * @ignore
  61221. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  61222. */
  61223. SSAOCombineRenderEffect: string;
  61224. /**
  61225. * The output strength of the SSAO post-process. Default value is 1.0.
  61226. */
  61227. totalStrength: number;
  61228. /**
  61229. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  61230. */
  61231. maxZ: number;
  61232. /**
  61233. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  61234. */
  61235. minZAspect: number;
  61236. private _samples;
  61237. /**
  61238. * Number of samples used for the SSAO calculations. Default value is 8
  61239. */
  61240. samples: number;
  61241. private _textureSamples;
  61242. /**
  61243. * Number of samples to use for antialiasing
  61244. */
  61245. textureSamples: number;
  61246. /**
  61247. * Ratio object used for SSAO ratio and blur ratio
  61248. */
  61249. private _ratio;
  61250. /**
  61251. * Dynamically generated sphere sampler.
  61252. */
  61253. private _sampleSphere;
  61254. /**
  61255. * Blur filter offsets
  61256. */
  61257. private _samplerOffsets;
  61258. private _expensiveBlur;
  61259. /**
  61260. * If bilateral blur should be used
  61261. */
  61262. expensiveBlur: boolean;
  61263. /**
  61264. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  61265. */
  61266. radius: number;
  61267. /**
  61268. * The base color of the SSAO post-process
  61269. * The final result is "base + ssao" between [0, 1]
  61270. */
  61271. base: number;
  61272. /**
  61273. * Support test.
  61274. */
  61275. static readonly IsSupported: boolean;
  61276. private _scene;
  61277. private _depthTexture;
  61278. private _normalTexture;
  61279. private _randomTexture;
  61280. private _originalColorPostProcess;
  61281. private _ssaoPostProcess;
  61282. private _blurHPostProcess;
  61283. private _blurVPostProcess;
  61284. private _ssaoCombinePostProcess;
  61285. private _firstUpdate;
  61286. /**
  61287. * Gets active scene
  61288. */
  61289. readonly scene: Scene;
  61290. /**
  61291. * @constructor
  61292. * @param name The rendering pipeline name
  61293. * @param scene The scene linked to this pipeline
  61294. * @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 }
  61295. * @param cameras The array of cameras that the rendering pipeline will be attached to
  61296. */
  61297. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  61298. /**
  61299. * Get the class name
  61300. * @returns "SSAO2RenderingPipeline"
  61301. */
  61302. getClassName(): string;
  61303. /**
  61304. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  61305. */
  61306. dispose(disableGeometryBufferRenderer?: boolean): void;
  61307. private _createBlurPostProcess;
  61308. /** @hidden */
  61309. _rebuild(): void;
  61310. private _bits;
  61311. private _radicalInverse_VdC;
  61312. private _hammersley;
  61313. private _hemisphereSample_uniform;
  61314. private _generateHemisphere;
  61315. private _createSSAOPostProcess;
  61316. private _createSSAOCombinePostProcess;
  61317. private _createRandomTexture;
  61318. /**
  61319. * Serialize the rendering pipeline (Used when exporting)
  61320. * @returns the serialized object
  61321. */
  61322. serialize(): any;
  61323. /**
  61324. * Parse the serialized pipeline
  61325. * @param source Source pipeline.
  61326. * @param scene The scene to load the pipeline to.
  61327. * @param rootUrl The URL of the serialized pipeline.
  61328. * @returns An instantiated pipeline from the serialized object.
  61329. */
  61330. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  61331. }
  61332. }
  61333. declare module "babylonjs/Shaders/ssao.fragment" {
  61334. /** @hidden */
  61335. export var ssaoPixelShader: {
  61336. name: string;
  61337. shader: string;
  61338. };
  61339. }
  61340. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  61341. import { Camera } from "babylonjs/Cameras/camera";
  61342. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  61343. import { Scene } from "babylonjs/scene";
  61344. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  61345. import "babylonjs/Shaders/ssao.fragment";
  61346. import "babylonjs/Shaders/ssaoCombine.fragment";
  61347. /**
  61348. * Render pipeline to produce ssao effect
  61349. */
  61350. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  61351. /**
  61352. * @ignore
  61353. * The PassPostProcess id in the pipeline that contains the original scene color
  61354. */
  61355. SSAOOriginalSceneColorEffect: string;
  61356. /**
  61357. * @ignore
  61358. * The SSAO PostProcess id in the pipeline
  61359. */
  61360. SSAORenderEffect: string;
  61361. /**
  61362. * @ignore
  61363. * The horizontal blur PostProcess id in the pipeline
  61364. */
  61365. SSAOBlurHRenderEffect: string;
  61366. /**
  61367. * @ignore
  61368. * The vertical blur PostProcess id in the pipeline
  61369. */
  61370. SSAOBlurVRenderEffect: string;
  61371. /**
  61372. * @ignore
  61373. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  61374. */
  61375. SSAOCombineRenderEffect: string;
  61376. /**
  61377. * The output strength of the SSAO post-process. Default value is 1.0.
  61378. */
  61379. totalStrength: number;
  61380. /**
  61381. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  61382. */
  61383. radius: number;
  61384. /**
  61385. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  61386. * Must not be equal to fallOff and superior to fallOff.
  61387. * Default value is 0.0075
  61388. */
  61389. area: number;
  61390. /**
  61391. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  61392. * Must not be equal to area and inferior to area.
  61393. * Default value is 0.000001
  61394. */
  61395. fallOff: number;
  61396. /**
  61397. * The base color of the SSAO post-process
  61398. * The final result is "base + ssao" between [0, 1]
  61399. */
  61400. base: number;
  61401. private _scene;
  61402. private _depthTexture;
  61403. private _randomTexture;
  61404. private _originalColorPostProcess;
  61405. private _ssaoPostProcess;
  61406. private _blurHPostProcess;
  61407. private _blurVPostProcess;
  61408. private _ssaoCombinePostProcess;
  61409. private _firstUpdate;
  61410. /**
  61411. * Gets active scene
  61412. */
  61413. readonly scene: Scene;
  61414. /**
  61415. * @constructor
  61416. * @param name - The rendering pipeline name
  61417. * @param scene - The scene linked to this pipeline
  61418. * @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 }
  61419. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  61420. */
  61421. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  61422. /**
  61423. * Get the class name
  61424. * @returns "SSAORenderingPipeline"
  61425. */
  61426. getClassName(): string;
  61427. /**
  61428. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  61429. */
  61430. dispose(disableDepthRender?: boolean): void;
  61431. private _createBlurPostProcess;
  61432. /** @hidden */
  61433. _rebuild(): void;
  61434. private _createSSAOPostProcess;
  61435. private _createSSAOCombinePostProcess;
  61436. private _createRandomTexture;
  61437. }
  61438. }
  61439. declare module "babylonjs/Shaders/standard.fragment" {
  61440. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  61441. /** @hidden */
  61442. export var standardPixelShader: {
  61443. name: string;
  61444. shader: string;
  61445. };
  61446. }
  61447. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  61448. import { Nullable } from "babylonjs/types";
  61449. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  61450. import { Camera } from "babylonjs/Cameras/camera";
  61451. import { Texture } from "babylonjs/Materials/Textures/texture";
  61452. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61453. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  61454. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  61455. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  61456. import { IDisposable } from "babylonjs/scene";
  61457. import { SpotLight } from "babylonjs/Lights/spotLight";
  61458. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  61459. import { Scene } from "babylonjs/scene";
  61460. import { Animation } from "babylonjs/Animations/animation";
  61461. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  61462. import "babylonjs/Shaders/standard.fragment";
  61463. /**
  61464. * Standard rendering pipeline
  61465. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  61466. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  61467. */
  61468. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  61469. /**
  61470. * Public members
  61471. */
  61472. /**
  61473. * Post-process which contains the original scene color before the pipeline applies all the effects
  61474. */
  61475. originalPostProcess: Nullable<PostProcess>;
  61476. /**
  61477. * Post-process used to down scale an image x4
  61478. */
  61479. downSampleX4PostProcess: Nullable<PostProcess>;
  61480. /**
  61481. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  61482. */
  61483. brightPassPostProcess: Nullable<PostProcess>;
  61484. /**
  61485. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  61486. */
  61487. blurHPostProcesses: PostProcess[];
  61488. /**
  61489. * Post-process array storing all the vertical blur post-processes used by the pipeline
  61490. */
  61491. blurVPostProcesses: PostProcess[];
  61492. /**
  61493. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  61494. */
  61495. textureAdderPostProcess: Nullable<PostProcess>;
  61496. /**
  61497. * Post-process used to create volumetric lighting effect
  61498. */
  61499. volumetricLightPostProcess: Nullable<PostProcess>;
  61500. /**
  61501. * Post-process used to smooth the previous volumetric light post-process on the X axis
  61502. */
  61503. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  61504. /**
  61505. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  61506. */
  61507. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  61508. /**
  61509. * Post-process used to merge the volumetric light effect and the real scene color
  61510. */
  61511. volumetricLightMergePostProces: Nullable<PostProcess>;
  61512. /**
  61513. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  61514. */
  61515. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  61516. /**
  61517. * Base post-process used to calculate the average luminance of the final image for HDR
  61518. */
  61519. luminancePostProcess: Nullable<PostProcess>;
  61520. /**
  61521. * Post-processes used to create down sample post-processes in order to get
  61522. * the average luminance of the final image for HDR
  61523. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  61524. */
  61525. luminanceDownSamplePostProcesses: PostProcess[];
  61526. /**
  61527. * Post-process used to create a HDR effect (light adaptation)
  61528. */
  61529. hdrPostProcess: Nullable<PostProcess>;
  61530. /**
  61531. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  61532. */
  61533. textureAdderFinalPostProcess: Nullable<PostProcess>;
  61534. /**
  61535. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  61536. */
  61537. lensFlareFinalPostProcess: Nullable<PostProcess>;
  61538. /**
  61539. * Post-process used to merge the final HDR post-process and the real scene color
  61540. */
  61541. hdrFinalPostProcess: Nullable<PostProcess>;
  61542. /**
  61543. * Post-process used to create a lens flare effect
  61544. */
  61545. lensFlarePostProcess: Nullable<PostProcess>;
  61546. /**
  61547. * Post-process that merges the result of the lens flare post-process and the real scene color
  61548. */
  61549. lensFlareComposePostProcess: Nullable<PostProcess>;
  61550. /**
  61551. * Post-process used to create a motion blur effect
  61552. */
  61553. motionBlurPostProcess: Nullable<PostProcess>;
  61554. /**
  61555. * Post-process used to create a depth of field effect
  61556. */
  61557. depthOfFieldPostProcess: Nullable<PostProcess>;
  61558. /**
  61559. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  61560. */
  61561. fxaaPostProcess: Nullable<FxaaPostProcess>;
  61562. /**
  61563. * Represents the brightness threshold in order to configure the illuminated surfaces
  61564. */
  61565. brightThreshold: number;
  61566. /**
  61567. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  61568. */
  61569. blurWidth: number;
  61570. /**
  61571. * Sets if the blur for highlighted surfaces must be only horizontal
  61572. */
  61573. horizontalBlur: boolean;
  61574. /**
  61575. * Gets the overall exposure used by the pipeline
  61576. */
  61577. /**
  61578. * Sets the overall exposure used by the pipeline
  61579. */
  61580. exposure: number;
  61581. /**
  61582. * Texture used typically to simulate "dirty" on camera lens
  61583. */
  61584. lensTexture: Nullable<Texture>;
  61585. /**
  61586. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  61587. */
  61588. volumetricLightCoefficient: number;
  61589. /**
  61590. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  61591. */
  61592. volumetricLightPower: number;
  61593. /**
  61594. * Used the set the blur intensity to smooth the volumetric lights
  61595. */
  61596. volumetricLightBlurScale: number;
  61597. /**
  61598. * Light (spot or directional) used to generate the volumetric lights rays
  61599. * The source light must have a shadow generate so the pipeline can get its
  61600. * depth map
  61601. */
  61602. sourceLight: Nullable<SpotLight | DirectionalLight>;
  61603. /**
  61604. * For eye adaptation, represents the minimum luminance the eye can see
  61605. */
  61606. hdrMinimumLuminance: number;
  61607. /**
  61608. * For eye adaptation, represents the decrease luminance speed
  61609. */
  61610. hdrDecreaseRate: number;
  61611. /**
  61612. * For eye adaptation, represents the increase luminance speed
  61613. */
  61614. hdrIncreaseRate: number;
  61615. /**
  61616. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  61617. */
  61618. /**
  61619. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  61620. */
  61621. hdrAutoExposure: boolean;
  61622. /**
  61623. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  61624. */
  61625. lensColorTexture: Nullable<Texture>;
  61626. /**
  61627. * The overall strengh for the lens flare effect
  61628. */
  61629. lensFlareStrength: number;
  61630. /**
  61631. * Dispersion coefficient for lens flare ghosts
  61632. */
  61633. lensFlareGhostDispersal: number;
  61634. /**
  61635. * Main lens flare halo width
  61636. */
  61637. lensFlareHaloWidth: number;
  61638. /**
  61639. * Based on the lens distortion effect, defines how much the lens flare result
  61640. * is distorted
  61641. */
  61642. lensFlareDistortionStrength: number;
  61643. /**
  61644. * Lens star texture must be used to simulate rays on the flares and is available
  61645. * in the documentation
  61646. */
  61647. lensStarTexture: Nullable<Texture>;
  61648. /**
  61649. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  61650. * flare effect by taking account of the dirt texture
  61651. */
  61652. lensFlareDirtTexture: Nullable<Texture>;
  61653. /**
  61654. * Represents the focal length for the depth of field effect
  61655. */
  61656. depthOfFieldDistance: number;
  61657. /**
  61658. * Represents the blur intensity for the blurred part of the depth of field effect
  61659. */
  61660. depthOfFieldBlurWidth: number;
  61661. /**
  61662. * Gets how much the image is blurred by the movement while using the motion blur post-process
  61663. */
  61664. /**
  61665. * Sets how much the image is blurred by the movement while using the motion blur post-process
  61666. */
  61667. motionStrength: number;
  61668. /**
  61669. * Gets wether or not the motion blur post-process is object based or screen based.
  61670. */
  61671. /**
  61672. * Sets wether or not the motion blur post-process should be object based or screen based
  61673. */
  61674. objectBasedMotionBlur: boolean;
  61675. /**
  61676. * List of animations for the pipeline (IAnimatable implementation)
  61677. */
  61678. animations: Animation[];
  61679. /**
  61680. * Private members
  61681. */
  61682. private _scene;
  61683. private _currentDepthOfFieldSource;
  61684. private _basePostProcess;
  61685. private _fixedExposure;
  61686. private _currentExposure;
  61687. private _hdrAutoExposure;
  61688. private _hdrCurrentLuminance;
  61689. private _motionStrength;
  61690. private _isObjectBasedMotionBlur;
  61691. private _floatTextureType;
  61692. private _ratio;
  61693. private _bloomEnabled;
  61694. private _depthOfFieldEnabled;
  61695. private _vlsEnabled;
  61696. private _lensFlareEnabled;
  61697. private _hdrEnabled;
  61698. private _motionBlurEnabled;
  61699. private _fxaaEnabled;
  61700. private _motionBlurSamples;
  61701. private _volumetricLightStepsCount;
  61702. private _samples;
  61703. /**
  61704. * @ignore
  61705. * Specifies if the bloom pipeline is enabled
  61706. */
  61707. BloomEnabled: boolean;
  61708. /**
  61709. * @ignore
  61710. * Specifies if the depth of field pipeline is enabed
  61711. */
  61712. DepthOfFieldEnabled: boolean;
  61713. /**
  61714. * @ignore
  61715. * Specifies if the lens flare pipeline is enabed
  61716. */
  61717. LensFlareEnabled: boolean;
  61718. /**
  61719. * @ignore
  61720. * Specifies if the HDR pipeline is enabled
  61721. */
  61722. HDREnabled: boolean;
  61723. /**
  61724. * @ignore
  61725. * Specifies if the volumetric lights scattering effect is enabled
  61726. */
  61727. VLSEnabled: boolean;
  61728. /**
  61729. * @ignore
  61730. * Specifies if the motion blur effect is enabled
  61731. */
  61732. MotionBlurEnabled: boolean;
  61733. /**
  61734. * Specifies if anti-aliasing is enabled
  61735. */
  61736. fxaaEnabled: boolean;
  61737. /**
  61738. * Specifies the number of steps used to calculate the volumetric lights
  61739. * Typically in interval [50, 200]
  61740. */
  61741. volumetricLightStepsCount: number;
  61742. /**
  61743. * Specifies the number of samples used for the motion blur effect
  61744. * Typically in interval [16, 64]
  61745. */
  61746. motionBlurSamples: number;
  61747. /**
  61748. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  61749. */
  61750. samples: number;
  61751. /**
  61752. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  61753. * @constructor
  61754. * @param name The rendering pipeline name
  61755. * @param scene The scene linked to this pipeline
  61756. * @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)
  61757. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  61758. * @param cameras The array of cameras that the rendering pipeline will be attached to
  61759. */
  61760. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  61761. private _buildPipeline;
  61762. private _createDownSampleX4PostProcess;
  61763. private _createBrightPassPostProcess;
  61764. private _createBlurPostProcesses;
  61765. private _createTextureAdderPostProcess;
  61766. private _createVolumetricLightPostProcess;
  61767. private _createLuminancePostProcesses;
  61768. private _createHdrPostProcess;
  61769. private _createLensFlarePostProcess;
  61770. private _createDepthOfFieldPostProcess;
  61771. private _createMotionBlurPostProcess;
  61772. private _getDepthTexture;
  61773. private _disposePostProcesses;
  61774. /**
  61775. * Dispose of the pipeline and stop all post processes
  61776. */
  61777. dispose(): void;
  61778. /**
  61779. * Serialize the rendering pipeline (Used when exporting)
  61780. * @returns the serialized object
  61781. */
  61782. serialize(): any;
  61783. /**
  61784. * Parse the serialized pipeline
  61785. * @param source Source pipeline.
  61786. * @param scene The scene to load the pipeline to.
  61787. * @param rootUrl The URL of the serialized pipeline.
  61788. * @returns An instantiated pipeline from the serialized object.
  61789. */
  61790. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  61791. /**
  61792. * Luminance steps
  61793. */
  61794. static LuminanceSteps: number;
  61795. }
  61796. }
  61797. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  61798. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  61799. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  61800. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  61801. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  61802. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  61803. }
  61804. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  61805. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  61806. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  61807. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  61808. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  61809. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  61810. }
  61811. declare module "babylonjs/Shaders/tonemap.fragment" {
  61812. /** @hidden */
  61813. export var tonemapPixelShader: {
  61814. name: string;
  61815. shader: string;
  61816. };
  61817. }
  61818. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  61819. import { Camera } from "babylonjs/Cameras/camera";
  61820. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61821. import "babylonjs/Shaders/tonemap.fragment";
  61822. import { Engine } from "babylonjs/Engines/engine";
  61823. /** Defines operator used for tonemapping */
  61824. export enum TonemappingOperator {
  61825. /** Hable */
  61826. Hable = 0,
  61827. /** Reinhard */
  61828. Reinhard = 1,
  61829. /** HejiDawson */
  61830. HejiDawson = 2,
  61831. /** Photographic */
  61832. Photographic = 3
  61833. }
  61834. /**
  61835. * Defines a post process to apply tone mapping
  61836. */
  61837. export class TonemapPostProcess extends PostProcess {
  61838. private _operator;
  61839. /** Defines the required exposure adjustement */
  61840. exposureAdjustment: number;
  61841. /**
  61842. * Creates a new TonemapPostProcess
  61843. * @param name defines the name of the postprocess
  61844. * @param _operator defines the operator to use
  61845. * @param exposureAdjustment defines the required exposure adjustement
  61846. * @param camera defines the camera to use (can be null)
  61847. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  61848. * @param engine defines the hosting engine (can be ignore if camera is set)
  61849. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  61850. */
  61851. constructor(name: string, _operator: TonemappingOperator,
  61852. /** Defines the required exposure adjustement */
  61853. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  61854. }
  61855. }
  61856. declare module "babylonjs/Shaders/depth.vertex" {
  61857. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61858. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61859. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61860. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61861. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61862. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61863. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61864. /** @hidden */
  61865. export var depthVertexShader: {
  61866. name: string;
  61867. shader: string;
  61868. };
  61869. }
  61870. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  61871. /** @hidden */
  61872. export var volumetricLightScatteringPixelShader: {
  61873. name: string;
  61874. shader: string;
  61875. };
  61876. }
  61877. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  61878. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61879. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61880. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61881. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61882. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61883. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61884. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61885. /** @hidden */
  61886. export var volumetricLightScatteringPassVertexShader: {
  61887. name: string;
  61888. shader: string;
  61889. };
  61890. }
  61891. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  61892. /** @hidden */
  61893. export var volumetricLightScatteringPassPixelShader: {
  61894. name: string;
  61895. shader: string;
  61896. };
  61897. }
  61898. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  61899. import { Vector3 } from "babylonjs/Maths/math.vector";
  61900. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61901. import { Mesh } from "babylonjs/Meshes/mesh";
  61902. import { Camera } from "babylonjs/Cameras/camera";
  61903. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61904. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61905. import { Scene } from "babylonjs/scene";
  61906. import "babylonjs/Meshes/Builders/planeBuilder";
  61907. import "babylonjs/Shaders/depth.vertex";
  61908. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  61909. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  61910. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  61911. import { Engine } from "babylonjs/Engines/engine";
  61912. /**
  61913. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  61914. */
  61915. export class VolumetricLightScatteringPostProcess extends PostProcess {
  61916. private _volumetricLightScatteringPass;
  61917. private _volumetricLightScatteringRTT;
  61918. private _viewPort;
  61919. private _screenCoordinates;
  61920. private _cachedDefines;
  61921. /**
  61922. * If not undefined, the mesh position is computed from the attached node position
  61923. */
  61924. attachedNode: {
  61925. position: Vector3;
  61926. };
  61927. /**
  61928. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  61929. */
  61930. customMeshPosition: Vector3;
  61931. /**
  61932. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  61933. */
  61934. useCustomMeshPosition: boolean;
  61935. /**
  61936. * If the post-process should inverse the light scattering direction
  61937. */
  61938. invert: boolean;
  61939. /**
  61940. * The internal mesh used by the post-process
  61941. */
  61942. mesh: Mesh;
  61943. /**
  61944. * @hidden
  61945. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  61946. */
  61947. useDiffuseColor: boolean;
  61948. /**
  61949. * Array containing the excluded meshes not rendered in the internal pass
  61950. */
  61951. excludedMeshes: AbstractMesh[];
  61952. /**
  61953. * Controls the overall intensity of the post-process
  61954. */
  61955. exposure: number;
  61956. /**
  61957. * Dissipates each sample's contribution in range [0, 1]
  61958. */
  61959. decay: number;
  61960. /**
  61961. * Controls the overall intensity of each sample
  61962. */
  61963. weight: number;
  61964. /**
  61965. * Controls the density of each sample
  61966. */
  61967. density: number;
  61968. /**
  61969. * @constructor
  61970. * @param name The post-process name
  61971. * @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)
  61972. * @param camera The camera that the post-process will be attached to
  61973. * @param mesh The mesh used to create the light scattering
  61974. * @param samples The post-process quality, default 100
  61975. * @param samplingModeThe post-process filtering mode
  61976. * @param engine The babylon engine
  61977. * @param reusable If the post-process is reusable
  61978. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  61979. */
  61980. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  61981. /**
  61982. * Returns the string "VolumetricLightScatteringPostProcess"
  61983. * @returns "VolumetricLightScatteringPostProcess"
  61984. */
  61985. getClassName(): string;
  61986. private _isReady;
  61987. /**
  61988. * Sets the new light position for light scattering effect
  61989. * @param position The new custom light position
  61990. */
  61991. setCustomMeshPosition(position: Vector3): void;
  61992. /**
  61993. * Returns the light position for light scattering effect
  61994. * @return Vector3 The custom light position
  61995. */
  61996. getCustomMeshPosition(): Vector3;
  61997. /**
  61998. * Disposes the internal assets and detaches the post-process from the camera
  61999. */
  62000. dispose(camera: Camera): void;
  62001. /**
  62002. * Returns the render target texture used by the post-process
  62003. * @return the render target texture used by the post-process
  62004. */
  62005. getPass(): RenderTargetTexture;
  62006. private _meshExcluded;
  62007. private _createPass;
  62008. private _updateMeshScreenCoordinates;
  62009. /**
  62010. * Creates a default mesh for the Volumeric Light Scattering post-process
  62011. * @param name The mesh name
  62012. * @param scene The scene where to create the mesh
  62013. * @return the default mesh
  62014. */
  62015. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  62016. }
  62017. }
  62018. declare module "babylonjs/PostProcesses/index" {
  62019. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  62020. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  62021. export * from "babylonjs/PostProcesses/bloomEffect";
  62022. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  62023. export * from "babylonjs/PostProcesses/blurPostProcess";
  62024. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  62025. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  62026. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  62027. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  62028. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  62029. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  62030. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  62031. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  62032. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  62033. export * from "babylonjs/PostProcesses/filterPostProcess";
  62034. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  62035. export * from "babylonjs/PostProcesses/grainPostProcess";
  62036. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  62037. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  62038. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  62039. export * from "babylonjs/PostProcesses/passPostProcess";
  62040. export * from "babylonjs/PostProcesses/postProcess";
  62041. export * from "babylonjs/PostProcesses/postProcessManager";
  62042. export * from "babylonjs/PostProcesses/refractionPostProcess";
  62043. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  62044. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  62045. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  62046. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  62047. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  62048. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  62049. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  62050. }
  62051. declare module "babylonjs/Probes/index" {
  62052. export * from "babylonjs/Probes/reflectionProbe";
  62053. }
  62054. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  62055. import { Scene } from "babylonjs/scene";
  62056. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62057. import { SmartArray } from "babylonjs/Misc/smartArray";
  62058. import { ISceneComponent } from "babylonjs/sceneComponent";
  62059. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  62060. import "babylonjs/Meshes/Builders/boxBuilder";
  62061. import "babylonjs/Shaders/color.fragment";
  62062. import "babylonjs/Shaders/color.vertex";
  62063. import { Color3 } from "babylonjs/Maths/math.color";
  62064. module "babylonjs/scene" {
  62065. interface Scene {
  62066. /** @hidden (Backing field) */
  62067. _boundingBoxRenderer: BoundingBoxRenderer;
  62068. /** @hidden (Backing field) */
  62069. _forceShowBoundingBoxes: boolean;
  62070. /**
  62071. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  62072. */
  62073. forceShowBoundingBoxes: boolean;
  62074. /**
  62075. * Gets the bounding box renderer associated with the scene
  62076. * @returns a BoundingBoxRenderer
  62077. */
  62078. getBoundingBoxRenderer(): BoundingBoxRenderer;
  62079. }
  62080. }
  62081. module "babylonjs/Meshes/abstractMesh" {
  62082. interface AbstractMesh {
  62083. /** @hidden (Backing field) */
  62084. _showBoundingBox: boolean;
  62085. /**
  62086. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  62087. */
  62088. showBoundingBox: boolean;
  62089. }
  62090. }
  62091. /**
  62092. * Component responsible of rendering the bounding box of the meshes in a scene.
  62093. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  62094. */
  62095. export class BoundingBoxRenderer implements ISceneComponent {
  62096. /**
  62097. * The component name helpfull to identify the component in the list of scene components.
  62098. */
  62099. readonly name: string;
  62100. /**
  62101. * The scene the component belongs to.
  62102. */
  62103. scene: Scene;
  62104. /**
  62105. * Color of the bounding box lines placed in front of an object
  62106. */
  62107. frontColor: Color3;
  62108. /**
  62109. * Color of the bounding box lines placed behind an object
  62110. */
  62111. backColor: Color3;
  62112. /**
  62113. * Defines if the renderer should show the back lines or not
  62114. */
  62115. showBackLines: boolean;
  62116. /**
  62117. * @hidden
  62118. */
  62119. renderList: SmartArray<BoundingBox>;
  62120. private _colorShader;
  62121. private _vertexBuffers;
  62122. private _indexBuffer;
  62123. private _fillIndexBuffer;
  62124. private _fillIndexData;
  62125. /**
  62126. * Instantiates a new bounding box renderer in a scene.
  62127. * @param scene the scene the renderer renders in
  62128. */
  62129. constructor(scene: Scene);
  62130. /**
  62131. * Registers the component in a given scene
  62132. */
  62133. register(): void;
  62134. private _evaluateSubMesh;
  62135. private _activeMesh;
  62136. private _prepareRessources;
  62137. private _createIndexBuffer;
  62138. /**
  62139. * Rebuilds the elements related to this component in case of
  62140. * context lost for instance.
  62141. */
  62142. rebuild(): void;
  62143. /**
  62144. * @hidden
  62145. */
  62146. reset(): void;
  62147. /**
  62148. * Render the bounding boxes of a specific rendering group
  62149. * @param renderingGroupId defines the rendering group to render
  62150. */
  62151. render(renderingGroupId: number): void;
  62152. /**
  62153. * In case of occlusion queries, we can render the occlusion bounding box through this method
  62154. * @param mesh Define the mesh to render the occlusion bounding box for
  62155. */
  62156. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  62157. /**
  62158. * Dispose and release the resources attached to this renderer.
  62159. */
  62160. dispose(): void;
  62161. }
  62162. }
  62163. declare module "babylonjs/Shaders/depth.fragment" {
  62164. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62165. /** @hidden */
  62166. export var depthPixelShader: {
  62167. name: string;
  62168. shader: string;
  62169. };
  62170. }
  62171. declare module "babylonjs/Rendering/depthRenderer" {
  62172. import { Nullable } from "babylonjs/types";
  62173. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62174. import { Scene } from "babylonjs/scene";
  62175. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62176. import { Camera } from "babylonjs/Cameras/camera";
  62177. import "babylonjs/Shaders/depth.fragment";
  62178. import "babylonjs/Shaders/depth.vertex";
  62179. /**
  62180. * This represents a depth renderer in Babylon.
  62181. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62182. */
  62183. export class DepthRenderer {
  62184. private _scene;
  62185. private _depthMap;
  62186. private _effect;
  62187. private readonly _storeNonLinearDepth;
  62188. private readonly _clearColor;
  62189. /** Get if the depth renderer is using packed depth or not */
  62190. readonly isPacked: boolean;
  62191. private _cachedDefines;
  62192. private _camera;
  62193. /**
  62194. * Specifiess that the depth renderer will only be used within
  62195. * the camera it is created for.
  62196. * This can help forcing its rendering during the camera processing.
  62197. */
  62198. useOnlyInActiveCamera: boolean;
  62199. /** @hidden */
  62200. static _SceneComponentInitialization: (scene: Scene) => void;
  62201. /**
  62202. * Instantiates a depth renderer
  62203. * @param scene The scene the renderer belongs to
  62204. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62205. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62206. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62207. */
  62208. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62209. /**
  62210. * Creates the depth rendering effect and checks if the effect is ready.
  62211. * @param subMesh The submesh to be used to render the depth map of
  62212. * @param useInstances If multiple world instances should be used
  62213. * @returns if the depth renderer is ready to render the depth map
  62214. */
  62215. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62216. /**
  62217. * Gets the texture which the depth map will be written to.
  62218. * @returns The depth map texture
  62219. */
  62220. getDepthMap(): RenderTargetTexture;
  62221. /**
  62222. * Disposes of the depth renderer.
  62223. */
  62224. dispose(): void;
  62225. }
  62226. }
  62227. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  62228. import { Nullable } from "babylonjs/types";
  62229. import { Scene } from "babylonjs/scene";
  62230. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62231. import { Camera } from "babylonjs/Cameras/camera";
  62232. import { ISceneComponent } from "babylonjs/sceneComponent";
  62233. module "babylonjs/scene" {
  62234. interface Scene {
  62235. /** @hidden (Backing field) */
  62236. _depthRenderer: {
  62237. [id: string]: DepthRenderer;
  62238. };
  62239. /**
  62240. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  62241. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  62242. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62243. * @returns the created depth renderer
  62244. */
  62245. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  62246. /**
  62247. * Disables a depth renderer for a given camera
  62248. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  62249. */
  62250. disableDepthRenderer(camera?: Nullable<Camera>): void;
  62251. }
  62252. }
  62253. /**
  62254. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  62255. * in several rendering techniques.
  62256. */
  62257. export class DepthRendererSceneComponent implements ISceneComponent {
  62258. /**
  62259. * The component name helpfull to identify the component in the list of scene components.
  62260. */
  62261. readonly name: string;
  62262. /**
  62263. * The scene the component belongs to.
  62264. */
  62265. scene: Scene;
  62266. /**
  62267. * Creates a new instance of the component for the given scene
  62268. * @param scene Defines the scene to register the component in
  62269. */
  62270. constructor(scene: Scene);
  62271. /**
  62272. * Registers the component in a given scene
  62273. */
  62274. register(): void;
  62275. /**
  62276. * Rebuilds the elements related to this component in case of
  62277. * context lost for instance.
  62278. */
  62279. rebuild(): void;
  62280. /**
  62281. * Disposes the component and the associated ressources
  62282. */
  62283. dispose(): void;
  62284. private _gatherRenderTargets;
  62285. private _gatherActiveCameraRenderTargets;
  62286. }
  62287. }
  62288. declare module "babylonjs/Shaders/outline.fragment" {
  62289. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  62290. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  62291. /** @hidden */
  62292. export var outlinePixelShader: {
  62293. name: string;
  62294. shader: string;
  62295. };
  62296. }
  62297. declare module "babylonjs/Shaders/outline.vertex" {
  62298. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62299. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62300. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62301. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62302. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  62303. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62304. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62305. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62306. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  62307. /** @hidden */
  62308. export var outlineVertexShader: {
  62309. name: string;
  62310. shader: string;
  62311. };
  62312. }
  62313. declare module "babylonjs/Rendering/outlineRenderer" {
  62314. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62315. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  62316. import { Scene } from "babylonjs/scene";
  62317. import { ISceneComponent } from "babylonjs/sceneComponent";
  62318. import "babylonjs/Shaders/outline.fragment";
  62319. import "babylonjs/Shaders/outline.vertex";
  62320. module "babylonjs/scene" {
  62321. interface Scene {
  62322. /** @hidden */
  62323. _outlineRenderer: OutlineRenderer;
  62324. /**
  62325. * Gets the outline renderer associated with the scene
  62326. * @returns a OutlineRenderer
  62327. */
  62328. getOutlineRenderer(): OutlineRenderer;
  62329. }
  62330. }
  62331. module "babylonjs/Meshes/abstractMesh" {
  62332. interface AbstractMesh {
  62333. /** @hidden (Backing field) */
  62334. _renderOutline: boolean;
  62335. /**
  62336. * Gets or sets a boolean indicating if the outline must be rendered as well
  62337. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  62338. */
  62339. renderOutline: boolean;
  62340. /** @hidden (Backing field) */
  62341. _renderOverlay: boolean;
  62342. /**
  62343. * Gets or sets a boolean indicating if the overlay must be rendered as well
  62344. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  62345. */
  62346. renderOverlay: boolean;
  62347. }
  62348. }
  62349. /**
  62350. * This class is responsible to draw bothe outline/overlay of meshes.
  62351. * It should not be used directly but through the available method on mesh.
  62352. */
  62353. export class OutlineRenderer implements ISceneComponent {
  62354. /**
  62355. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  62356. */
  62357. private static _StencilReference;
  62358. /**
  62359. * The name of the component. Each component must have a unique name.
  62360. */
  62361. name: string;
  62362. /**
  62363. * The scene the component belongs to.
  62364. */
  62365. scene: Scene;
  62366. /**
  62367. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  62368. */
  62369. zOffset: number;
  62370. private _engine;
  62371. private _effect;
  62372. private _cachedDefines;
  62373. private _savedDepthWrite;
  62374. /**
  62375. * Instantiates a new outline renderer. (There could be only one per scene).
  62376. * @param scene Defines the scene it belongs to
  62377. */
  62378. constructor(scene: Scene);
  62379. /**
  62380. * Register the component to one instance of a scene.
  62381. */
  62382. register(): void;
  62383. /**
  62384. * Rebuilds the elements related to this component in case of
  62385. * context lost for instance.
  62386. */
  62387. rebuild(): void;
  62388. /**
  62389. * Disposes the component and the associated ressources.
  62390. */
  62391. dispose(): void;
  62392. /**
  62393. * Renders the outline in the canvas.
  62394. * @param subMesh Defines the sumesh to render
  62395. * @param batch Defines the batch of meshes in case of instances
  62396. * @param useOverlay Defines if the rendering is for the overlay or the outline
  62397. */
  62398. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  62399. /**
  62400. * Returns whether or not the outline renderer is ready for a given submesh.
  62401. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  62402. * @param subMesh Defines the submesh to check readyness for
  62403. * @param useInstances Defines wheter wee are trying to render instances or not
  62404. * @returns true if ready otherwise false
  62405. */
  62406. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62407. private _beforeRenderingMesh;
  62408. private _afterRenderingMesh;
  62409. }
  62410. }
  62411. declare module "babylonjs/Rendering/index" {
  62412. export * from "babylonjs/Rendering/boundingBoxRenderer";
  62413. export * from "babylonjs/Rendering/depthRenderer";
  62414. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  62415. export * from "babylonjs/Rendering/edgesRenderer";
  62416. export * from "babylonjs/Rendering/geometryBufferRenderer";
  62417. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  62418. export * from "babylonjs/Rendering/outlineRenderer";
  62419. export * from "babylonjs/Rendering/renderingGroup";
  62420. export * from "babylonjs/Rendering/renderingManager";
  62421. export * from "babylonjs/Rendering/utilityLayerRenderer";
  62422. }
  62423. declare module "babylonjs/Sprites/index" {
  62424. export * from "babylonjs/Sprites/sprite";
  62425. export * from "babylonjs/Sprites/spriteManager";
  62426. export * from "babylonjs/Sprites/spriteSceneComponent";
  62427. }
  62428. declare module "babylonjs/Misc/assetsManager" {
  62429. import { Scene } from "babylonjs/scene";
  62430. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62431. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62432. import { Skeleton } from "babylonjs/Bones/skeleton";
  62433. import { Observable } from "babylonjs/Misc/observable";
  62434. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62435. import { Texture } from "babylonjs/Materials/Textures/texture";
  62436. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  62437. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  62438. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  62439. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  62440. /**
  62441. * Defines the list of states available for a task inside a AssetsManager
  62442. */
  62443. export enum AssetTaskState {
  62444. /**
  62445. * Initialization
  62446. */
  62447. INIT = 0,
  62448. /**
  62449. * Running
  62450. */
  62451. RUNNING = 1,
  62452. /**
  62453. * Done
  62454. */
  62455. DONE = 2,
  62456. /**
  62457. * Error
  62458. */
  62459. ERROR = 3
  62460. }
  62461. /**
  62462. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  62463. */
  62464. export abstract class AbstractAssetTask {
  62465. /**
  62466. * Task name
  62467. */ name: string;
  62468. /**
  62469. * Callback called when the task is successful
  62470. */
  62471. onSuccess: (task: any) => void;
  62472. /**
  62473. * Callback called when the task is not successful
  62474. */
  62475. onError: (task: any, message?: string, exception?: any) => void;
  62476. /**
  62477. * Creates a new AssetsManager
  62478. * @param name defines the name of the task
  62479. */
  62480. constructor(
  62481. /**
  62482. * Task name
  62483. */ name: string);
  62484. private _isCompleted;
  62485. private _taskState;
  62486. private _errorObject;
  62487. /**
  62488. * Get if the task is completed
  62489. */
  62490. readonly isCompleted: boolean;
  62491. /**
  62492. * Gets the current state of the task
  62493. */
  62494. readonly taskState: AssetTaskState;
  62495. /**
  62496. * Gets the current error object (if task is in error)
  62497. */
  62498. readonly errorObject: {
  62499. message?: string;
  62500. exception?: any;
  62501. };
  62502. /**
  62503. * Internal only
  62504. * @hidden
  62505. */
  62506. _setErrorObject(message?: string, exception?: any): void;
  62507. /**
  62508. * Execute the current task
  62509. * @param scene defines the scene where you want your assets to be loaded
  62510. * @param onSuccess is a callback called when the task is successfully executed
  62511. * @param onError is a callback called if an error occurs
  62512. */
  62513. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62514. /**
  62515. * Execute the current task
  62516. * @param scene defines the scene where you want your assets to be loaded
  62517. * @param onSuccess is a callback called when the task is successfully executed
  62518. * @param onError is a callback called if an error occurs
  62519. */
  62520. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62521. /**
  62522. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  62523. * This can be used with failed tasks that have the reason for failure fixed.
  62524. */
  62525. reset(): void;
  62526. private onErrorCallback;
  62527. private onDoneCallback;
  62528. }
  62529. /**
  62530. * Define the interface used by progress events raised during assets loading
  62531. */
  62532. export interface IAssetsProgressEvent {
  62533. /**
  62534. * Defines the number of remaining tasks to process
  62535. */
  62536. remainingCount: number;
  62537. /**
  62538. * Defines the total number of tasks
  62539. */
  62540. totalCount: number;
  62541. /**
  62542. * Defines the task that was just processed
  62543. */
  62544. task: AbstractAssetTask;
  62545. }
  62546. /**
  62547. * Class used to share progress information about assets loading
  62548. */
  62549. export class AssetsProgressEvent implements IAssetsProgressEvent {
  62550. /**
  62551. * Defines the number of remaining tasks to process
  62552. */
  62553. remainingCount: number;
  62554. /**
  62555. * Defines the total number of tasks
  62556. */
  62557. totalCount: number;
  62558. /**
  62559. * Defines the task that was just processed
  62560. */
  62561. task: AbstractAssetTask;
  62562. /**
  62563. * Creates a AssetsProgressEvent
  62564. * @param remainingCount defines the number of remaining tasks to process
  62565. * @param totalCount defines the total number of tasks
  62566. * @param task defines the task that was just processed
  62567. */
  62568. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  62569. }
  62570. /**
  62571. * Define a task used by AssetsManager to load meshes
  62572. */
  62573. export class MeshAssetTask extends AbstractAssetTask {
  62574. /**
  62575. * Defines the name of the task
  62576. */
  62577. name: string;
  62578. /**
  62579. * Defines the list of mesh's names you want to load
  62580. */
  62581. meshesNames: any;
  62582. /**
  62583. * Defines the root url to use as a base to load your meshes and associated resources
  62584. */
  62585. rootUrl: string;
  62586. /**
  62587. * Defines the filename of the scene to load from
  62588. */
  62589. sceneFilename: string;
  62590. /**
  62591. * Gets the list of loaded meshes
  62592. */
  62593. loadedMeshes: Array<AbstractMesh>;
  62594. /**
  62595. * Gets the list of loaded particle systems
  62596. */
  62597. loadedParticleSystems: Array<IParticleSystem>;
  62598. /**
  62599. * Gets the list of loaded skeletons
  62600. */
  62601. loadedSkeletons: Array<Skeleton>;
  62602. /**
  62603. * Gets the list of loaded animation groups
  62604. */
  62605. loadedAnimationGroups: Array<AnimationGroup>;
  62606. /**
  62607. * Callback called when the task is successful
  62608. */
  62609. onSuccess: (task: MeshAssetTask) => void;
  62610. /**
  62611. * Callback called when the task is successful
  62612. */
  62613. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  62614. /**
  62615. * Creates a new MeshAssetTask
  62616. * @param name defines the name of the task
  62617. * @param meshesNames defines the list of mesh's names you want to load
  62618. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  62619. * @param sceneFilename defines the filename of the scene to load from
  62620. */
  62621. constructor(
  62622. /**
  62623. * Defines the name of the task
  62624. */
  62625. name: string,
  62626. /**
  62627. * Defines the list of mesh's names you want to load
  62628. */
  62629. meshesNames: any,
  62630. /**
  62631. * Defines the root url to use as a base to load your meshes and associated resources
  62632. */
  62633. rootUrl: string,
  62634. /**
  62635. * Defines the filename of the scene to load from
  62636. */
  62637. sceneFilename: string);
  62638. /**
  62639. * Execute the current task
  62640. * @param scene defines the scene where you want your assets to be loaded
  62641. * @param onSuccess is a callback called when the task is successfully executed
  62642. * @param onError is a callback called if an error occurs
  62643. */
  62644. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62645. }
  62646. /**
  62647. * Define a task used by AssetsManager to load text content
  62648. */
  62649. export class TextFileAssetTask extends AbstractAssetTask {
  62650. /**
  62651. * Defines the name of the task
  62652. */
  62653. name: string;
  62654. /**
  62655. * Defines the location of the file to load
  62656. */
  62657. url: string;
  62658. /**
  62659. * Gets the loaded text string
  62660. */
  62661. text: string;
  62662. /**
  62663. * Callback called when the task is successful
  62664. */
  62665. onSuccess: (task: TextFileAssetTask) => void;
  62666. /**
  62667. * Callback called when the task is successful
  62668. */
  62669. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  62670. /**
  62671. * Creates a new TextFileAssetTask object
  62672. * @param name defines the name of the task
  62673. * @param url defines the location of the file to load
  62674. */
  62675. constructor(
  62676. /**
  62677. * Defines the name of the task
  62678. */
  62679. name: string,
  62680. /**
  62681. * Defines the location of the file to load
  62682. */
  62683. url: string);
  62684. /**
  62685. * Execute the current task
  62686. * @param scene defines the scene where you want your assets to be loaded
  62687. * @param onSuccess is a callback called when the task is successfully executed
  62688. * @param onError is a callback called if an error occurs
  62689. */
  62690. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62691. }
  62692. /**
  62693. * Define a task used by AssetsManager to load binary data
  62694. */
  62695. export class BinaryFileAssetTask extends AbstractAssetTask {
  62696. /**
  62697. * Defines the name of the task
  62698. */
  62699. name: string;
  62700. /**
  62701. * Defines the location of the file to load
  62702. */
  62703. url: string;
  62704. /**
  62705. * Gets the lodaded data (as an array buffer)
  62706. */
  62707. data: ArrayBuffer;
  62708. /**
  62709. * Callback called when the task is successful
  62710. */
  62711. onSuccess: (task: BinaryFileAssetTask) => void;
  62712. /**
  62713. * Callback called when the task is successful
  62714. */
  62715. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  62716. /**
  62717. * Creates a new BinaryFileAssetTask object
  62718. * @param name defines the name of the new task
  62719. * @param url defines the location of the file to load
  62720. */
  62721. constructor(
  62722. /**
  62723. * Defines the name of the task
  62724. */
  62725. name: string,
  62726. /**
  62727. * Defines the location of the file to load
  62728. */
  62729. url: string);
  62730. /**
  62731. * Execute the current task
  62732. * @param scene defines the scene where you want your assets to be loaded
  62733. * @param onSuccess is a callback called when the task is successfully executed
  62734. * @param onError is a callback called if an error occurs
  62735. */
  62736. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62737. }
  62738. /**
  62739. * Define a task used by AssetsManager to load images
  62740. */
  62741. export class ImageAssetTask extends AbstractAssetTask {
  62742. /**
  62743. * Defines the name of the task
  62744. */
  62745. name: string;
  62746. /**
  62747. * Defines the location of the image to load
  62748. */
  62749. url: string;
  62750. /**
  62751. * Gets the loaded images
  62752. */
  62753. image: HTMLImageElement;
  62754. /**
  62755. * Callback called when the task is successful
  62756. */
  62757. onSuccess: (task: ImageAssetTask) => void;
  62758. /**
  62759. * Callback called when the task is successful
  62760. */
  62761. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  62762. /**
  62763. * Creates a new ImageAssetTask
  62764. * @param name defines the name of the task
  62765. * @param url defines the location of the image to load
  62766. */
  62767. constructor(
  62768. /**
  62769. * Defines the name of the task
  62770. */
  62771. name: string,
  62772. /**
  62773. * Defines the location of the image to load
  62774. */
  62775. url: string);
  62776. /**
  62777. * Execute the current task
  62778. * @param scene defines the scene where you want your assets to be loaded
  62779. * @param onSuccess is a callback called when the task is successfully executed
  62780. * @param onError is a callback called if an error occurs
  62781. */
  62782. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62783. }
  62784. /**
  62785. * Defines the interface used by texture loading tasks
  62786. */
  62787. export interface ITextureAssetTask<TEX extends BaseTexture> {
  62788. /**
  62789. * Gets the loaded texture
  62790. */
  62791. texture: TEX;
  62792. }
  62793. /**
  62794. * Define a task used by AssetsManager to load 2D textures
  62795. */
  62796. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  62797. /**
  62798. * Defines the name of the task
  62799. */
  62800. name: string;
  62801. /**
  62802. * Defines the location of the file to load
  62803. */
  62804. url: string;
  62805. /**
  62806. * Defines if mipmap should not be generated (default is false)
  62807. */
  62808. noMipmap?: boolean | undefined;
  62809. /**
  62810. * Defines if texture must be inverted on Y axis (default is false)
  62811. */
  62812. invertY?: boolean | undefined;
  62813. /**
  62814. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  62815. */
  62816. samplingMode: number;
  62817. /**
  62818. * Gets the loaded texture
  62819. */
  62820. texture: Texture;
  62821. /**
  62822. * Callback called when the task is successful
  62823. */
  62824. onSuccess: (task: TextureAssetTask) => void;
  62825. /**
  62826. * Callback called when the task is successful
  62827. */
  62828. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  62829. /**
  62830. * Creates a new TextureAssetTask object
  62831. * @param name defines the name of the task
  62832. * @param url defines the location of the file to load
  62833. * @param noMipmap defines if mipmap should not be generated (default is false)
  62834. * @param invertY defines if texture must be inverted on Y axis (default is false)
  62835. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  62836. */
  62837. constructor(
  62838. /**
  62839. * Defines the name of the task
  62840. */
  62841. name: string,
  62842. /**
  62843. * Defines the location of the file to load
  62844. */
  62845. url: string,
  62846. /**
  62847. * Defines if mipmap should not be generated (default is false)
  62848. */
  62849. noMipmap?: boolean | undefined,
  62850. /**
  62851. * Defines if texture must be inverted on Y axis (default is false)
  62852. */
  62853. invertY?: boolean | undefined,
  62854. /**
  62855. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  62856. */
  62857. samplingMode?: number);
  62858. /**
  62859. * Execute the current task
  62860. * @param scene defines the scene where you want your assets to be loaded
  62861. * @param onSuccess is a callback called when the task is successfully executed
  62862. * @param onError is a callback called if an error occurs
  62863. */
  62864. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62865. }
  62866. /**
  62867. * Define a task used by AssetsManager to load cube textures
  62868. */
  62869. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  62870. /**
  62871. * Defines the name of the task
  62872. */
  62873. name: string;
  62874. /**
  62875. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  62876. */
  62877. url: string;
  62878. /**
  62879. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  62880. */
  62881. extensions?: string[] | undefined;
  62882. /**
  62883. * Defines if mipmaps should not be generated (default is false)
  62884. */
  62885. noMipmap?: boolean | undefined;
  62886. /**
  62887. * Defines the explicit list of files (undefined by default)
  62888. */
  62889. files?: string[] | undefined;
  62890. /**
  62891. * Gets the loaded texture
  62892. */
  62893. texture: CubeTexture;
  62894. /**
  62895. * Callback called when the task is successful
  62896. */
  62897. onSuccess: (task: CubeTextureAssetTask) => void;
  62898. /**
  62899. * Callback called when the task is successful
  62900. */
  62901. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  62902. /**
  62903. * Creates a new CubeTextureAssetTask
  62904. * @param name defines the name of the task
  62905. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  62906. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  62907. * @param noMipmap defines if mipmaps should not be generated (default is false)
  62908. * @param files defines the explicit list of files (undefined by default)
  62909. */
  62910. constructor(
  62911. /**
  62912. * Defines the name of the task
  62913. */
  62914. name: string,
  62915. /**
  62916. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  62917. */
  62918. url: string,
  62919. /**
  62920. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  62921. */
  62922. extensions?: string[] | undefined,
  62923. /**
  62924. * Defines if mipmaps should not be generated (default is false)
  62925. */
  62926. noMipmap?: boolean | undefined,
  62927. /**
  62928. * Defines the explicit list of files (undefined by default)
  62929. */
  62930. files?: string[] | undefined);
  62931. /**
  62932. * Execute the current task
  62933. * @param scene defines the scene where you want your assets to be loaded
  62934. * @param onSuccess is a callback called when the task is successfully executed
  62935. * @param onError is a callback called if an error occurs
  62936. */
  62937. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  62938. }
  62939. /**
  62940. * Define a task used by AssetsManager to load HDR cube textures
  62941. */
  62942. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  62943. /**
  62944. * Defines the name of the task
  62945. */
  62946. name: string;
  62947. /**
  62948. * Defines the location of the file to load
  62949. */
  62950. url: string;
  62951. /**
  62952. * Defines the desired size (the more it increases the longer the generation will be)
  62953. */
  62954. size: number;
  62955. /**
  62956. * Defines if mipmaps should not be generated (default is false)
  62957. */
  62958. noMipmap: boolean;
  62959. /**
  62960. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  62961. */
  62962. generateHarmonics: boolean;
  62963. /**
  62964. * 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)
  62965. */
  62966. gammaSpace: boolean;
  62967. /**
  62968. * Internal Use Only
  62969. */
  62970. reserved: boolean;
  62971. /**
  62972. * Gets the loaded texture
  62973. */
  62974. texture: HDRCubeTexture;
  62975. /**
  62976. * Callback called when the task is successful
  62977. */
  62978. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  62979. /**
  62980. * Callback called when the task is successful
  62981. */
  62982. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  62983. /**
  62984. * Creates a new HDRCubeTextureAssetTask object
  62985. * @param name defines the name of the task
  62986. * @param url defines the location of the file to load
  62987. * @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.
  62988. * @param noMipmap defines if mipmaps should not be generated (default is false)
  62989. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  62990. * @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)
  62991. * @param reserved Internal use only
  62992. */
  62993. constructor(
  62994. /**
  62995. * Defines the name of the task
  62996. */
  62997. name: string,
  62998. /**
  62999. * Defines the location of the file to load
  63000. */
  63001. url: string,
  63002. /**
  63003. * Defines the desired size (the more it increases the longer the generation will be)
  63004. */
  63005. size: number,
  63006. /**
  63007. * Defines if mipmaps should not be generated (default is false)
  63008. */
  63009. noMipmap?: boolean,
  63010. /**
  63011. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  63012. */
  63013. generateHarmonics?: boolean,
  63014. /**
  63015. * 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)
  63016. */
  63017. gammaSpace?: boolean,
  63018. /**
  63019. * Internal Use Only
  63020. */
  63021. reserved?: boolean);
  63022. /**
  63023. * Execute the current task
  63024. * @param scene defines the scene where you want your assets to be loaded
  63025. * @param onSuccess is a callback called when the task is successfully executed
  63026. * @param onError is a callback called if an error occurs
  63027. */
  63028. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  63029. }
  63030. /**
  63031. * Define a task used by AssetsManager to load Equirectangular cube textures
  63032. */
  63033. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  63034. /**
  63035. * Defines the name of the task
  63036. */
  63037. name: string;
  63038. /**
  63039. * Defines the location of the file to load
  63040. */
  63041. url: string;
  63042. /**
  63043. * Defines the desired size (the more it increases the longer the generation will be)
  63044. */
  63045. size: number;
  63046. /**
  63047. * Defines if mipmaps should not be generated (default is false)
  63048. */
  63049. noMipmap: boolean;
  63050. /**
  63051. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  63052. * but the standard material would require them in Gamma space) (default is true)
  63053. */
  63054. gammaSpace: boolean;
  63055. /**
  63056. * Gets the loaded texture
  63057. */
  63058. texture: EquiRectangularCubeTexture;
  63059. /**
  63060. * Callback called when the task is successful
  63061. */
  63062. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  63063. /**
  63064. * Callback called when the task is successful
  63065. */
  63066. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  63067. /**
  63068. * Creates a new EquiRectangularCubeTextureAssetTask object
  63069. * @param name defines the name of the task
  63070. * @param url defines the location of the file to load
  63071. * @param size defines the desired size (the more it increases the longer the generation will be)
  63072. * If the size is omitted this implies you are using a preprocessed cubemap.
  63073. * @param noMipmap defines if mipmaps should not be generated (default is false)
  63074. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  63075. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  63076. * (default is true)
  63077. */
  63078. constructor(
  63079. /**
  63080. * Defines the name of the task
  63081. */
  63082. name: string,
  63083. /**
  63084. * Defines the location of the file to load
  63085. */
  63086. url: string,
  63087. /**
  63088. * Defines the desired size (the more it increases the longer the generation will be)
  63089. */
  63090. size: number,
  63091. /**
  63092. * Defines if mipmaps should not be generated (default is false)
  63093. */
  63094. noMipmap?: boolean,
  63095. /**
  63096. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  63097. * but the standard material would require them in Gamma space) (default is true)
  63098. */
  63099. gammaSpace?: boolean);
  63100. /**
  63101. * Execute the current task
  63102. * @param scene defines the scene where you want your assets to be loaded
  63103. * @param onSuccess is a callback called when the task is successfully executed
  63104. * @param onError is a callback called if an error occurs
  63105. */
  63106. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  63107. }
  63108. /**
  63109. * This class can be used to easily import assets into a scene
  63110. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  63111. */
  63112. export class AssetsManager {
  63113. private _scene;
  63114. private _isLoading;
  63115. protected _tasks: AbstractAssetTask[];
  63116. protected _waitingTasksCount: number;
  63117. protected _totalTasksCount: number;
  63118. /**
  63119. * Callback called when all tasks are processed
  63120. */
  63121. onFinish: (tasks: AbstractAssetTask[]) => void;
  63122. /**
  63123. * Callback called when a task is successful
  63124. */
  63125. onTaskSuccess: (task: AbstractAssetTask) => void;
  63126. /**
  63127. * Callback called when a task had an error
  63128. */
  63129. onTaskError: (task: AbstractAssetTask) => void;
  63130. /**
  63131. * Callback called when a task is done (whatever the result is)
  63132. */
  63133. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  63134. /**
  63135. * Observable called when all tasks are processed
  63136. */
  63137. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  63138. /**
  63139. * Observable called when a task had an error
  63140. */
  63141. onTaskErrorObservable: Observable<AbstractAssetTask>;
  63142. /**
  63143. * Observable called when all tasks were executed
  63144. */
  63145. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  63146. /**
  63147. * Observable called when a task is done (whatever the result is)
  63148. */
  63149. onProgressObservable: Observable<IAssetsProgressEvent>;
  63150. /**
  63151. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  63152. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  63153. */
  63154. useDefaultLoadingScreen: boolean;
  63155. /**
  63156. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  63157. * when all assets have been downloaded.
  63158. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  63159. */
  63160. autoHideLoadingUI: boolean;
  63161. /**
  63162. * Creates a new AssetsManager
  63163. * @param scene defines the scene to work on
  63164. */
  63165. constructor(scene: Scene);
  63166. /**
  63167. * Add a MeshAssetTask to the list of active tasks
  63168. * @param taskName defines the name of the new task
  63169. * @param meshesNames defines the name of meshes to load
  63170. * @param rootUrl defines the root url to use to locate files
  63171. * @param sceneFilename defines the filename of the scene file
  63172. * @returns a new MeshAssetTask object
  63173. */
  63174. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  63175. /**
  63176. * Add a TextFileAssetTask to the list of active tasks
  63177. * @param taskName defines the name of the new task
  63178. * @param url defines the url of the file to load
  63179. * @returns a new TextFileAssetTask object
  63180. */
  63181. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  63182. /**
  63183. * Add a BinaryFileAssetTask to the list of active tasks
  63184. * @param taskName defines the name of the new task
  63185. * @param url defines the url of the file to load
  63186. * @returns a new BinaryFileAssetTask object
  63187. */
  63188. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  63189. /**
  63190. * Add a ImageAssetTask to the list of active tasks
  63191. * @param taskName defines the name of the new task
  63192. * @param url defines the url of the file to load
  63193. * @returns a new ImageAssetTask object
  63194. */
  63195. addImageTask(taskName: string, url: string): ImageAssetTask;
  63196. /**
  63197. * Add a TextureAssetTask to the list of active tasks
  63198. * @param taskName defines the name of the new task
  63199. * @param url defines the url of the file to load
  63200. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  63201. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  63202. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  63203. * @returns a new TextureAssetTask object
  63204. */
  63205. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  63206. /**
  63207. * Add a CubeTextureAssetTask to the list of active tasks
  63208. * @param taskName defines the name of the new task
  63209. * @param url defines the url of the file to load
  63210. * @param extensions defines the extension to use to load the cube map (can be null)
  63211. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  63212. * @param files defines the list of files to load (can be null)
  63213. * @returns a new CubeTextureAssetTask object
  63214. */
  63215. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  63216. /**
  63217. *
  63218. * Add a HDRCubeTextureAssetTask to the list of active tasks
  63219. * @param taskName defines the name of the new task
  63220. * @param url defines the url of the file to load
  63221. * @param size defines the size you want for the cubemap (can be null)
  63222. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  63223. * @param generateHarmonics defines if you want to automatically generate (true by default)
  63224. * @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)
  63225. * @param reserved Internal use only
  63226. * @returns a new HDRCubeTextureAssetTask object
  63227. */
  63228. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  63229. /**
  63230. *
  63231. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  63232. * @param taskName defines the name of the new task
  63233. * @param url defines the url of the file to load
  63234. * @param size defines the size you want for the cubemap (can be null)
  63235. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  63236. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  63237. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  63238. * @returns a new EquiRectangularCubeTextureAssetTask object
  63239. */
  63240. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  63241. /**
  63242. * Remove a task from the assets manager.
  63243. * @param task the task to remove
  63244. */
  63245. removeTask(task: AbstractAssetTask): void;
  63246. private _decreaseWaitingTasksCount;
  63247. private _runTask;
  63248. /**
  63249. * Reset the AssetsManager and remove all tasks
  63250. * @return the current instance of the AssetsManager
  63251. */
  63252. reset(): AssetsManager;
  63253. /**
  63254. * Start the loading process
  63255. * @return the current instance of the AssetsManager
  63256. */
  63257. load(): AssetsManager;
  63258. /**
  63259. * Start the loading process as an async operation
  63260. * @return a promise returning the list of failed tasks
  63261. */
  63262. loadAsync(): Promise<void>;
  63263. }
  63264. }
  63265. declare module "babylonjs/Misc/deferred" {
  63266. /**
  63267. * Wrapper class for promise with external resolve and reject.
  63268. */
  63269. export class Deferred<T> {
  63270. /**
  63271. * The promise associated with this deferred object.
  63272. */
  63273. readonly promise: Promise<T>;
  63274. private _resolve;
  63275. private _reject;
  63276. /**
  63277. * The resolve method of the promise associated with this deferred object.
  63278. */
  63279. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  63280. /**
  63281. * The reject method of the promise associated with this deferred object.
  63282. */
  63283. readonly reject: (reason?: any) => void;
  63284. /**
  63285. * Constructor for this deferred object.
  63286. */
  63287. constructor();
  63288. }
  63289. }
  63290. declare module "babylonjs/Misc/meshExploder" {
  63291. import { Mesh } from "babylonjs/Meshes/mesh";
  63292. /**
  63293. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  63294. */
  63295. export class MeshExploder {
  63296. private _centerMesh;
  63297. private _meshes;
  63298. private _meshesOrigins;
  63299. private _toCenterVectors;
  63300. private _scaledDirection;
  63301. private _newPosition;
  63302. private _centerPosition;
  63303. /**
  63304. * Explodes meshes from a center mesh.
  63305. * @param meshes The meshes to explode.
  63306. * @param centerMesh The mesh to be center of explosion.
  63307. */
  63308. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  63309. private _setCenterMesh;
  63310. /**
  63311. * Get class name
  63312. * @returns "MeshExploder"
  63313. */
  63314. getClassName(): string;
  63315. /**
  63316. * "Exploded meshes"
  63317. * @returns Array of meshes with the centerMesh at index 0.
  63318. */
  63319. getMeshes(): Array<Mesh>;
  63320. /**
  63321. * Explodes meshes giving a specific direction
  63322. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  63323. */
  63324. explode(direction?: number): void;
  63325. }
  63326. }
  63327. declare module "babylonjs/Misc/filesInput" {
  63328. import { Engine } from "babylonjs/Engines/engine";
  63329. import { Scene } from "babylonjs/scene";
  63330. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  63331. /**
  63332. * Class used to help managing file picking and drag'n'drop
  63333. */
  63334. export class FilesInput {
  63335. /**
  63336. * List of files ready to be loaded
  63337. */
  63338. static readonly FilesToLoad: {
  63339. [key: string]: File;
  63340. };
  63341. /**
  63342. * Callback called when a file is processed
  63343. */
  63344. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  63345. private _engine;
  63346. private _currentScene;
  63347. private _sceneLoadedCallback;
  63348. private _progressCallback;
  63349. private _additionalRenderLoopLogicCallback;
  63350. private _textureLoadingCallback;
  63351. private _startingProcessingFilesCallback;
  63352. private _onReloadCallback;
  63353. private _errorCallback;
  63354. private _elementToMonitor;
  63355. private _sceneFileToLoad;
  63356. private _filesToLoad;
  63357. /**
  63358. * Creates a new FilesInput
  63359. * @param engine defines the rendering engine
  63360. * @param scene defines the hosting scene
  63361. * @param sceneLoadedCallback callback called when scene is loaded
  63362. * @param progressCallback callback called to track progress
  63363. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  63364. * @param textureLoadingCallback callback called when a texture is loading
  63365. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  63366. * @param onReloadCallback callback called when a reload is requested
  63367. * @param errorCallback callback call if an error occurs
  63368. */
  63369. 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);
  63370. private _dragEnterHandler;
  63371. private _dragOverHandler;
  63372. private _dropHandler;
  63373. /**
  63374. * Calls this function to listen to drag'n'drop events on a specific DOM element
  63375. * @param elementToMonitor defines the DOM element to track
  63376. */
  63377. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  63378. /**
  63379. * Release all associated resources
  63380. */
  63381. dispose(): void;
  63382. private renderFunction;
  63383. private drag;
  63384. private drop;
  63385. private _traverseFolder;
  63386. private _processFiles;
  63387. /**
  63388. * Load files from a drop event
  63389. * @param event defines the drop event to use as source
  63390. */
  63391. loadFiles(event: any): void;
  63392. private _processReload;
  63393. /**
  63394. * Reload the current scene from the loaded files
  63395. */
  63396. reload(): void;
  63397. }
  63398. }
  63399. declare module "babylonjs/Misc/HighDynamicRange/index" {
  63400. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  63401. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  63402. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  63403. }
  63404. declare module "babylonjs/Misc/sceneOptimizer" {
  63405. import { Scene, IDisposable } from "babylonjs/scene";
  63406. import { Observable } from "babylonjs/Misc/observable";
  63407. /**
  63408. * Defines the root class used to create scene optimization to use with SceneOptimizer
  63409. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63410. */
  63411. export class SceneOptimization {
  63412. /**
  63413. * Defines the priority of this optimization (0 by default which means first in the list)
  63414. */
  63415. priority: number;
  63416. /**
  63417. * Gets a string describing the action executed by the current optimization
  63418. * @returns description string
  63419. */
  63420. getDescription(): string;
  63421. /**
  63422. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63423. * @param scene defines the current scene where to apply this optimization
  63424. * @param optimizer defines the current optimizer
  63425. * @returns true if everything that can be done was applied
  63426. */
  63427. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63428. /**
  63429. * Creates the SceneOptimization object
  63430. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  63431. * @param desc defines the description associated with the optimization
  63432. */
  63433. constructor(
  63434. /**
  63435. * Defines the priority of this optimization (0 by default which means first in the list)
  63436. */
  63437. priority?: number);
  63438. }
  63439. /**
  63440. * Defines an optimization used to reduce the size of render target textures
  63441. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63442. */
  63443. export class TextureOptimization extends SceneOptimization {
  63444. /**
  63445. * Defines the priority of this optimization (0 by default which means first in the list)
  63446. */
  63447. priority: number;
  63448. /**
  63449. * 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
  63450. */
  63451. maximumSize: number;
  63452. /**
  63453. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  63454. */
  63455. step: number;
  63456. /**
  63457. * Gets a string describing the action executed by the current optimization
  63458. * @returns description string
  63459. */
  63460. getDescription(): string;
  63461. /**
  63462. * Creates the TextureOptimization object
  63463. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  63464. * @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
  63465. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  63466. */
  63467. constructor(
  63468. /**
  63469. * Defines the priority of this optimization (0 by default which means first in the list)
  63470. */
  63471. priority?: number,
  63472. /**
  63473. * 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
  63474. */
  63475. maximumSize?: number,
  63476. /**
  63477. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  63478. */
  63479. step?: number);
  63480. /**
  63481. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63482. * @param scene defines the current scene where to apply this optimization
  63483. * @param optimizer defines the current optimizer
  63484. * @returns true if everything that can be done was applied
  63485. */
  63486. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63487. }
  63488. /**
  63489. * Defines an optimization used to increase or decrease the rendering resolution
  63490. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63491. */
  63492. export class HardwareScalingOptimization extends SceneOptimization {
  63493. /**
  63494. * Defines the priority of this optimization (0 by default which means first in the list)
  63495. */
  63496. priority: number;
  63497. /**
  63498. * Defines the maximum scale to use (2 by default)
  63499. */
  63500. maximumScale: number;
  63501. /**
  63502. * Defines the step to use between two passes (0.5 by default)
  63503. */
  63504. step: number;
  63505. private _currentScale;
  63506. private _directionOffset;
  63507. /**
  63508. * Gets a string describing the action executed by the current optimization
  63509. * @return description string
  63510. */
  63511. getDescription(): string;
  63512. /**
  63513. * Creates the HardwareScalingOptimization object
  63514. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  63515. * @param maximumScale defines the maximum scale to use (2 by default)
  63516. * @param step defines the step to use between two passes (0.5 by default)
  63517. */
  63518. constructor(
  63519. /**
  63520. * Defines the priority of this optimization (0 by default which means first in the list)
  63521. */
  63522. priority?: number,
  63523. /**
  63524. * Defines the maximum scale to use (2 by default)
  63525. */
  63526. maximumScale?: number,
  63527. /**
  63528. * Defines the step to use between two passes (0.5 by default)
  63529. */
  63530. step?: number);
  63531. /**
  63532. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63533. * @param scene defines the current scene where to apply this optimization
  63534. * @param optimizer defines the current optimizer
  63535. * @returns true if everything that can be done was applied
  63536. */
  63537. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63538. }
  63539. /**
  63540. * Defines an optimization used to remove shadows
  63541. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63542. */
  63543. export class ShadowsOptimization extends SceneOptimization {
  63544. /**
  63545. * Gets a string describing the action executed by the current optimization
  63546. * @return description string
  63547. */
  63548. getDescription(): string;
  63549. /**
  63550. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63551. * @param scene defines the current scene where to apply this optimization
  63552. * @param optimizer defines the current optimizer
  63553. * @returns true if everything that can be done was applied
  63554. */
  63555. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63556. }
  63557. /**
  63558. * Defines an optimization used to turn post-processes off
  63559. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63560. */
  63561. export class PostProcessesOptimization extends SceneOptimization {
  63562. /**
  63563. * Gets a string describing the action executed by the current optimization
  63564. * @return description string
  63565. */
  63566. getDescription(): string;
  63567. /**
  63568. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63569. * @param scene defines the current scene where to apply this optimization
  63570. * @param optimizer defines the current optimizer
  63571. * @returns true if everything that can be done was applied
  63572. */
  63573. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63574. }
  63575. /**
  63576. * Defines an optimization used to turn lens flares off
  63577. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63578. */
  63579. export class LensFlaresOptimization extends SceneOptimization {
  63580. /**
  63581. * Gets a string describing the action executed by the current optimization
  63582. * @return description string
  63583. */
  63584. getDescription(): string;
  63585. /**
  63586. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63587. * @param scene defines the current scene where to apply this optimization
  63588. * @param optimizer defines the current optimizer
  63589. * @returns true if everything that can be done was applied
  63590. */
  63591. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63592. }
  63593. /**
  63594. * Defines an optimization based on user defined callback.
  63595. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63596. */
  63597. export class CustomOptimization extends SceneOptimization {
  63598. /**
  63599. * Callback called to apply the custom optimization.
  63600. */
  63601. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  63602. /**
  63603. * Callback called to get custom description
  63604. */
  63605. onGetDescription: () => string;
  63606. /**
  63607. * Gets a string describing the action executed by the current optimization
  63608. * @returns description string
  63609. */
  63610. getDescription(): string;
  63611. /**
  63612. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63613. * @param scene defines the current scene where to apply this optimization
  63614. * @param optimizer defines the current optimizer
  63615. * @returns true if everything that can be done was applied
  63616. */
  63617. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63618. }
  63619. /**
  63620. * Defines an optimization used to turn particles off
  63621. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63622. */
  63623. export class ParticlesOptimization extends SceneOptimization {
  63624. /**
  63625. * Gets a string describing the action executed by the current optimization
  63626. * @return description string
  63627. */
  63628. getDescription(): string;
  63629. /**
  63630. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63631. * @param scene defines the current scene where to apply this optimization
  63632. * @param optimizer defines the current optimizer
  63633. * @returns true if everything that can be done was applied
  63634. */
  63635. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63636. }
  63637. /**
  63638. * Defines an optimization used to turn render targets off
  63639. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63640. */
  63641. export class RenderTargetsOptimization extends SceneOptimization {
  63642. /**
  63643. * Gets a string describing the action executed by the current optimization
  63644. * @return description string
  63645. */
  63646. getDescription(): string;
  63647. /**
  63648. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63649. * @param scene defines the current scene where to apply this optimization
  63650. * @param optimizer defines the current optimizer
  63651. * @returns true if everything that can be done was applied
  63652. */
  63653. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  63654. }
  63655. /**
  63656. * Defines an optimization used to merge meshes with compatible materials
  63657. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63658. */
  63659. export class MergeMeshesOptimization extends SceneOptimization {
  63660. private static _UpdateSelectionTree;
  63661. /**
  63662. * Gets or sets a boolean which defines if optimization octree has to be updated
  63663. */
  63664. /**
  63665. * Gets or sets a boolean which defines if optimization octree has to be updated
  63666. */
  63667. static UpdateSelectionTree: boolean;
  63668. /**
  63669. * Gets a string describing the action executed by the current optimization
  63670. * @return description string
  63671. */
  63672. getDescription(): string;
  63673. private _canBeMerged;
  63674. /**
  63675. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  63676. * @param scene defines the current scene where to apply this optimization
  63677. * @param optimizer defines the current optimizer
  63678. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  63679. * @returns true if everything that can be done was applied
  63680. */
  63681. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  63682. }
  63683. /**
  63684. * Defines a list of options used by SceneOptimizer
  63685. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63686. */
  63687. export class SceneOptimizerOptions {
  63688. /**
  63689. * Defines the target frame rate to reach (60 by default)
  63690. */
  63691. targetFrameRate: number;
  63692. /**
  63693. * Defines the interval between two checkes (2000ms by default)
  63694. */
  63695. trackerDuration: number;
  63696. /**
  63697. * Gets the list of optimizations to apply
  63698. */
  63699. optimizations: SceneOptimization[];
  63700. /**
  63701. * Creates a new list of options used by SceneOptimizer
  63702. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  63703. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  63704. */
  63705. constructor(
  63706. /**
  63707. * Defines the target frame rate to reach (60 by default)
  63708. */
  63709. targetFrameRate?: number,
  63710. /**
  63711. * Defines the interval between two checkes (2000ms by default)
  63712. */
  63713. trackerDuration?: number);
  63714. /**
  63715. * Add a new optimization
  63716. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  63717. * @returns the current SceneOptimizerOptions
  63718. */
  63719. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  63720. /**
  63721. * Add a new custom optimization
  63722. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  63723. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  63724. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  63725. * @returns the current SceneOptimizerOptions
  63726. */
  63727. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  63728. /**
  63729. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  63730. * @param targetFrameRate defines the target frame rate (60 by default)
  63731. * @returns a SceneOptimizerOptions object
  63732. */
  63733. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  63734. /**
  63735. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  63736. * @param targetFrameRate defines the target frame rate (60 by default)
  63737. * @returns a SceneOptimizerOptions object
  63738. */
  63739. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  63740. /**
  63741. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  63742. * @param targetFrameRate defines the target frame rate (60 by default)
  63743. * @returns a SceneOptimizerOptions object
  63744. */
  63745. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  63746. }
  63747. /**
  63748. * Class used to run optimizations in order to reach a target frame rate
  63749. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  63750. */
  63751. export class SceneOptimizer implements IDisposable {
  63752. private _isRunning;
  63753. private _options;
  63754. private _scene;
  63755. private _currentPriorityLevel;
  63756. private _targetFrameRate;
  63757. private _trackerDuration;
  63758. private _currentFrameRate;
  63759. private _sceneDisposeObserver;
  63760. private _improvementMode;
  63761. /**
  63762. * Defines an observable called when the optimizer reaches the target frame rate
  63763. */
  63764. onSuccessObservable: Observable<SceneOptimizer>;
  63765. /**
  63766. * Defines an observable called when the optimizer enables an optimization
  63767. */
  63768. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  63769. /**
  63770. * Defines an observable called when the optimizer is not able to reach the target frame rate
  63771. */
  63772. onFailureObservable: Observable<SceneOptimizer>;
  63773. /**
  63774. * Gets a boolean indicating if the optimizer is in improvement mode
  63775. */
  63776. readonly isInImprovementMode: boolean;
  63777. /**
  63778. * Gets the current priority level (0 at start)
  63779. */
  63780. readonly currentPriorityLevel: number;
  63781. /**
  63782. * Gets the current frame rate checked by the SceneOptimizer
  63783. */
  63784. readonly currentFrameRate: number;
  63785. /**
  63786. * Gets or sets the current target frame rate (60 by default)
  63787. */
  63788. /**
  63789. * Gets or sets the current target frame rate (60 by default)
  63790. */
  63791. targetFrameRate: number;
  63792. /**
  63793. * Gets or sets the current interval between two checks (every 2000ms by default)
  63794. */
  63795. /**
  63796. * Gets or sets the current interval between two checks (every 2000ms by default)
  63797. */
  63798. trackerDuration: number;
  63799. /**
  63800. * Gets the list of active optimizations
  63801. */
  63802. readonly optimizations: SceneOptimization[];
  63803. /**
  63804. * Creates a new SceneOptimizer
  63805. * @param scene defines the scene to work on
  63806. * @param options defines the options to use with the SceneOptimizer
  63807. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  63808. * @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)
  63809. */
  63810. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  63811. /**
  63812. * Stops the current optimizer
  63813. */
  63814. stop(): void;
  63815. /**
  63816. * Reset the optimizer to initial step (current priority level = 0)
  63817. */
  63818. reset(): void;
  63819. /**
  63820. * Start the optimizer. By default it will try to reach a specific framerate
  63821. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  63822. */
  63823. start(): void;
  63824. private _checkCurrentState;
  63825. /**
  63826. * Release all resources
  63827. */
  63828. dispose(): void;
  63829. /**
  63830. * Helper function to create a SceneOptimizer with one single line of code
  63831. * @param scene defines the scene to work on
  63832. * @param options defines the options to use with the SceneOptimizer
  63833. * @param onSuccess defines a callback to call on success
  63834. * @param onFailure defines a callback to call on failure
  63835. * @returns the new SceneOptimizer object
  63836. */
  63837. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  63838. }
  63839. }
  63840. declare module "babylonjs/Misc/sceneSerializer" {
  63841. import { Scene } from "babylonjs/scene";
  63842. /**
  63843. * Class used to serialize a scene into a string
  63844. */
  63845. export class SceneSerializer {
  63846. /**
  63847. * Clear cache used by a previous serialization
  63848. */
  63849. static ClearCache(): void;
  63850. /**
  63851. * Serialize a scene into a JSON compatible object
  63852. * @param scene defines the scene to serialize
  63853. * @returns a JSON compatible object
  63854. */
  63855. static Serialize(scene: Scene): any;
  63856. /**
  63857. * Serialize a mesh into a JSON compatible object
  63858. * @param toSerialize defines the mesh to serialize
  63859. * @param withParents defines if parents must be serialized as well
  63860. * @param withChildren defines if children must be serialized as well
  63861. * @returns a JSON compatible object
  63862. */
  63863. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  63864. }
  63865. }
  63866. declare module "babylonjs/Misc/textureTools" {
  63867. import { Texture } from "babylonjs/Materials/Textures/texture";
  63868. /**
  63869. * Class used to host texture specific utilities
  63870. */
  63871. export class TextureTools {
  63872. /**
  63873. * Uses the GPU to create a copy texture rescaled at a given size
  63874. * @param texture Texture to copy from
  63875. * @param width defines the desired width
  63876. * @param height defines the desired height
  63877. * @param useBilinearMode defines if bilinear mode has to be used
  63878. * @return the generated texture
  63879. */
  63880. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  63881. }
  63882. }
  63883. declare module "babylonjs/Misc/videoRecorder" {
  63884. import { Nullable } from "babylonjs/types";
  63885. import { Engine } from "babylonjs/Engines/engine";
  63886. /**
  63887. * This represents the different options available for the video capture.
  63888. */
  63889. export interface VideoRecorderOptions {
  63890. /** Defines the mime type of the video. */
  63891. mimeType: string;
  63892. /** Defines the FPS the video should be recorded at. */
  63893. fps: number;
  63894. /** Defines the chunk size for the recording data. */
  63895. recordChunckSize: number;
  63896. /** The audio tracks to attach to the recording. */
  63897. audioTracks?: MediaStreamTrack[];
  63898. }
  63899. /**
  63900. * This can help with recording videos from BabylonJS.
  63901. * This is based on the available WebRTC functionalities of the browser.
  63902. *
  63903. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  63904. */
  63905. export class VideoRecorder {
  63906. private static readonly _defaultOptions;
  63907. /**
  63908. * Returns whether or not the VideoRecorder is available in your browser.
  63909. * @param engine Defines the Babylon Engine.
  63910. * @returns true if supported otherwise false.
  63911. */
  63912. static IsSupported(engine: Engine): boolean;
  63913. private readonly _options;
  63914. private _canvas;
  63915. private _mediaRecorder;
  63916. private _recordedChunks;
  63917. private _fileName;
  63918. private _resolve;
  63919. private _reject;
  63920. /**
  63921. * True when a recording is already in progress.
  63922. */
  63923. readonly isRecording: boolean;
  63924. /**
  63925. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  63926. * @param engine Defines the BabylonJS Engine you wish to record.
  63927. * @param options Defines options that can be used to customize the capture.
  63928. */
  63929. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  63930. /**
  63931. * Stops the current recording before the default capture timeout passed in the startRecording function.
  63932. */
  63933. stopRecording(): void;
  63934. /**
  63935. * Starts recording the canvas for a max duration specified in parameters.
  63936. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  63937. * If null no automatic download will start and you can rely on the promise to get the data back.
  63938. * @param maxDuration Defines the maximum recording time in seconds.
  63939. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  63940. * @return A promise callback at the end of the recording with the video data in Blob.
  63941. */
  63942. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  63943. /**
  63944. * Releases internal resources used during the recording.
  63945. */
  63946. dispose(): void;
  63947. private _handleDataAvailable;
  63948. private _handleError;
  63949. private _handleStop;
  63950. }
  63951. }
  63952. declare module "babylonjs/Misc/screenshotTools" {
  63953. import { Camera } from "babylonjs/Cameras/camera";
  63954. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  63955. import { Engine } from "babylonjs/Engines/engine";
  63956. /**
  63957. * Class containing a set of static utilities functions for screenshots
  63958. */
  63959. export class ScreenshotTools {
  63960. /**
  63961. * Captures a screenshot of the current rendering
  63962. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  63963. * @param engine defines the rendering engine
  63964. * @param camera defines the source camera
  63965. * @param size This parameter can be set to a single number or to an object with the
  63966. * following (optional) properties: precision, width, height. If a single number is passed,
  63967. * it will be used for both width and height. If an object is passed, the screenshot size
  63968. * will be derived from the parameters. The precision property is a multiplier allowing
  63969. * rendering at a higher or lower resolution
  63970. * @param successCallback defines the callback receives a single parameter which contains the
  63971. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  63972. * src parameter of an <img> to display it
  63973. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  63974. * Check your browser for supported MIME types
  63975. */
  63976. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  63977. /**
  63978. * Captures a screenshot of the current rendering
  63979. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  63980. * @param engine defines the rendering engine
  63981. * @param camera defines the source camera
  63982. * @param size This parameter can be set to a single number or to an object with the
  63983. * following (optional) properties: precision, width, height. If a single number is passed,
  63984. * it will be used for both width and height. If an object is passed, the screenshot size
  63985. * will be derived from the parameters. The precision property is a multiplier allowing
  63986. * rendering at a higher or lower resolution
  63987. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  63988. * Check your browser for supported MIME types
  63989. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  63990. * to the src parameter of an <img> to display it
  63991. */
  63992. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  63993. /**
  63994. * Generates an image screenshot from the specified camera.
  63995. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  63996. * @param engine The engine to use for rendering
  63997. * @param camera The camera to use for rendering
  63998. * @param size This parameter can be set to a single number or to an object with the
  63999. * following (optional) properties: precision, width, height. If a single number is passed,
  64000. * it will be used for both width and height. If an object is passed, the screenshot size
  64001. * will be derived from the parameters. The precision property is a multiplier allowing
  64002. * rendering at a higher or lower resolution
  64003. * @param successCallback The callback receives a single parameter which contains the
  64004. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  64005. * src parameter of an <img> to display it
  64006. * @param mimeType The MIME type of the screenshot image (default: image/png).
  64007. * Check your browser for supported MIME types
  64008. * @param samples Texture samples (default: 1)
  64009. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  64010. * @param fileName A name for for the downloaded file.
  64011. */
  64012. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  64013. /**
  64014. * Generates an image screenshot from the specified camera.
  64015. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  64016. * @param engine The engine to use for rendering
  64017. * @param camera The camera to use for rendering
  64018. * @param size This parameter can be set to a single number or to an object with the
  64019. * following (optional) properties: precision, width, height. If a single number is passed,
  64020. * it will be used for both width and height. If an object is passed, the screenshot size
  64021. * will be derived from the parameters. The precision property is a multiplier allowing
  64022. * rendering at a higher or lower resolution
  64023. * @param mimeType The MIME type of the screenshot image (default: image/png).
  64024. * Check your browser for supported MIME types
  64025. * @param samples Texture samples (default: 1)
  64026. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  64027. * @param fileName A name for for the downloaded file.
  64028. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  64029. * to the src parameter of an <img> to display it
  64030. */
  64031. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  64032. /**
  64033. * Gets height and width for screenshot size
  64034. * @private
  64035. */
  64036. private static _getScreenshotSize;
  64037. }
  64038. }
  64039. declare module "babylonjs/Misc/index" {
  64040. export * from "babylonjs/Misc/andOrNotEvaluator";
  64041. export * from "babylonjs/Misc/assetsManager";
  64042. export * from "babylonjs/Misc/dds";
  64043. export * from "babylonjs/Misc/decorators";
  64044. export * from "babylonjs/Misc/deferred";
  64045. export * from "babylonjs/Misc/environmentTextureTools";
  64046. export * from "babylonjs/Misc/meshExploder";
  64047. export * from "babylonjs/Misc/filesInput";
  64048. export * from "babylonjs/Misc/HighDynamicRange/index";
  64049. export * from "babylonjs/Misc/khronosTextureContainer";
  64050. export * from "babylonjs/Misc/observable";
  64051. export * from "babylonjs/Misc/performanceMonitor";
  64052. export * from "babylonjs/Misc/promise";
  64053. export * from "babylonjs/Misc/sceneOptimizer";
  64054. export * from "babylonjs/Misc/sceneSerializer";
  64055. export * from "babylonjs/Misc/smartArray";
  64056. export * from "babylonjs/Misc/stringDictionary";
  64057. export * from "babylonjs/Misc/tags";
  64058. export * from "babylonjs/Misc/textureTools";
  64059. export * from "babylonjs/Misc/tga";
  64060. export * from "babylonjs/Misc/tools";
  64061. export * from "babylonjs/Misc/videoRecorder";
  64062. export * from "babylonjs/Misc/virtualJoystick";
  64063. export * from "babylonjs/Misc/workerPool";
  64064. export * from "babylonjs/Misc/logger";
  64065. export * from "babylonjs/Misc/typeStore";
  64066. export * from "babylonjs/Misc/filesInputStore";
  64067. export * from "babylonjs/Misc/deepCopier";
  64068. export * from "babylonjs/Misc/pivotTools";
  64069. export * from "babylonjs/Misc/precisionDate";
  64070. export * from "babylonjs/Misc/screenshotTools";
  64071. export * from "babylonjs/Misc/typeStore";
  64072. export * from "babylonjs/Misc/webRequest";
  64073. export * from "babylonjs/Misc/iInspectable";
  64074. export * from "babylonjs/Misc/brdfTextureTools";
  64075. export * from "babylonjs/Misc/gradients";
  64076. export * from "babylonjs/Misc/perfCounter";
  64077. export * from "babylonjs/Misc/fileRequest";
  64078. export * from "babylonjs/Misc/customAnimationFrameRequester";
  64079. export * from "babylonjs/Misc/retryStrategy";
  64080. export * from "babylonjs/Misc/loadFileError";
  64081. }
  64082. declare module "babylonjs/index" {
  64083. export * from "babylonjs/abstractScene";
  64084. export * from "babylonjs/Actions/index";
  64085. export * from "babylonjs/Animations/index";
  64086. export * from "babylonjs/assetContainer";
  64087. export * from "babylonjs/Audio/index";
  64088. export * from "babylonjs/Behaviors/index";
  64089. export * from "babylonjs/Bones/index";
  64090. export * from "babylonjs/Cameras/index";
  64091. export * from "babylonjs/Collisions/index";
  64092. export * from "babylonjs/Culling/index";
  64093. export * from "babylonjs/Debug/index";
  64094. export * from "babylonjs/Engines/index";
  64095. export * from "babylonjs/Events/index";
  64096. export * from "babylonjs/Gamepads/index";
  64097. export * from "babylonjs/Gizmos/index";
  64098. export * from "babylonjs/Helpers/index";
  64099. export * from "babylonjs/Instrumentation/index";
  64100. export * from "babylonjs/Layers/index";
  64101. export * from "babylonjs/LensFlares/index";
  64102. export * from "babylonjs/Lights/index";
  64103. export * from "babylonjs/Loading/index";
  64104. export * from "babylonjs/Materials/index";
  64105. export * from "babylonjs/Maths/index";
  64106. export * from "babylonjs/Meshes/index";
  64107. export * from "babylonjs/Morph/index";
  64108. export * from "babylonjs/Navigation/index";
  64109. export * from "babylonjs/node";
  64110. export * from "babylonjs/Offline/index";
  64111. export * from "babylonjs/Particles/index";
  64112. export * from "babylonjs/Physics/index";
  64113. export * from "babylonjs/PostProcesses/index";
  64114. export * from "babylonjs/Probes/index";
  64115. export * from "babylonjs/Rendering/index";
  64116. export * from "babylonjs/scene";
  64117. export * from "babylonjs/sceneComponent";
  64118. export * from "babylonjs/Sprites/index";
  64119. export * from "babylonjs/States/index";
  64120. export * from "babylonjs/Misc/index";
  64121. export * from "babylonjs/types";
  64122. }
  64123. declare module "babylonjs/Animations/pathCursor" {
  64124. import { Vector3 } from "babylonjs/Maths/math.vector";
  64125. import { Path2 } from "babylonjs/Maths/math.path";
  64126. /**
  64127. * A cursor which tracks a point on a path
  64128. */
  64129. export class PathCursor {
  64130. private path;
  64131. /**
  64132. * Stores path cursor callbacks for when an onchange event is triggered
  64133. */
  64134. private _onchange;
  64135. /**
  64136. * The value of the path cursor
  64137. */
  64138. value: number;
  64139. /**
  64140. * The animation array of the path cursor
  64141. */
  64142. animations: Animation[];
  64143. /**
  64144. * Initializes the path cursor
  64145. * @param path The path to track
  64146. */
  64147. constructor(path: Path2);
  64148. /**
  64149. * Gets the cursor point on the path
  64150. * @returns A point on the path cursor at the cursor location
  64151. */
  64152. getPoint(): Vector3;
  64153. /**
  64154. * Moves the cursor ahead by the step amount
  64155. * @param step The amount to move the cursor forward
  64156. * @returns This path cursor
  64157. */
  64158. moveAhead(step?: number): PathCursor;
  64159. /**
  64160. * Moves the cursor behind by the step amount
  64161. * @param step The amount to move the cursor back
  64162. * @returns This path cursor
  64163. */
  64164. moveBack(step?: number): PathCursor;
  64165. /**
  64166. * Moves the cursor by the step amount
  64167. * If the step amount is greater than one, an exception is thrown
  64168. * @param step The amount to move the cursor
  64169. * @returns This path cursor
  64170. */
  64171. move(step: number): PathCursor;
  64172. /**
  64173. * Ensures that the value is limited between zero and one
  64174. * @returns This path cursor
  64175. */
  64176. private ensureLimits;
  64177. /**
  64178. * Runs onchange callbacks on change (used by the animation engine)
  64179. * @returns This path cursor
  64180. */
  64181. private raiseOnChange;
  64182. /**
  64183. * Executes a function on change
  64184. * @param f A path cursor onchange callback
  64185. * @returns This path cursor
  64186. */
  64187. onchange(f: (cursor: PathCursor) => void): PathCursor;
  64188. }
  64189. }
  64190. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  64191. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  64192. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  64193. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  64194. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  64195. }
  64196. declare module "babylonjs/Engines/Processors/Expressions/index" {
  64197. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  64198. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  64199. }
  64200. declare module "babylonjs/Engines/Processors/index" {
  64201. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  64202. export * from "babylonjs/Engines/Processors/Expressions/index";
  64203. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  64204. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  64205. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  64206. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  64207. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  64208. export * from "babylonjs/Engines/Processors/shaderProcessor";
  64209. }
  64210. declare module "babylonjs/Legacy/legacy" {
  64211. import * as Babylon from "babylonjs/index";
  64212. export * from "babylonjs/index";
  64213. }
  64214. declare module "babylonjs/Shaders/blur.fragment" {
  64215. /** @hidden */
  64216. export var blurPixelShader: {
  64217. name: string;
  64218. shader: string;
  64219. };
  64220. }
  64221. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  64222. /** @hidden */
  64223. export var pointCloudVertexDeclaration: {
  64224. name: string;
  64225. shader: string;
  64226. };
  64227. }
  64228. declare module "babylonjs" {
  64229. export * from "babylonjs/Legacy/legacy";
  64230. }
  64231. declare module BABYLON {
  64232. /** Alias type for value that can be null */
  64233. export type Nullable<T> = T | null;
  64234. /**
  64235. * Alias type for number that are floats
  64236. * @ignorenaming
  64237. */
  64238. export type float = number;
  64239. /**
  64240. * Alias type for number that are doubles.
  64241. * @ignorenaming
  64242. */
  64243. export type double = number;
  64244. /**
  64245. * Alias type for number that are integer
  64246. * @ignorenaming
  64247. */
  64248. export type int = number;
  64249. /** Alias type for number array or Float32Array */
  64250. export type FloatArray = number[] | Float32Array;
  64251. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  64252. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  64253. /**
  64254. * Alias for types that can be used by a Buffer or VertexBuffer.
  64255. */
  64256. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  64257. /**
  64258. * Alias type for primitive types
  64259. * @ignorenaming
  64260. */
  64261. type Primitive = undefined | null | boolean | string | number | Function;
  64262. /**
  64263. * Type modifier to make all the properties of an object Readonly
  64264. */
  64265. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  64266. /**
  64267. * Type modifier to make all the properties of an object Readonly recursively
  64268. */
  64269. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  64270. /** @hidden */
  64271. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  64272. }
  64273. /** @hidden */
  64274. /** @hidden */
  64275. type DeepImmutableObject<T> = {
  64276. readonly [K in keyof T]: DeepImmutable<T[K]>;
  64277. };
  64278. }
  64279. declare module BABYLON {
  64280. /**
  64281. * A class serves as a medium between the observable and its observers
  64282. */
  64283. export class EventState {
  64284. /**
  64285. * Create a new EventState
  64286. * @param mask defines the mask associated with this state
  64287. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  64288. * @param target defines the original target of the state
  64289. * @param currentTarget defines the current target of the state
  64290. */
  64291. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64292. /**
  64293. * Initialize the current event state
  64294. * @param mask defines the mask associated with this state
  64295. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  64296. * @param target defines the original target of the state
  64297. * @param currentTarget defines the current target of the state
  64298. * @returns the current event state
  64299. */
  64300. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  64301. /**
  64302. * An Observer can set this property to true to prevent subsequent observers of being notified
  64303. */
  64304. skipNextObservers: boolean;
  64305. /**
  64306. * Get the mask value that were used to trigger the event corresponding to this EventState object
  64307. */
  64308. mask: number;
  64309. /**
  64310. * The object that originally notified the event
  64311. */
  64312. target?: any;
  64313. /**
  64314. * The current object in the bubbling phase
  64315. */
  64316. currentTarget?: any;
  64317. /**
  64318. * This will be populated with the return value of the last function that was executed.
  64319. * If it is the first function in the callback chain it will be the event data.
  64320. */
  64321. lastReturnValue?: any;
  64322. }
  64323. /**
  64324. * Represent an Observer registered to a given Observable object.
  64325. */
  64326. export class Observer<T> {
  64327. /**
  64328. * Defines the callback to call when the observer is notified
  64329. */
  64330. callback: (eventData: T, eventState: EventState) => void;
  64331. /**
  64332. * Defines the mask of the observer (used to filter notifications)
  64333. */
  64334. mask: number;
  64335. /**
  64336. * Defines the current scope used to restore the JS context
  64337. */
  64338. scope: any;
  64339. /** @hidden */
  64340. _willBeUnregistered: boolean;
  64341. /**
  64342. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  64343. */
  64344. unregisterOnNextCall: boolean;
  64345. /**
  64346. * Creates a new observer
  64347. * @param callback defines the callback to call when the observer is notified
  64348. * @param mask defines the mask of the observer (used to filter notifications)
  64349. * @param scope defines the current scope used to restore the JS context
  64350. */
  64351. constructor(
  64352. /**
  64353. * Defines the callback to call when the observer is notified
  64354. */
  64355. callback: (eventData: T, eventState: EventState) => void,
  64356. /**
  64357. * Defines the mask of the observer (used to filter notifications)
  64358. */
  64359. mask: number,
  64360. /**
  64361. * Defines the current scope used to restore the JS context
  64362. */
  64363. scope?: any);
  64364. }
  64365. /**
  64366. * Represent a list of observers registered to multiple Observables object.
  64367. */
  64368. export class MultiObserver<T> {
  64369. private _observers;
  64370. private _observables;
  64371. /**
  64372. * Release associated resources
  64373. */
  64374. dispose(): void;
  64375. /**
  64376. * Raise a callback when one of the observable will notify
  64377. * @param observables defines a list of observables to watch
  64378. * @param callback defines the callback to call on notification
  64379. * @param mask defines the mask used to filter notifications
  64380. * @param scope defines the current scope used to restore the JS context
  64381. * @returns the new MultiObserver
  64382. */
  64383. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  64384. }
  64385. /**
  64386. * The Observable class is a simple implementation of the Observable pattern.
  64387. *
  64388. * 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.
  64389. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  64390. * 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).
  64391. * 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.
  64392. */
  64393. export class Observable<T> {
  64394. private _observers;
  64395. private _eventState;
  64396. private _onObserverAdded;
  64397. /**
  64398. * Gets the list of observers
  64399. */
  64400. readonly observers: Array<Observer<T>>;
  64401. /**
  64402. * Creates a new observable
  64403. * @param onObserverAdded defines a callback to call when a new observer is added
  64404. */
  64405. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  64406. /**
  64407. * Create a new Observer with the specified callback
  64408. * @param callback the callback that will be executed for that Observer
  64409. * @param mask the mask used to filter observers
  64410. * @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.
  64411. * @param scope optional scope for the callback to be called from
  64412. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  64413. * @returns the new observer created for the callback
  64414. */
  64415. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  64416. /**
  64417. * Create a new Observer with the specified callback and unregisters after the next notification
  64418. * @param callback the callback that will be executed for that Observer
  64419. * @returns the new observer created for the callback
  64420. */
  64421. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  64422. /**
  64423. * Remove an Observer from the Observable object
  64424. * @param observer the instance of the Observer to remove
  64425. * @returns false if it doesn't belong to this Observable
  64426. */
  64427. remove(observer: Nullable<Observer<T>>): boolean;
  64428. /**
  64429. * Remove a callback from the Observable object
  64430. * @param callback the callback to remove
  64431. * @param scope optional scope. If used only the callbacks with this scope will be removed
  64432. * @returns false if it doesn't belong to this Observable
  64433. */
  64434. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  64435. private _deferUnregister;
  64436. private _remove;
  64437. /**
  64438. * Moves the observable to the top of the observer list making it get called first when notified
  64439. * @param observer the observer to move
  64440. */
  64441. makeObserverTopPriority(observer: Observer<T>): void;
  64442. /**
  64443. * Moves the observable to the bottom of the observer list making it get called last when notified
  64444. * @param observer the observer to move
  64445. */
  64446. makeObserverBottomPriority(observer: Observer<T>): void;
  64447. /**
  64448. * Notify all Observers by calling their respective callback with the given data
  64449. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  64450. * @param eventData defines the data to send to all observers
  64451. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  64452. * @param target defines the original target of the state
  64453. * @param currentTarget defines the current target of the state
  64454. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  64455. */
  64456. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  64457. /**
  64458. * Calling this will execute each callback, expecting it to be a promise or return a value.
  64459. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  64460. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  64461. * and it is crucial that all callbacks will be executed.
  64462. * The order of the callbacks is kept, callbacks are not executed parallel.
  64463. *
  64464. * @param eventData The data to be sent to each callback
  64465. * @param mask is used to filter observers defaults to -1
  64466. * @param target defines the callback target (see EventState)
  64467. * @param currentTarget defines he current object in the bubbling phase
  64468. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  64469. */
  64470. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  64471. /**
  64472. * Notify a specific observer
  64473. * @param observer defines the observer to notify
  64474. * @param eventData defines the data to be sent to each callback
  64475. * @param mask is used to filter observers defaults to -1
  64476. */
  64477. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  64478. /**
  64479. * Gets a boolean indicating if the observable has at least one observer
  64480. * @returns true is the Observable has at least one Observer registered
  64481. */
  64482. hasObservers(): boolean;
  64483. /**
  64484. * Clear the list of observers
  64485. */
  64486. clear(): void;
  64487. /**
  64488. * Clone the current observable
  64489. * @returns a new observable
  64490. */
  64491. clone(): Observable<T>;
  64492. /**
  64493. * Does this observable handles observer registered with a given mask
  64494. * @param mask defines the mask to be tested
  64495. * @return whether or not one observer registered with the given mask is handeled
  64496. **/
  64497. hasSpecificMask(mask?: number): boolean;
  64498. }
  64499. }
  64500. declare module BABYLON {
  64501. /**
  64502. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  64503. * Babylon.js
  64504. */
  64505. export class DomManagement {
  64506. /**
  64507. * Checks if the window object exists
  64508. * @returns true if the window object exists
  64509. */
  64510. static IsWindowObjectExist(): boolean;
  64511. /**
  64512. * Extracts text content from a DOM element hierarchy
  64513. * @param element defines the root element
  64514. * @returns a string
  64515. */
  64516. static GetDOMTextContent(element: HTMLElement): string;
  64517. }
  64518. }
  64519. declare module BABYLON {
  64520. /**
  64521. * Logger used througouht the application to allow configuration of
  64522. * the log level required for the messages.
  64523. */
  64524. export class Logger {
  64525. /**
  64526. * No log
  64527. */
  64528. static readonly NoneLogLevel: number;
  64529. /**
  64530. * Only message logs
  64531. */
  64532. static readonly MessageLogLevel: number;
  64533. /**
  64534. * Only warning logs
  64535. */
  64536. static readonly WarningLogLevel: number;
  64537. /**
  64538. * Only error logs
  64539. */
  64540. static readonly ErrorLogLevel: number;
  64541. /**
  64542. * All logs
  64543. */
  64544. static readonly AllLogLevel: number;
  64545. private static _LogCache;
  64546. /**
  64547. * Gets a value indicating the number of loading errors
  64548. * @ignorenaming
  64549. */
  64550. static errorsCount: number;
  64551. /**
  64552. * Callback called when a new log is added
  64553. */
  64554. static OnNewCacheEntry: (entry: string) => void;
  64555. private static _AddLogEntry;
  64556. private static _FormatMessage;
  64557. private static _LogDisabled;
  64558. private static _LogEnabled;
  64559. private static _WarnDisabled;
  64560. private static _WarnEnabled;
  64561. private static _ErrorDisabled;
  64562. private static _ErrorEnabled;
  64563. /**
  64564. * Log a message to the console
  64565. */
  64566. static Log: (message: string) => void;
  64567. /**
  64568. * Write a warning message to the console
  64569. */
  64570. static Warn: (message: string) => void;
  64571. /**
  64572. * Write an error message to the console
  64573. */
  64574. static Error: (message: string) => void;
  64575. /**
  64576. * Gets current log cache (list of logs)
  64577. */
  64578. static readonly LogCache: string;
  64579. /**
  64580. * Clears the log cache
  64581. */
  64582. static ClearLogCache(): void;
  64583. /**
  64584. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  64585. */
  64586. static LogLevels: number;
  64587. }
  64588. }
  64589. declare module BABYLON {
  64590. /** @hidden */
  64591. export class _TypeStore {
  64592. /** @hidden */
  64593. static RegisteredTypes: {
  64594. [key: string]: Object;
  64595. };
  64596. /** @hidden */
  64597. static GetClass(fqdn: string): any;
  64598. }
  64599. }
  64600. declare module BABYLON {
  64601. /**
  64602. * Class containing a set of static utilities functions for deep copy.
  64603. */
  64604. export class DeepCopier {
  64605. /**
  64606. * Tries to copy an object by duplicating every property
  64607. * @param source defines the source object
  64608. * @param destination defines the target object
  64609. * @param doNotCopyList defines a list of properties to avoid
  64610. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  64611. */
  64612. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  64613. }
  64614. }
  64615. declare module BABYLON {
  64616. /**
  64617. * Class containing a set of static utilities functions for precision date
  64618. */
  64619. export class PrecisionDate {
  64620. /**
  64621. * Gets either window.performance.now() if supported or Date.now() else
  64622. */
  64623. static readonly Now: number;
  64624. }
  64625. }
  64626. declare module BABYLON {
  64627. /** @hidden */
  64628. export class _DevTools {
  64629. static WarnImport(name: string): string;
  64630. }
  64631. }
  64632. declare module BABYLON {
  64633. /**
  64634. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  64635. */
  64636. export class WebRequest {
  64637. private _xhr;
  64638. /**
  64639. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  64640. * i.e. when loading files, where the server/service expects an Authorization header
  64641. */
  64642. static CustomRequestHeaders: {
  64643. [key: string]: string;
  64644. };
  64645. /**
  64646. * Add callback functions in this array to update all the requests before they get sent to the network
  64647. */
  64648. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  64649. private _injectCustomRequestHeaders;
  64650. /**
  64651. * Gets or sets a function to be called when loading progress changes
  64652. */
  64653. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  64654. /**
  64655. * Returns client's state
  64656. */
  64657. readonly readyState: number;
  64658. /**
  64659. * Returns client's status
  64660. */
  64661. readonly status: number;
  64662. /**
  64663. * Returns client's status as a text
  64664. */
  64665. readonly statusText: string;
  64666. /**
  64667. * Returns client's response
  64668. */
  64669. readonly response: any;
  64670. /**
  64671. * Returns client's response url
  64672. */
  64673. readonly responseURL: string;
  64674. /**
  64675. * Returns client's response as text
  64676. */
  64677. readonly responseText: string;
  64678. /**
  64679. * Gets or sets the expected response type
  64680. */
  64681. responseType: XMLHttpRequestResponseType;
  64682. /** @hidden */
  64683. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  64684. /** @hidden */
  64685. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  64686. /**
  64687. * Cancels any network activity
  64688. */
  64689. abort(): void;
  64690. /**
  64691. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  64692. * @param body defines an optional request body
  64693. */
  64694. send(body?: Document | BodyInit | null): void;
  64695. /**
  64696. * Sets the request method, request URL
  64697. * @param method defines the method to use (GET, POST, etc..)
  64698. * @param url defines the url to connect with
  64699. */
  64700. open(method: string, url: string): void;
  64701. }
  64702. }
  64703. declare module BABYLON {
  64704. /**
  64705. * File request interface
  64706. */
  64707. export interface IFileRequest {
  64708. /**
  64709. * Raised when the request is complete (success or error).
  64710. */
  64711. onCompleteObservable: Observable<IFileRequest>;
  64712. /**
  64713. * Aborts the request for a file.
  64714. */
  64715. abort: () => void;
  64716. }
  64717. }
  64718. declare module BABYLON {
  64719. /**
  64720. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  64721. */
  64722. export class PerformanceMonitor {
  64723. private _enabled;
  64724. private _rollingFrameTime;
  64725. private _lastFrameTimeMs;
  64726. /**
  64727. * constructor
  64728. * @param frameSampleSize The number of samples required to saturate the sliding window
  64729. */
  64730. constructor(frameSampleSize?: number);
  64731. /**
  64732. * Samples current frame
  64733. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  64734. */
  64735. sampleFrame(timeMs?: number): void;
  64736. /**
  64737. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  64738. */
  64739. readonly averageFrameTime: number;
  64740. /**
  64741. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  64742. */
  64743. readonly averageFrameTimeVariance: number;
  64744. /**
  64745. * Returns the frame time of the most recent frame
  64746. */
  64747. readonly instantaneousFrameTime: number;
  64748. /**
  64749. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  64750. */
  64751. readonly averageFPS: number;
  64752. /**
  64753. * Returns the average framerate in frames per second using the most recent frame time
  64754. */
  64755. readonly instantaneousFPS: number;
  64756. /**
  64757. * Returns true if enough samples have been taken to completely fill the sliding window
  64758. */
  64759. readonly isSaturated: boolean;
  64760. /**
  64761. * Enables contributions to the sliding window sample set
  64762. */
  64763. enable(): void;
  64764. /**
  64765. * Disables contributions to the sliding window sample set
  64766. * Samples will not be interpolated over the disabled period
  64767. */
  64768. disable(): void;
  64769. /**
  64770. * Returns true if sampling is enabled
  64771. */
  64772. readonly isEnabled: boolean;
  64773. /**
  64774. * Resets performance monitor
  64775. */
  64776. reset(): void;
  64777. }
  64778. /**
  64779. * RollingAverage
  64780. *
  64781. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  64782. */
  64783. export class RollingAverage {
  64784. /**
  64785. * Current average
  64786. */
  64787. average: number;
  64788. /**
  64789. * Current variance
  64790. */
  64791. variance: number;
  64792. protected _samples: Array<number>;
  64793. protected _sampleCount: number;
  64794. protected _pos: number;
  64795. protected _m2: number;
  64796. /**
  64797. * constructor
  64798. * @param length The number of samples required to saturate the sliding window
  64799. */
  64800. constructor(length: number);
  64801. /**
  64802. * Adds a sample to the sample set
  64803. * @param v The sample value
  64804. */
  64805. add(v: number): void;
  64806. /**
  64807. * Returns previously added values or null if outside of history or outside the sliding window domain
  64808. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  64809. * @return Value previously recorded with add() or null if outside of range
  64810. */
  64811. history(i: number): number;
  64812. /**
  64813. * Returns true if enough samples have been taken to completely fill the sliding window
  64814. * @return true if sample-set saturated
  64815. */
  64816. isSaturated(): boolean;
  64817. /**
  64818. * Resets the rolling average (equivalent to 0 samples taken so far)
  64819. */
  64820. reset(): void;
  64821. /**
  64822. * Wraps a value around the sample range boundaries
  64823. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  64824. * @return Wrapped position in sample range
  64825. */
  64826. protected _wrapPosition(i: number): number;
  64827. }
  64828. }
  64829. declare module BABYLON {
  64830. /**
  64831. * This class implement a typical dictionary using a string as key and the generic type T as value.
  64832. * The underlying implementation relies on an associative array to ensure the best performances.
  64833. * The value can be anything including 'null' but except 'undefined'
  64834. */
  64835. export class StringDictionary<T> {
  64836. /**
  64837. * This will clear this dictionary and copy the content from the 'source' one.
  64838. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  64839. * @param source the dictionary to take the content from and copy to this dictionary
  64840. */
  64841. copyFrom(source: StringDictionary<T>): void;
  64842. /**
  64843. * Get a value based from its key
  64844. * @param key the given key to get the matching value from
  64845. * @return the value if found, otherwise undefined is returned
  64846. */
  64847. get(key: string): T | undefined;
  64848. /**
  64849. * Get a value from its key or add it if it doesn't exist.
  64850. * This method will ensure you that a given key/data will be present in the dictionary.
  64851. * @param key the given key to get the matching value from
  64852. * @param factory the factory that will create the value if the key is not present in the dictionary.
  64853. * The factory will only be invoked if there's no data for the given key.
  64854. * @return the value corresponding to the key.
  64855. */
  64856. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  64857. /**
  64858. * Get a value from its key if present in the dictionary otherwise add it
  64859. * @param key the key to get the value from
  64860. * @param val if there's no such key/value pair in the dictionary add it with this value
  64861. * @return the value corresponding to the key
  64862. */
  64863. getOrAdd(key: string, val: T): T;
  64864. /**
  64865. * Check if there's a given key in the dictionary
  64866. * @param key the key to check for
  64867. * @return true if the key is present, false otherwise
  64868. */
  64869. contains(key: string): boolean;
  64870. /**
  64871. * Add a new key and its corresponding value
  64872. * @param key the key to add
  64873. * @param value the value corresponding to the key
  64874. * @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
  64875. */
  64876. add(key: string, value: T): boolean;
  64877. /**
  64878. * Update a specific value associated to a key
  64879. * @param key defines the key to use
  64880. * @param value defines the value to store
  64881. * @returns true if the value was updated (or false if the key was not found)
  64882. */
  64883. set(key: string, value: T): boolean;
  64884. /**
  64885. * Get the element of the given key and remove it from the dictionary
  64886. * @param key defines the key to search
  64887. * @returns the value associated with the key or null if not found
  64888. */
  64889. getAndRemove(key: string): Nullable<T>;
  64890. /**
  64891. * Remove a key/value from the dictionary.
  64892. * @param key the key to remove
  64893. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  64894. */
  64895. remove(key: string): boolean;
  64896. /**
  64897. * Clear the whole content of the dictionary
  64898. */
  64899. clear(): void;
  64900. /**
  64901. * Gets the current count
  64902. */
  64903. readonly count: number;
  64904. /**
  64905. * Execute a callback on each key/val of the dictionary.
  64906. * Note that you can remove any element in this dictionary in the callback implementation
  64907. * @param callback the callback to execute on a given key/value pair
  64908. */
  64909. forEach(callback: (key: string, val: T) => void): void;
  64910. /**
  64911. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  64912. * If the callback returns null or undefined the method will iterate to the next key/value pair
  64913. * Note that you can remove any element in this dictionary in the callback implementation
  64914. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  64915. * @returns the first item
  64916. */
  64917. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  64918. private _count;
  64919. private _data;
  64920. }
  64921. }
  64922. declare module BABYLON {
  64923. /**
  64924. * Class used to store gfx data (like WebGLBuffer)
  64925. */
  64926. export class DataBuffer {
  64927. /**
  64928. * Gets or sets the number of objects referencing this buffer
  64929. */
  64930. references: number;
  64931. /** Gets or sets the size of the underlying buffer */
  64932. capacity: number;
  64933. /**
  64934. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  64935. */
  64936. is32Bits: boolean;
  64937. /**
  64938. * Gets the underlying buffer
  64939. */
  64940. readonly underlyingResource: any;
  64941. }
  64942. }
  64943. declare module BABYLON {
  64944. /**
  64945. * Class used to store data that will be store in GPU memory
  64946. */
  64947. export class Buffer {
  64948. private _engine;
  64949. private _buffer;
  64950. /** @hidden */
  64951. _data: Nullable<DataArray>;
  64952. private _updatable;
  64953. private _instanced;
  64954. /**
  64955. * Gets the byte stride.
  64956. */
  64957. readonly byteStride: number;
  64958. /**
  64959. * Constructor
  64960. * @param engine the engine
  64961. * @param data the data to use for this buffer
  64962. * @param updatable whether the data is updatable
  64963. * @param stride the stride (optional)
  64964. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  64965. * @param instanced whether the buffer is instanced (optional)
  64966. * @param useBytes set to true if the stride in in bytes (optional)
  64967. */
  64968. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean);
  64969. /**
  64970. * Create a new VertexBuffer based on the current buffer
  64971. * @param kind defines the vertex buffer kind (position, normal, etc.)
  64972. * @param offset defines offset in the buffer (0 by default)
  64973. * @param size defines the size in floats of attributes (position is 3 for instance)
  64974. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  64975. * @param instanced defines if the vertex buffer contains indexed data
  64976. * @param useBytes defines if the offset and stride are in bytes
  64977. * @returns the new vertex buffer
  64978. */
  64979. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean): VertexBuffer;
  64980. /**
  64981. * Gets a boolean indicating if the Buffer is updatable?
  64982. * @returns true if the buffer is updatable
  64983. */
  64984. isUpdatable(): boolean;
  64985. /**
  64986. * Gets current buffer's data
  64987. * @returns a DataArray or null
  64988. */
  64989. getData(): Nullable<DataArray>;
  64990. /**
  64991. * Gets underlying native buffer
  64992. * @returns underlying native buffer
  64993. */
  64994. getBuffer(): Nullable<DataBuffer>;
  64995. /**
  64996. * Gets the stride in float32 units (i.e. byte stride / 4).
  64997. * May not be an integer if the byte stride is not divisible by 4.
  64998. * DEPRECATED. Use byteStride instead.
  64999. * @returns the stride in float32 units
  65000. */
  65001. getStrideSize(): number;
  65002. /**
  65003. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  65004. * @param data defines the data to store
  65005. */
  65006. create(data?: Nullable<DataArray>): void;
  65007. /** @hidden */
  65008. _rebuild(): void;
  65009. /**
  65010. * Update current buffer data
  65011. * @param data defines the data to store
  65012. */
  65013. update(data: DataArray): void;
  65014. /**
  65015. * Updates the data directly.
  65016. * @param data the new data
  65017. * @param offset the new offset
  65018. * @param vertexCount the vertex count (optional)
  65019. * @param useBytes set to true if the offset is in bytes
  65020. */
  65021. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  65022. /**
  65023. * Release all resources
  65024. */
  65025. dispose(): void;
  65026. }
  65027. /**
  65028. * Specialized buffer used to store vertex data
  65029. */
  65030. export class VertexBuffer {
  65031. /** @hidden */
  65032. _buffer: Buffer;
  65033. private _kind;
  65034. private _size;
  65035. private _ownsBuffer;
  65036. private _instanced;
  65037. private _instanceDivisor;
  65038. /**
  65039. * The byte type.
  65040. */
  65041. static readonly BYTE: number;
  65042. /**
  65043. * The unsigned byte type.
  65044. */
  65045. static readonly UNSIGNED_BYTE: number;
  65046. /**
  65047. * The short type.
  65048. */
  65049. static readonly SHORT: number;
  65050. /**
  65051. * The unsigned short type.
  65052. */
  65053. static readonly UNSIGNED_SHORT: number;
  65054. /**
  65055. * The integer type.
  65056. */
  65057. static readonly INT: number;
  65058. /**
  65059. * The unsigned integer type.
  65060. */
  65061. static readonly UNSIGNED_INT: number;
  65062. /**
  65063. * The float type.
  65064. */
  65065. static readonly FLOAT: number;
  65066. /**
  65067. * Gets or sets the instance divisor when in instanced mode
  65068. */
  65069. instanceDivisor: number;
  65070. /**
  65071. * Gets the byte stride.
  65072. */
  65073. readonly byteStride: number;
  65074. /**
  65075. * Gets the byte offset.
  65076. */
  65077. readonly byteOffset: number;
  65078. /**
  65079. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  65080. */
  65081. readonly normalized: boolean;
  65082. /**
  65083. * Gets the data type of each component in the array.
  65084. */
  65085. readonly type: number;
  65086. /**
  65087. * Constructor
  65088. * @param engine the engine
  65089. * @param data the data to use for this vertex buffer
  65090. * @param kind the vertex buffer kind
  65091. * @param updatable whether the data is updatable
  65092. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  65093. * @param stride the stride (optional)
  65094. * @param instanced whether the buffer is instanced (optional)
  65095. * @param offset the offset of the data (optional)
  65096. * @param size the number of components (optional)
  65097. * @param type the type of the component (optional)
  65098. * @param normalized whether the data contains normalized data (optional)
  65099. * @param useBytes set to true if stride and offset are in bytes (optional)
  65100. */
  65101. 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);
  65102. /** @hidden */
  65103. _rebuild(): void;
  65104. /**
  65105. * Returns the kind of the VertexBuffer (string)
  65106. * @returns a string
  65107. */
  65108. getKind(): string;
  65109. /**
  65110. * Gets a boolean indicating if the VertexBuffer is updatable?
  65111. * @returns true if the buffer is updatable
  65112. */
  65113. isUpdatable(): boolean;
  65114. /**
  65115. * Gets current buffer's data
  65116. * @returns a DataArray or null
  65117. */
  65118. getData(): Nullable<DataArray>;
  65119. /**
  65120. * Gets underlying native buffer
  65121. * @returns underlying native buffer
  65122. */
  65123. getBuffer(): Nullable<DataBuffer>;
  65124. /**
  65125. * Gets the stride in float32 units (i.e. byte stride / 4).
  65126. * May not be an integer if the byte stride is not divisible by 4.
  65127. * DEPRECATED. Use byteStride instead.
  65128. * @returns the stride in float32 units
  65129. */
  65130. getStrideSize(): number;
  65131. /**
  65132. * Returns the offset as a multiple of the type byte length.
  65133. * DEPRECATED. Use byteOffset instead.
  65134. * @returns the offset in bytes
  65135. */
  65136. getOffset(): number;
  65137. /**
  65138. * Returns the number of components per vertex attribute (integer)
  65139. * @returns the size in float
  65140. */
  65141. getSize(): number;
  65142. /**
  65143. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  65144. * @returns true if this buffer is instanced
  65145. */
  65146. getIsInstanced(): boolean;
  65147. /**
  65148. * Returns the instancing divisor, zero for non-instanced (integer).
  65149. * @returns a number
  65150. */
  65151. getInstanceDivisor(): number;
  65152. /**
  65153. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  65154. * @param data defines the data to store
  65155. */
  65156. create(data?: DataArray): void;
  65157. /**
  65158. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  65159. * This function will create a new buffer if the current one is not updatable
  65160. * @param data defines the data to store
  65161. */
  65162. update(data: DataArray): void;
  65163. /**
  65164. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  65165. * Returns the directly updated WebGLBuffer.
  65166. * @param data the new data
  65167. * @param offset the new offset
  65168. * @param useBytes set to true if the offset is in bytes
  65169. */
  65170. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  65171. /**
  65172. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  65173. */
  65174. dispose(): void;
  65175. /**
  65176. * Enumerates each value of this vertex buffer as numbers.
  65177. * @param count the number of values to enumerate
  65178. * @param callback the callback function called for each value
  65179. */
  65180. forEach(count: number, callback: (value: number, index: number) => void): void;
  65181. /**
  65182. * Positions
  65183. */
  65184. static readonly PositionKind: string;
  65185. /**
  65186. * Normals
  65187. */
  65188. static readonly NormalKind: string;
  65189. /**
  65190. * Tangents
  65191. */
  65192. static readonly TangentKind: string;
  65193. /**
  65194. * Texture coordinates
  65195. */
  65196. static readonly UVKind: string;
  65197. /**
  65198. * Texture coordinates 2
  65199. */
  65200. static readonly UV2Kind: string;
  65201. /**
  65202. * Texture coordinates 3
  65203. */
  65204. static readonly UV3Kind: string;
  65205. /**
  65206. * Texture coordinates 4
  65207. */
  65208. static readonly UV4Kind: string;
  65209. /**
  65210. * Texture coordinates 5
  65211. */
  65212. static readonly UV5Kind: string;
  65213. /**
  65214. * Texture coordinates 6
  65215. */
  65216. static readonly UV6Kind: string;
  65217. /**
  65218. * Colors
  65219. */
  65220. static readonly ColorKind: string;
  65221. /**
  65222. * Matrix indices (for bones)
  65223. */
  65224. static readonly MatricesIndicesKind: string;
  65225. /**
  65226. * Matrix weights (for bones)
  65227. */
  65228. static readonly MatricesWeightsKind: string;
  65229. /**
  65230. * Additional matrix indices (for bones)
  65231. */
  65232. static readonly MatricesIndicesExtraKind: string;
  65233. /**
  65234. * Additional matrix weights (for bones)
  65235. */
  65236. static readonly MatricesWeightsExtraKind: string;
  65237. /**
  65238. * Deduces the stride given a kind.
  65239. * @param kind The kind string to deduce
  65240. * @returns The deduced stride
  65241. */
  65242. static DeduceStride(kind: string): number;
  65243. /**
  65244. * Gets the byte length of the given type.
  65245. * @param type the type
  65246. * @returns the number of bytes
  65247. */
  65248. static GetTypeByteLength(type: number): number;
  65249. /**
  65250. * Enumerates each value of the given parameters as numbers.
  65251. * @param data the data to enumerate
  65252. * @param byteOffset the byte offset of the data
  65253. * @param byteStride the byte stride of the data
  65254. * @param componentCount the number of components per element
  65255. * @param componentType the type of the component
  65256. * @param count the number of values to enumerate
  65257. * @param normalized whether the data is normalized
  65258. * @param callback the callback function called for each value
  65259. */
  65260. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  65261. private static _GetFloatValue;
  65262. }
  65263. }
  65264. declare module BABYLON {
  65265. /**
  65266. * Scalar computation library
  65267. */
  65268. export class Scalar {
  65269. /**
  65270. * Two pi constants convenient for computation.
  65271. */
  65272. static TwoPi: number;
  65273. /**
  65274. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  65275. * @param a number
  65276. * @param b number
  65277. * @param epsilon (default = 1.401298E-45)
  65278. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  65279. */
  65280. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  65281. /**
  65282. * Returns a string : the upper case translation of the number i to hexadecimal.
  65283. * @param i number
  65284. * @returns the upper case translation of the number i to hexadecimal.
  65285. */
  65286. static ToHex(i: number): string;
  65287. /**
  65288. * Returns -1 if value is negative and +1 is value is positive.
  65289. * @param value the value
  65290. * @returns the value itself if it's equal to zero.
  65291. */
  65292. static Sign(value: number): number;
  65293. /**
  65294. * Returns the value itself if it's between min and max.
  65295. * Returns min if the value is lower than min.
  65296. * Returns max if the value is greater than max.
  65297. * @param value the value to clmap
  65298. * @param min the min value to clamp to (default: 0)
  65299. * @param max the max value to clamp to (default: 1)
  65300. * @returns the clamped value
  65301. */
  65302. static Clamp(value: number, min?: number, max?: number): number;
  65303. /**
  65304. * the log2 of value.
  65305. * @param value the value to compute log2 of
  65306. * @returns the log2 of value.
  65307. */
  65308. static Log2(value: number): number;
  65309. /**
  65310. * Loops the value, so that it is never larger than length and never smaller than 0.
  65311. *
  65312. * This is similar to the modulo operator but it works with floating point numbers.
  65313. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  65314. * With t = 5 and length = 2.5, the result would be 0.0.
  65315. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  65316. * @param value the value
  65317. * @param length the length
  65318. * @returns the looped value
  65319. */
  65320. static Repeat(value: number, length: number): number;
  65321. /**
  65322. * Normalize the value between 0.0 and 1.0 using min and max values
  65323. * @param value value to normalize
  65324. * @param min max to normalize between
  65325. * @param max min to normalize between
  65326. * @returns the normalized value
  65327. */
  65328. static Normalize(value: number, min: number, max: number): number;
  65329. /**
  65330. * Denormalize the value from 0.0 and 1.0 using min and max values
  65331. * @param normalized value to denormalize
  65332. * @param min max to denormalize between
  65333. * @param max min to denormalize between
  65334. * @returns the denormalized value
  65335. */
  65336. static Denormalize(normalized: number, min: number, max: number): number;
  65337. /**
  65338. * Calculates the shortest difference between two given angles given in degrees.
  65339. * @param current current angle in degrees
  65340. * @param target target angle in degrees
  65341. * @returns the delta
  65342. */
  65343. static DeltaAngle(current: number, target: number): number;
  65344. /**
  65345. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  65346. * @param tx value
  65347. * @param length length
  65348. * @returns The returned value will move back and forth between 0 and length
  65349. */
  65350. static PingPong(tx: number, length: number): number;
  65351. /**
  65352. * Interpolates between min and max with smoothing at the limits.
  65353. *
  65354. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  65355. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  65356. * @param from from
  65357. * @param to to
  65358. * @param tx value
  65359. * @returns the smooth stepped value
  65360. */
  65361. static SmoothStep(from: number, to: number, tx: number): number;
  65362. /**
  65363. * Moves a value current towards target.
  65364. *
  65365. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  65366. * Negative values of maxDelta pushes the value away from target.
  65367. * @param current current value
  65368. * @param target target value
  65369. * @param maxDelta max distance to move
  65370. * @returns resulting value
  65371. */
  65372. static MoveTowards(current: number, target: number, maxDelta: number): number;
  65373. /**
  65374. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  65375. *
  65376. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  65377. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  65378. * @param current current value
  65379. * @param target target value
  65380. * @param maxDelta max distance to move
  65381. * @returns resulting angle
  65382. */
  65383. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  65384. /**
  65385. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  65386. * @param start start value
  65387. * @param end target value
  65388. * @param amount amount to lerp between
  65389. * @returns the lerped value
  65390. */
  65391. static Lerp(start: number, end: number, amount: number): number;
  65392. /**
  65393. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  65394. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  65395. * @param start start value
  65396. * @param end target value
  65397. * @param amount amount to lerp between
  65398. * @returns the lerped value
  65399. */
  65400. static LerpAngle(start: number, end: number, amount: number): number;
  65401. /**
  65402. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  65403. * @param a start value
  65404. * @param b target value
  65405. * @param value value between a and b
  65406. * @returns the inverseLerp value
  65407. */
  65408. static InverseLerp(a: number, b: number, value: number): number;
  65409. /**
  65410. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  65411. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  65412. * @param value1 spline value
  65413. * @param tangent1 spline value
  65414. * @param value2 spline value
  65415. * @param tangent2 spline value
  65416. * @param amount input value
  65417. * @returns hermite result
  65418. */
  65419. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  65420. /**
  65421. * Returns a random float number between and min and max values
  65422. * @param min min value of random
  65423. * @param max max value of random
  65424. * @returns random value
  65425. */
  65426. static RandomRange(min: number, max: number): number;
  65427. /**
  65428. * This function returns percentage of a number in a given range.
  65429. *
  65430. * RangeToPercent(40,20,60) will return 0.5 (50%)
  65431. * RangeToPercent(34,0,100) will return 0.34 (34%)
  65432. * @param number to convert to percentage
  65433. * @param min min range
  65434. * @param max max range
  65435. * @returns the percentage
  65436. */
  65437. static RangeToPercent(number: number, min: number, max: number): number;
  65438. /**
  65439. * This function returns number that corresponds to the percentage in a given range.
  65440. *
  65441. * PercentToRange(0.34,0,100) will return 34.
  65442. * @param percent to convert to number
  65443. * @param min min range
  65444. * @param max max range
  65445. * @returns the number
  65446. */
  65447. static PercentToRange(percent: number, min: number, max: number): number;
  65448. /**
  65449. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  65450. * @param angle The angle to normalize in radian.
  65451. * @return The converted angle.
  65452. */
  65453. static NormalizeRadians(angle: number): number;
  65454. }
  65455. }
  65456. declare module BABYLON {
  65457. /**
  65458. * Constant used to convert a value to gamma space
  65459. * @ignorenaming
  65460. */
  65461. export const ToGammaSpace: number;
  65462. /**
  65463. * Constant used to convert a value to linear space
  65464. * @ignorenaming
  65465. */
  65466. export const ToLinearSpace = 2.2;
  65467. /**
  65468. * Constant used to define the minimal number value in Babylon.js
  65469. * @ignorenaming
  65470. */
  65471. let Epsilon: number;
  65472. }
  65473. declare module BABYLON {
  65474. /**
  65475. * Class used to represent a viewport on screen
  65476. */
  65477. export class Viewport {
  65478. /** viewport left coordinate */
  65479. x: number;
  65480. /** viewport top coordinate */
  65481. y: number;
  65482. /**viewport width */
  65483. width: number;
  65484. /** viewport height */
  65485. height: number;
  65486. /**
  65487. * Creates a Viewport object located at (x, y) and sized (width, height)
  65488. * @param x defines viewport left coordinate
  65489. * @param y defines viewport top coordinate
  65490. * @param width defines the viewport width
  65491. * @param height defines the viewport height
  65492. */
  65493. constructor(
  65494. /** viewport left coordinate */
  65495. x: number,
  65496. /** viewport top coordinate */
  65497. y: number,
  65498. /**viewport width */
  65499. width: number,
  65500. /** viewport height */
  65501. height: number);
  65502. /**
  65503. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  65504. * @param renderWidth defines the rendering width
  65505. * @param renderHeight defines the rendering height
  65506. * @returns a new Viewport
  65507. */
  65508. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  65509. /**
  65510. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  65511. * @param renderWidth defines the rendering width
  65512. * @param renderHeight defines the rendering height
  65513. * @param ref defines the target viewport
  65514. * @returns the current viewport
  65515. */
  65516. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  65517. /**
  65518. * Returns a new Viewport copied from the current one
  65519. * @returns a new Viewport
  65520. */
  65521. clone(): Viewport;
  65522. }
  65523. }
  65524. declare module BABYLON {
  65525. /**
  65526. * Class containing a set of static utilities functions for arrays.
  65527. */
  65528. export class ArrayTools {
  65529. /**
  65530. * Returns an array of the given size filled with element built from the given constructor and the paramters
  65531. * @param size the number of element to construct and put in the array
  65532. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  65533. * @returns a new array filled with new objects
  65534. */
  65535. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  65536. }
  65537. }
  65538. declare module BABYLON {
  65539. /**
  65540. * @hidden
  65541. */
  65542. export interface IColor4Like {
  65543. r: float;
  65544. g: float;
  65545. b: float;
  65546. a: float;
  65547. }
  65548. /**
  65549. * @hidden
  65550. */
  65551. export interface IColor3Like {
  65552. r: float;
  65553. g: float;
  65554. b: float;
  65555. }
  65556. /**
  65557. * @hidden
  65558. */
  65559. export interface IVector4Like {
  65560. x: float;
  65561. y: float;
  65562. z: float;
  65563. w: float;
  65564. }
  65565. /**
  65566. * @hidden
  65567. */
  65568. export interface IVector3Like {
  65569. x: float;
  65570. y: float;
  65571. z: float;
  65572. }
  65573. /**
  65574. * @hidden
  65575. */
  65576. export interface IVector2Like {
  65577. x: float;
  65578. y: float;
  65579. }
  65580. /**
  65581. * @hidden
  65582. */
  65583. export interface IMatrixLike {
  65584. toArray(): DeepImmutable<Float32Array>;
  65585. updateFlag: int;
  65586. }
  65587. /**
  65588. * @hidden
  65589. */
  65590. export interface IViewportLike {
  65591. x: float;
  65592. y: float;
  65593. width: float;
  65594. height: float;
  65595. }
  65596. /**
  65597. * @hidden
  65598. */
  65599. export interface IPlaneLike {
  65600. normal: IVector3Like;
  65601. d: float;
  65602. normalize(): void;
  65603. }
  65604. }
  65605. declare module BABYLON {
  65606. /**
  65607. * Class representing a vector containing 2 coordinates
  65608. */
  65609. export class Vector2 {
  65610. /** defines the first coordinate */
  65611. x: number;
  65612. /** defines the second coordinate */
  65613. y: number;
  65614. /**
  65615. * Creates a new Vector2 from the given x and y coordinates
  65616. * @param x defines the first coordinate
  65617. * @param y defines the second coordinate
  65618. */
  65619. constructor(
  65620. /** defines the first coordinate */
  65621. x?: number,
  65622. /** defines the second coordinate */
  65623. y?: number);
  65624. /**
  65625. * Gets a string with the Vector2 coordinates
  65626. * @returns a string with the Vector2 coordinates
  65627. */
  65628. toString(): string;
  65629. /**
  65630. * Gets class name
  65631. * @returns the string "Vector2"
  65632. */
  65633. getClassName(): string;
  65634. /**
  65635. * Gets current vector hash code
  65636. * @returns the Vector2 hash code as a number
  65637. */
  65638. getHashCode(): number;
  65639. /**
  65640. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  65641. * @param array defines the source array
  65642. * @param index defines the offset in source array
  65643. * @returns the current Vector2
  65644. */
  65645. toArray(array: FloatArray, index?: number): Vector2;
  65646. /**
  65647. * Copy the current vector to an array
  65648. * @returns a new array with 2 elements: the Vector2 coordinates.
  65649. */
  65650. asArray(): number[];
  65651. /**
  65652. * Sets the Vector2 coordinates with the given Vector2 coordinates
  65653. * @param source defines the source Vector2
  65654. * @returns the current updated Vector2
  65655. */
  65656. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  65657. /**
  65658. * Sets the Vector2 coordinates with the given floats
  65659. * @param x defines the first coordinate
  65660. * @param y defines the second coordinate
  65661. * @returns the current updated Vector2
  65662. */
  65663. copyFromFloats(x: number, y: number): Vector2;
  65664. /**
  65665. * Sets the Vector2 coordinates with the given floats
  65666. * @param x defines the first coordinate
  65667. * @param y defines the second coordinate
  65668. * @returns the current updated Vector2
  65669. */
  65670. set(x: number, y: number): Vector2;
  65671. /**
  65672. * Add another vector with the current one
  65673. * @param otherVector defines the other vector
  65674. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  65675. */
  65676. add(otherVector: DeepImmutable<Vector2>): Vector2;
  65677. /**
  65678. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  65679. * @param otherVector defines the other vector
  65680. * @param result defines the target vector
  65681. * @returns the unmodified current Vector2
  65682. */
  65683. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  65684. /**
  65685. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  65686. * @param otherVector defines the other vector
  65687. * @returns the current updated Vector2
  65688. */
  65689. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  65690. /**
  65691. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  65692. * @param otherVector defines the other vector
  65693. * @returns a new Vector2
  65694. */
  65695. addVector3(otherVector: Vector3): Vector2;
  65696. /**
  65697. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  65698. * @param otherVector defines the other vector
  65699. * @returns a new Vector2
  65700. */
  65701. subtract(otherVector: Vector2): Vector2;
  65702. /**
  65703. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  65704. * @param otherVector defines the other vector
  65705. * @param result defines the target vector
  65706. * @returns the unmodified current Vector2
  65707. */
  65708. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  65709. /**
  65710. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  65711. * @param otherVector defines the other vector
  65712. * @returns the current updated Vector2
  65713. */
  65714. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  65715. /**
  65716. * Multiplies in place the current Vector2 coordinates by the given ones
  65717. * @param otherVector defines the other vector
  65718. * @returns the current updated Vector2
  65719. */
  65720. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  65721. /**
  65722. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  65723. * @param otherVector defines the other vector
  65724. * @returns a new Vector2
  65725. */
  65726. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  65727. /**
  65728. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  65729. * @param otherVector defines the other vector
  65730. * @param result defines the target vector
  65731. * @returns the unmodified current Vector2
  65732. */
  65733. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  65734. /**
  65735. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  65736. * @param x defines the first coordinate
  65737. * @param y defines the second coordinate
  65738. * @returns a new Vector2
  65739. */
  65740. multiplyByFloats(x: number, y: number): Vector2;
  65741. /**
  65742. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  65743. * @param otherVector defines the other vector
  65744. * @returns a new Vector2
  65745. */
  65746. divide(otherVector: Vector2): Vector2;
  65747. /**
  65748. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  65749. * @param otherVector defines the other vector
  65750. * @param result defines the target vector
  65751. * @returns the unmodified current Vector2
  65752. */
  65753. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  65754. /**
  65755. * Divides the current Vector2 coordinates by the given ones
  65756. * @param otherVector defines the other vector
  65757. * @returns the current updated Vector2
  65758. */
  65759. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  65760. /**
  65761. * Gets a new Vector2 with current Vector2 negated coordinates
  65762. * @returns a new Vector2
  65763. */
  65764. negate(): Vector2;
  65765. /**
  65766. * Multiply the Vector2 coordinates by scale
  65767. * @param scale defines the scaling factor
  65768. * @returns the current updated Vector2
  65769. */
  65770. scaleInPlace(scale: number): Vector2;
  65771. /**
  65772. * Returns a new Vector2 scaled by "scale" from the current Vector2
  65773. * @param scale defines the scaling factor
  65774. * @returns a new Vector2
  65775. */
  65776. scale(scale: number): Vector2;
  65777. /**
  65778. * Scale the current Vector2 values by a factor to a given Vector2
  65779. * @param scale defines the scale factor
  65780. * @param result defines the Vector2 object where to store the result
  65781. * @returns the unmodified current Vector2
  65782. */
  65783. scaleToRef(scale: number, result: Vector2): Vector2;
  65784. /**
  65785. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  65786. * @param scale defines the scale factor
  65787. * @param result defines the Vector2 object where to store the result
  65788. * @returns the unmodified current Vector2
  65789. */
  65790. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  65791. /**
  65792. * Gets a boolean if two vectors are equals
  65793. * @param otherVector defines the other vector
  65794. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  65795. */
  65796. equals(otherVector: DeepImmutable<Vector2>): boolean;
  65797. /**
  65798. * Gets a boolean if two vectors are equals (using an epsilon value)
  65799. * @param otherVector defines the other vector
  65800. * @param epsilon defines the minimal distance to consider equality
  65801. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  65802. */
  65803. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  65804. /**
  65805. * Gets a new Vector2 from current Vector2 floored values
  65806. * @returns a new Vector2
  65807. */
  65808. floor(): Vector2;
  65809. /**
  65810. * Gets a new Vector2 from current Vector2 floored values
  65811. * @returns a new Vector2
  65812. */
  65813. fract(): Vector2;
  65814. /**
  65815. * Gets the length of the vector
  65816. * @returns the vector length (float)
  65817. */
  65818. length(): number;
  65819. /**
  65820. * Gets the vector squared length
  65821. * @returns the vector squared length (float)
  65822. */
  65823. lengthSquared(): number;
  65824. /**
  65825. * Normalize the vector
  65826. * @returns the current updated Vector2
  65827. */
  65828. normalize(): Vector2;
  65829. /**
  65830. * Gets a new Vector2 copied from the Vector2
  65831. * @returns a new Vector2
  65832. */
  65833. clone(): Vector2;
  65834. /**
  65835. * Gets a new Vector2(0, 0)
  65836. * @returns a new Vector2
  65837. */
  65838. static Zero(): Vector2;
  65839. /**
  65840. * Gets a new Vector2(1, 1)
  65841. * @returns a new Vector2
  65842. */
  65843. static One(): Vector2;
  65844. /**
  65845. * Gets a new Vector2 set from the given index element of the given array
  65846. * @param array defines the data source
  65847. * @param offset defines the offset in the data source
  65848. * @returns a new Vector2
  65849. */
  65850. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  65851. /**
  65852. * Sets "result" from the given index element of the given array
  65853. * @param array defines the data source
  65854. * @param offset defines the offset in the data source
  65855. * @param result defines the target vector
  65856. */
  65857. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  65858. /**
  65859. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  65860. * @param value1 defines 1st point of control
  65861. * @param value2 defines 2nd point of control
  65862. * @param value3 defines 3rd point of control
  65863. * @param value4 defines 4th point of control
  65864. * @param amount defines the interpolation factor
  65865. * @returns a new Vector2
  65866. */
  65867. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  65868. /**
  65869. * 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".
  65870. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  65871. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  65872. * @param value defines the value to clamp
  65873. * @param min defines the lower limit
  65874. * @param max defines the upper limit
  65875. * @returns a new Vector2
  65876. */
  65877. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  65878. /**
  65879. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  65880. * @param value1 defines the 1st control point
  65881. * @param tangent1 defines the outgoing tangent
  65882. * @param value2 defines the 2nd control point
  65883. * @param tangent2 defines the incoming tangent
  65884. * @param amount defines the interpolation factor
  65885. * @returns a new Vector2
  65886. */
  65887. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  65888. /**
  65889. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  65890. * @param start defines the start vector
  65891. * @param end defines the end vector
  65892. * @param amount defines the interpolation factor
  65893. * @returns a new Vector2
  65894. */
  65895. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  65896. /**
  65897. * Gets the dot product of the vector "left" and the vector "right"
  65898. * @param left defines first vector
  65899. * @param right defines second vector
  65900. * @returns the dot product (float)
  65901. */
  65902. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  65903. /**
  65904. * Returns a new Vector2 equal to the normalized given vector
  65905. * @param vector defines the vector to normalize
  65906. * @returns a new Vector2
  65907. */
  65908. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  65909. /**
  65910. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  65911. * @param left defines 1st vector
  65912. * @param right defines 2nd vector
  65913. * @returns a new Vector2
  65914. */
  65915. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  65916. /**
  65917. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  65918. * @param left defines 1st vector
  65919. * @param right defines 2nd vector
  65920. * @returns a new Vector2
  65921. */
  65922. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  65923. /**
  65924. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  65925. * @param vector defines the vector to transform
  65926. * @param transformation defines the matrix to apply
  65927. * @returns a new Vector2
  65928. */
  65929. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  65930. /**
  65931. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  65932. * @param vector defines the vector to transform
  65933. * @param transformation defines the matrix to apply
  65934. * @param result defines the target vector
  65935. */
  65936. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  65937. /**
  65938. * Determines if a given vector is included in a triangle
  65939. * @param p defines the vector to test
  65940. * @param p0 defines 1st triangle point
  65941. * @param p1 defines 2nd triangle point
  65942. * @param p2 defines 3rd triangle point
  65943. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  65944. */
  65945. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  65946. /**
  65947. * Gets the distance between the vectors "value1" and "value2"
  65948. * @param value1 defines first vector
  65949. * @param value2 defines second vector
  65950. * @returns the distance between vectors
  65951. */
  65952. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  65953. /**
  65954. * Returns the squared distance between the vectors "value1" and "value2"
  65955. * @param value1 defines first vector
  65956. * @param value2 defines second vector
  65957. * @returns the squared distance between vectors
  65958. */
  65959. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  65960. /**
  65961. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  65962. * @param value1 defines first vector
  65963. * @param value2 defines second vector
  65964. * @returns a new Vector2
  65965. */
  65966. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  65967. /**
  65968. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  65969. * @param p defines the middle point
  65970. * @param segA defines one point of the segment
  65971. * @param segB defines the other point of the segment
  65972. * @returns the shortest distance
  65973. */
  65974. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  65975. }
  65976. /**
  65977. * Classed used to store (x,y,z) vector representation
  65978. * A Vector3 is the main object used in 3D geometry
  65979. * It can represent etiher the coordinates of a point the space, either a direction
  65980. * Reminder: js uses a left handed forward facing system
  65981. */
  65982. export class Vector3 {
  65983. /**
  65984. * Defines the first coordinates (on X axis)
  65985. */
  65986. x: number;
  65987. /**
  65988. * Defines the second coordinates (on Y axis)
  65989. */
  65990. y: number;
  65991. /**
  65992. * Defines the third coordinates (on Z axis)
  65993. */
  65994. z: number;
  65995. private static _UpReadOnly;
  65996. private static _ZeroReadOnly;
  65997. /**
  65998. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  65999. * @param x defines the first coordinates (on X axis)
  66000. * @param y defines the second coordinates (on Y axis)
  66001. * @param z defines the third coordinates (on Z axis)
  66002. */
  66003. constructor(
  66004. /**
  66005. * Defines the first coordinates (on X axis)
  66006. */
  66007. x?: number,
  66008. /**
  66009. * Defines the second coordinates (on Y axis)
  66010. */
  66011. y?: number,
  66012. /**
  66013. * Defines the third coordinates (on Z axis)
  66014. */
  66015. z?: number);
  66016. /**
  66017. * Creates a string representation of the Vector3
  66018. * @returns a string with the Vector3 coordinates.
  66019. */
  66020. toString(): string;
  66021. /**
  66022. * Gets the class name
  66023. * @returns the string "Vector3"
  66024. */
  66025. getClassName(): string;
  66026. /**
  66027. * Creates the Vector3 hash code
  66028. * @returns a number which tends to be unique between Vector3 instances
  66029. */
  66030. getHashCode(): number;
  66031. /**
  66032. * Creates an array containing three elements : the coordinates of the Vector3
  66033. * @returns a new array of numbers
  66034. */
  66035. asArray(): number[];
  66036. /**
  66037. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  66038. * @param array defines the destination array
  66039. * @param index defines the offset in the destination array
  66040. * @returns the current Vector3
  66041. */
  66042. toArray(array: FloatArray, index?: number): Vector3;
  66043. /**
  66044. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  66045. * @returns a new Quaternion object, computed from the Vector3 coordinates
  66046. */
  66047. toQuaternion(): Quaternion;
  66048. /**
  66049. * Adds the given vector to the current Vector3
  66050. * @param otherVector defines the second operand
  66051. * @returns the current updated Vector3
  66052. */
  66053. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  66054. /**
  66055. * Adds the given coordinates to the current Vector3
  66056. * @param x defines the x coordinate of the operand
  66057. * @param y defines the y coordinate of the operand
  66058. * @param z defines the z coordinate of the operand
  66059. * @returns the current updated Vector3
  66060. */
  66061. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  66062. /**
  66063. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  66064. * @param otherVector defines the second operand
  66065. * @returns the resulting Vector3
  66066. */
  66067. add(otherVector: DeepImmutable<Vector3>): Vector3;
  66068. /**
  66069. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  66070. * @param otherVector defines the second operand
  66071. * @param result defines the Vector3 object where to store the result
  66072. * @returns the current Vector3
  66073. */
  66074. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  66075. /**
  66076. * Subtract the given vector from the current Vector3
  66077. * @param otherVector defines the second operand
  66078. * @returns the current updated Vector3
  66079. */
  66080. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  66081. /**
  66082. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  66083. * @param otherVector defines the second operand
  66084. * @returns the resulting Vector3
  66085. */
  66086. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  66087. /**
  66088. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  66089. * @param otherVector defines the second operand
  66090. * @param result defines the Vector3 object where to store the result
  66091. * @returns the current Vector3
  66092. */
  66093. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  66094. /**
  66095. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  66096. * @param x defines the x coordinate of the operand
  66097. * @param y defines the y coordinate of the operand
  66098. * @param z defines the z coordinate of the operand
  66099. * @returns the resulting Vector3
  66100. */
  66101. subtractFromFloats(x: number, y: number, z: number): Vector3;
  66102. /**
  66103. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  66104. * @param x defines the x coordinate of the operand
  66105. * @param y defines the y coordinate of the operand
  66106. * @param z defines the z coordinate of the operand
  66107. * @param result defines the Vector3 object where to store the result
  66108. * @returns the current Vector3
  66109. */
  66110. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  66111. /**
  66112. * Gets a new Vector3 set with the current Vector3 negated coordinates
  66113. * @returns a new Vector3
  66114. */
  66115. negate(): Vector3;
  66116. /**
  66117. * Multiplies the Vector3 coordinates by the float "scale"
  66118. * @param scale defines the multiplier factor
  66119. * @returns the current updated Vector3
  66120. */
  66121. scaleInPlace(scale: number): Vector3;
  66122. /**
  66123. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  66124. * @param scale defines the multiplier factor
  66125. * @returns a new Vector3
  66126. */
  66127. scale(scale: number): Vector3;
  66128. /**
  66129. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  66130. * @param scale defines the multiplier factor
  66131. * @param result defines the Vector3 object where to store the result
  66132. * @returns the current Vector3
  66133. */
  66134. scaleToRef(scale: number, result: Vector3): Vector3;
  66135. /**
  66136. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  66137. * @param scale defines the scale factor
  66138. * @param result defines the Vector3 object where to store the result
  66139. * @returns the unmodified current Vector3
  66140. */
  66141. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  66142. /**
  66143. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  66144. * @param otherVector defines the second operand
  66145. * @returns true if both vectors are equals
  66146. */
  66147. equals(otherVector: DeepImmutable<Vector3>): boolean;
  66148. /**
  66149. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  66150. * @param otherVector defines the second operand
  66151. * @param epsilon defines the minimal distance to define values as equals
  66152. * @returns true if both vectors are distant less than epsilon
  66153. */
  66154. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  66155. /**
  66156. * Returns true if the current Vector3 coordinates equals the given floats
  66157. * @param x defines the x coordinate of the operand
  66158. * @param y defines the y coordinate of the operand
  66159. * @param z defines the z coordinate of the operand
  66160. * @returns true if both vectors are equals
  66161. */
  66162. equalsToFloats(x: number, y: number, z: number): boolean;
  66163. /**
  66164. * Multiplies the current Vector3 coordinates by the given ones
  66165. * @param otherVector defines the second operand
  66166. * @returns the current updated Vector3
  66167. */
  66168. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  66169. /**
  66170. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  66171. * @param otherVector defines the second operand
  66172. * @returns the new Vector3
  66173. */
  66174. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  66175. /**
  66176. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  66177. * @param otherVector defines the second operand
  66178. * @param result defines the Vector3 object where to store the result
  66179. * @returns the current Vector3
  66180. */
  66181. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  66182. /**
  66183. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  66184. * @param x defines the x coordinate of the operand
  66185. * @param y defines the y coordinate of the operand
  66186. * @param z defines the z coordinate of the operand
  66187. * @returns the new Vector3
  66188. */
  66189. multiplyByFloats(x: number, y: number, z: number): Vector3;
  66190. /**
  66191. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  66192. * @param otherVector defines the second operand
  66193. * @returns the new Vector3
  66194. */
  66195. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  66196. /**
  66197. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  66198. * @param otherVector defines the second operand
  66199. * @param result defines the Vector3 object where to store the result
  66200. * @returns the current Vector3
  66201. */
  66202. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  66203. /**
  66204. * Divides the current Vector3 coordinates by the given ones.
  66205. * @param otherVector defines the second operand
  66206. * @returns the current updated Vector3
  66207. */
  66208. divideInPlace(otherVector: Vector3): Vector3;
  66209. /**
  66210. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  66211. * @param other defines the second operand
  66212. * @returns the current updated Vector3
  66213. */
  66214. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  66215. /**
  66216. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  66217. * @param other defines the second operand
  66218. * @returns the current updated Vector3
  66219. */
  66220. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  66221. /**
  66222. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  66223. * @param x defines the x coordinate of the operand
  66224. * @param y defines the y coordinate of the operand
  66225. * @param z defines the z coordinate of the operand
  66226. * @returns the current updated Vector3
  66227. */
  66228. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  66229. /**
  66230. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  66231. * @param x defines the x coordinate of the operand
  66232. * @param y defines the y coordinate of the operand
  66233. * @param z defines the z coordinate of the operand
  66234. * @returns the current updated Vector3
  66235. */
  66236. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  66237. /**
  66238. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  66239. * Check if is non uniform within a certain amount of decimal places to account for this
  66240. * @param epsilon the amount the values can differ
  66241. * @returns if the the vector is non uniform to a certain number of decimal places
  66242. */
  66243. isNonUniformWithinEpsilon(epsilon: number): boolean;
  66244. /**
  66245. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  66246. */
  66247. readonly isNonUniform: boolean;
  66248. /**
  66249. * Gets a new Vector3 from current Vector3 floored values
  66250. * @returns a new Vector3
  66251. */
  66252. floor(): Vector3;
  66253. /**
  66254. * Gets a new Vector3 from current Vector3 floored values
  66255. * @returns a new Vector3
  66256. */
  66257. fract(): Vector3;
  66258. /**
  66259. * Gets the length of the Vector3
  66260. * @returns the length of the Vector3
  66261. */
  66262. length(): number;
  66263. /**
  66264. * Gets the squared length of the Vector3
  66265. * @returns squared length of the Vector3
  66266. */
  66267. lengthSquared(): number;
  66268. /**
  66269. * Normalize the current Vector3.
  66270. * Please note that this is an in place operation.
  66271. * @returns the current updated Vector3
  66272. */
  66273. normalize(): Vector3;
  66274. /**
  66275. * Reorders the x y z properties of the vector in place
  66276. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  66277. * @returns the current updated vector
  66278. */
  66279. reorderInPlace(order: string): this;
  66280. /**
  66281. * Rotates the vector around 0,0,0 by a quaternion
  66282. * @param quaternion the rotation quaternion
  66283. * @param result vector to store the result
  66284. * @returns the resulting vector
  66285. */
  66286. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  66287. /**
  66288. * Rotates a vector around a given point
  66289. * @param quaternion the rotation quaternion
  66290. * @param point the point to rotate around
  66291. * @param result vector to store the result
  66292. * @returns the resulting vector
  66293. */
  66294. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  66295. /**
  66296. * Normalize the current Vector3 with the given input length.
  66297. * Please note that this is an in place operation.
  66298. * @param len the length of the vector
  66299. * @returns the current updated Vector3
  66300. */
  66301. normalizeFromLength(len: number): Vector3;
  66302. /**
  66303. * Normalize the current Vector3 to a new vector
  66304. * @returns the new Vector3
  66305. */
  66306. normalizeToNew(): Vector3;
  66307. /**
  66308. * Normalize the current Vector3 to the reference
  66309. * @param reference define the Vector3 to update
  66310. * @returns the updated Vector3
  66311. */
  66312. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  66313. /**
  66314. * Creates a new Vector3 copied from the current Vector3
  66315. * @returns the new Vector3
  66316. */
  66317. clone(): Vector3;
  66318. /**
  66319. * Copies the given vector coordinates to the current Vector3 ones
  66320. * @param source defines the source Vector3
  66321. * @returns the current updated Vector3
  66322. */
  66323. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  66324. /**
  66325. * Copies the given floats to the current Vector3 coordinates
  66326. * @param x defines the x coordinate of the operand
  66327. * @param y defines the y coordinate of the operand
  66328. * @param z defines the z coordinate of the operand
  66329. * @returns the current updated Vector3
  66330. */
  66331. copyFromFloats(x: number, y: number, z: number): Vector3;
  66332. /**
  66333. * Copies the given floats to the current Vector3 coordinates
  66334. * @param x defines the x coordinate of the operand
  66335. * @param y defines the y coordinate of the operand
  66336. * @param z defines the z coordinate of the operand
  66337. * @returns the current updated Vector3
  66338. */
  66339. set(x: number, y: number, z: number): Vector3;
  66340. /**
  66341. * Copies the given float to the current Vector3 coordinates
  66342. * @param v defines the x, y and z coordinates of the operand
  66343. * @returns the current updated Vector3
  66344. */
  66345. setAll(v: number): Vector3;
  66346. /**
  66347. * Get the clip factor between two vectors
  66348. * @param vector0 defines the first operand
  66349. * @param vector1 defines the second operand
  66350. * @param axis defines the axis to use
  66351. * @param size defines the size along the axis
  66352. * @returns the clip factor
  66353. */
  66354. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  66355. /**
  66356. * Get angle between two vectors
  66357. * @param vector0 angle between vector0 and vector1
  66358. * @param vector1 angle between vector0 and vector1
  66359. * @param normal direction of the normal
  66360. * @return the angle between vector0 and vector1
  66361. */
  66362. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  66363. /**
  66364. * Returns a new Vector3 set from the index "offset" of the given array
  66365. * @param array defines the source array
  66366. * @param offset defines the offset in the source array
  66367. * @returns the new Vector3
  66368. */
  66369. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  66370. /**
  66371. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  66372. * This function is deprecated. Use FromArray instead
  66373. * @param array defines the source array
  66374. * @param offset defines the offset in the source array
  66375. * @returns the new Vector3
  66376. */
  66377. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  66378. /**
  66379. * Sets the given vector "result" with the element values from the index "offset" of the given array
  66380. * @param array defines the source array
  66381. * @param offset defines the offset in the source array
  66382. * @param result defines the Vector3 where to store the result
  66383. */
  66384. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  66385. /**
  66386. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  66387. * This function is deprecated. Use FromArrayToRef instead.
  66388. * @param array defines the source array
  66389. * @param offset defines the offset in the source array
  66390. * @param result defines the Vector3 where to store the result
  66391. */
  66392. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  66393. /**
  66394. * Sets the given vector "result" with the given floats.
  66395. * @param x defines the x coordinate of the source
  66396. * @param y defines the y coordinate of the source
  66397. * @param z defines the z coordinate of the source
  66398. * @param result defines the Vector3 where to store the result
  66399. */
  66400. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  66401. /**
  66402. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  66403. * @returns a new empty Vector3
  66404. */
  66405. static Zero(): Vector3;
  66406. /**
  66407. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  66408. * @returns a new unit Vector3
  66409. */
  66410. static One(): Vector3;
  66411. /**
  66412. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  66413. * @returns a new up Vector3
  66414. */
  66415. static Up(): Vector3;
  66416. /**
  66417. * Gets a up Vector3 that must not be updated
  66418. */
  66419. static readonly UpReadOnly: DeepImmutable<Vector3>;
  66420. /**
  66421. * Gets a zero Vector3 that must not be updated
  66422. */
  66423. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  66424. /**
  66425. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  66426. * @returns a new down Vector3
  66427. */
  66428. static Down(): Vector3;
  66429. /**
  66430. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  66431. * @returns a new forward Vector3
  66432. */
  66433. static Forward(): Vector3;
  66434. /**
  66435. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  66436. * @returns a new forward Vector3
  66437. */
  66438. static Backward(): Vector3;
  66439. /**
  66440. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  66441. * @returns a new right Vector3
  66442. */
  66443. static Right(): Vector3;
  66444. /**
  66445. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  66446. * @returns a new left Vector3
  66447. */
  66448. static Left(): Vector3;
  66449. /**
  66450. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  66451. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  66452. * @param vector defines the Vector3 to transform
  66453. * @param transformation defines the transformation matrix
  66454. * @returns the transformed Vector3
  66455. */
  66456. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  66457. /**
  66458. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  66459. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  66460. * @param vector defines the Vector3 to transform
  66461. * @param transformation defines the transformation matrix
  66462. * @param result defines the Vector3 where to store the result
  66463. */
  66464. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  66465. /**
  66466. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  66467. * This method computes tranformed coordinates only, not transformed direction vectors
  66468. * @param x define the x coordinate of the source vector
  66469. * @param y define the y coordinate of the source vector
  66470. * @param z define the z coordinate of the source vector
  66471. * @param transformation defines the transformation matrix
  66472. * @param result defines the Vector3 where to store the result
  66473. */
  66474. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  66475. /**
  66476. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  66477. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  66478. * @param vector defines the Vector3 to transform
  66479. * @param transformation defines the transformation matrix
  66480. * @returns the new Vector3
  66481. */
  66482. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  66483. /**
  66484. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  66485. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  66486. * @param vector defines the Vector3 to transform
  66487. * @param transformation defines the transformation matrix
  66488. * @param result defines the Vector3 where to store the result
  66489. */
  66490. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  66491. /**
  66492. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  66493. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  66494. * @param x define the x coordinate of the source vector
  66495. * @param y define the y coordinate of the source vector
  66496. * @param z define the z coordinate of the source vector
  66497. * @param transformation defines the transformation matrix
  66498. * @param result defines the Vector3 where to store the result
  66499. */
  66500. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  66501. /**
  66502. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  66503. * @param value1 defines the first control point
  66504. * @param value2 defines the second control point
  66505. * @param value3 defines the third control point
  66506. * @param value4 defines the fourth control point
  66507. * @param amount defines the amount on the spline to use
  66508. * @returns the new Vector3
  66509. */
  66510. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  66511. /**
  66512. * 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"
  66513. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  66514. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  66515. * @param value defines the current value
  66516. * @param min defines the lower range value
  66517. * @param max defines the upper range value
  66518. * @returns the new Vector3
  66519. */
  66520. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  66521. /**
  66522. * 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"
  66523. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  66524. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  66525. * @param value defines the current value
  66526. * @param min defines the lower range value
  66527. * @param max defines the upper range value
  66528. * @param result defines the Vector3 where to store the result
  66529. */
  66530. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  66531. /**
  66532. * Checks if a given vector is inside a specific range
  66533. * @param v defines the vector to test
  66534. * @param min defines the minimum range
  66535. * @param max defines the maximum range
  66536. */
  66537. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  66538. /**
  66539. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  66540. * @param value1 defines the first control point
  66541. * @param tangent1 defines the first tangent vector
  66542. * @param value2 defines the second control point
  66543. * @param tangent2 defines the second tangent vector
  66544. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  66545. * @returns the new Vector3
  66546. */
  66547. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  66548. /**
  66549. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  66550. * @param start defines the start value
  66551. * @param end defines the end value
  66552. * @param amount max defines amount between both (between 0 and 1)
  66553. * @returns the new Vector3
  66554. */
  66555. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  66556. /**
  66557. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  66558. * @param start defines the start value
  66559. * @param end defines the end value
  66560. * @param amount max defines amount between both (between 0 and 1)
  66561. * @param result defines the Vector3 where to store the result
  66562. */
  66563. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  66564. /**
  66565. * Returns the dot product (float) between the vectors "left" and "right"
  66566. * @param left defines the left operand
  66567. * @param right defines the right operand
  66568. * @returns the dot product
  66569. */
  66570. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  66571. /**
  66572. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  66573. * The cross product is then orthogonal to both "left" and "right"
  66574. * @param left defines the left operand
  66575. * @param right defines the right operand
  66576. * @returns the cross product
  66577. */
  66578. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  66579. /**
  66580. * Sets the given vector "result" with the cross product of "left" and "right"
  66581. * The cross product is then orthogonal to both "left" and "right"
  66582. * @param left defines the left operand
  66583. * @param right defines the right operand
  66584. * @param result defines the Vector3 where to store the result
  66585. */
  66586. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  66587. /**
  66588. * Returns a new Vector3 as the normalization of the given vector
  66589. * @param vector defines the Vector3 to normalize
  66590. * @returns the new Vector3
  66591. */
  66592. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  66593. /**
  66594. * Sets the given vector "result" with the normalization of the given first vector
  66595. * @param vector defines the Vector3 to normalize
  66596. * @param result defines the Vector3 where to store the result
  66597. */
  66598. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  66599. /**
  66600. * Project a Vector3 onto screen space
  66601. * @param vector defines the Vector3 to project
  66602. * @param world defines the world matrix to use
  66603. * @param transform defines the transform (view x projection) matrix to use
  66604. * @param viewport defines the screen viewport to use
  66605. * @returns the new Vector3
  66606. */
  66607. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  66608. /** @hidden */
  66609. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  66610. /**
  66611. * Unproject from screen space to object space
  66612. * @param source defines the screen space Vector3 to use
  66613. * @param viewportWidth defines the current width of the viewport
  66614. * @param viewportHeight defines the current height of the viewport
  66615. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  66616. * @param transform defines the transform (view x projection) matrix to use
  66617. * @returns the new Vector3
  66618. */
  66619. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  66620. /**
  66621. * Unproject from screen space to object space
  66622. * @param source defines the screen space Vector3 to use
  66623. * @param viewportWidth defines the current width of the viewport
  66624. * @param viewportHeight defines the current height of the viewport
  66625. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  66626. * @param view defines the view matrix to use
  66627. * @param projection defines the projection matrix to use
  66628. * @returns the new Vector3
  66629. */
  66630. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  66631. /**
  66632. * Unproject from screen space to object space
  66633. * @param source defines the screen space Vector3 to use
  66634. * @param viewportWidth defines the current width of the viewport
  66635. * @param viewportHeight defines the current height of the viewport
  66636. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  66637. * @param view defines the view matrix to use
  66638. * @param projection defines the projection matrix to use
  66639. * @param result defines the Vector3 where to store the result
  66640. */
  66641. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  66642. /**
  66643. * Unproject from screen space to object space
  66644. * @param sourceX defines the screen space x coordinate to use
  66645. * @param sourceY defines the screen space y coordinate to use
  66646. * @param sourceZ defines the screen space z coordinate to use
  66647. * @param viewportWidth defines the current width of the viewport
  66648. * @param viewportHeight defines the current height of the viewport
  66649. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  66650. * @param view defines the view matrix to use
  66651. * @param projection defines the projection matrix to use
  66652. * @param result defines the Vector3 where to store the result
  66653. */
  66654. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  66655. /**
  66656. * Gets the minimal coordinate values between two Vector3
  66657. * @param left defines the first operand
  66658. * @param right defines the second operand
  66659. * @returns the new Vector3
  66660. */
  66661. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  66662. /**
  66663. * Gets the maximal coordinate values between two Vector3
  66664. * @param left defines the first operand
  66665. * @param right defines the second operand
  66666. * @returns the new Vector3
  66667. */
  66668. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  66669. /**
  66670. * Returns the distance between the vectors "value1" and "value2"
  66671. * @param value1 defines the first operand
  66672. * @param value2 defines the second operand
  66673. * @returns the distance
  66674. */
  66675. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  66676. /**
  66677. * Returns the squared distance between the vectors "value1" and "value2"
  66678. * @param value1 defines the first operand
  66679. * @param value2 defines the second operand
  66680. * @returns the squared distance
  66681. */
  66682. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  66683. /**
  66684. * Returns a new Vector3 located at the center between "value1" and "value2"
  66685. * @param value1 defines the first operand
  66686. * @param value2 defines the second operand
  66687. * @returns the new Vector3
  66688. */
  66689. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  66690. /**
  66691. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  66692. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  66693. * to something in order to rotate it from its local system to the given target system
  66694. * Note: axis1, axis2 and axis3 are normalized during this operation
  66695. * @param axis1 defines the first axis
  66696. * @param axis2 defines the second axis
  66697. * @param axis3 defines the third axis
  66698. * @returns a new Vector3
  66699. */
  66700. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  66701. /**
  66702. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  66703. * @param axis1 defines the first axis
  66704. * @param axis2 defines the second axis
  66705. * @param axis3 defines the third axis
  66706. * @param ref defines the Vector3 where to store the result
  66707. */
  66708. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  66709. }
  66710. /**
  66711. * Vector4 class created for EulerAngle class conversion to Quaternion
  66712. */
  66713. export class Vector4 {
  66714. /** x value of the vector */
  66715. x: number;
  66716. /** y value of the vector */
  66717. y: number;
  66718. /** z value of the vector */
  66719. z: number;
  66720. /** w value of the vector */
  66721. w: number;
  66722. /**
  66723. * Creates a Vector4 object from the given floats.
  66724. * @param x x value of the vector
  66725. * @param y y value of the vector
  66726. * @param z z value of the vector
  66727. * @param w w value of the vector
  66728. */
  66729. constructor(
  66730. /** x value of the vector */
  66731. x: number,
  66732. /** y value of the vector */
  66733. y: number,
  66734. /** z value of the vector */
  66735. z: number,
  66736. /** w value of the vector */
  66737. w: number);
  66738. /**
  66739. * Returns the string with the Vector4 coordinates.
  66740. * @returns a string containing all the vector values
  66741. */
  66742. toString(): string;
  66743. /**
  66744. * Returns the string "Vector4".
  66745. * @returns "Vector4"
  66746. */
  66747. getClassName(): string;
  66748. /**
  66749. * Returns the Vector4 hash code.
  66750. * @returns a unique hash code
  66751. */
  66752. getHashCode(): number;
  66753. /**
  66754. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  66755. * @returns the resulting array
  66756. */
  66757. asArray(): number[];
  66758. /**
  66759. * Populates the given array from the given index with the Vector4 coordinates.
  66760. * @param array array to populate
  66761. * @param index index of the array to start at (default: 0)
  66762. * @returns the Vector4.
  66763. */
  66764. toArray(array: FloatArray, index?: number): Vector4;
  66765. /**
  66766. * Adds the given vector to the current Vector4.
  66767. * @param otherVector the vector to add
  66768. * @returns the updated Vector4.
  66769. */
  66770. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  66771. /**
  66772. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  66773. * @param otherVector the vector to add
  66774. * @returns the resulting vector
  66775. */
  66776. add(otherVector: DeepImmutable<Vector4>): Vector4;
  66777. /**
  66778. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  66779. * @param otherVector the vector to add
  66780. * @param result the vector to store the result
  66781. * @returns the current Vector4.
  66782. */
  66783. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  66784. /**
  66785. * Subtract in place the given vector from the current Vector4.
  66786. * @param otherVector the vector to subtract
  66787. * @returns the updated Vector4.
  66788. */
  66789. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  66790. /**
  66791. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  66792. * @param otherVector the vector to add
  66793. * @returns the new vector with the result
  66794. */
  66795. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  66796. /**
  66797. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  66798. * @param otherVector the vector to subtract
  66799. * @param result the vector to store the result
  66800. * @returns the current Vector4.
  66801. */
  66802. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  66803. /**
  66804. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  66805. */
  66806. /**
  66807. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  66808. * @param x value to subtract
  66809. * @param y value to subtract
  66810. * @param z value to subtract
  66811. * @param w value to subtract
  66812. * @returns new vector containing the result
  66813. */
  66814. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  66815. /**
  66816. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  66817. * @param x value to subtract
  66818. * @param y value to subtract
  66819. * @param z value to subtract
  66820. * @param w value to subtract
  66821. * @param result the vector to store the result in
  66822. * @returns the current Vector4.
  66823. */
  66824. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  66825. /**
  66826. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  66827. * @returns a new vector with the negated values
  66828. */
  66829. negate(): Vector4;
  66830. /**
  66831. * Multiplies the current Vector4 coordinates by scale (float).
  66832. * @param scale the number to scale with
  66833. * @returns the updated Vector4.
  66834. */
  66835. scaleInPlace(scale: number): Vector4;
  66836. /**
  66837. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  66838. * @param scale the number to scale with
  66839. * @returns a new vector with the result
  66840. */
  66841. scale(scale: number): Vector4;
  66842. /**
  66843. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  66844. * @param scale the number to scale with
  66845. * @param result a vector to store the result in
  66846. * @returns the current Vector4.
  66847. */
  66848. scaleToRef(scale: number, result: Vector4): Vector4;
  66849. /**
  66850. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  66851. * @param scale defines the scale factor
  66852. * @param result defines the Vector4 object where to store the result
  66853. * @returns the unmodified current Vector4
  66854. */
  66855. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  66856. /**
  66857. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  66858. * @param otherVector the vector to compare against
  66859. * @returns true if they are equal
  66860. */
  66861. equals(otherVector: DeepImmutable<Vector4>): boolean;
  66862. /**
  66863. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  66864. * @param otherVector vector to compare against
  66865. * @param epsilon (Default: very small number)
  66866. * @returns true if they are equal
  66867. */
  66868. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  66869. /**
  66870. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  66871. * @param x x value to compare against
  66872. * @param y y value to compare against
  66873. * @param z z value to compare against
  66874. * @param w w value to compare against
  66875. * @returns true if equal
  66876. */
  66877. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  66878. /**
  66879. * Multiplies in place the current Vector4 by the given one.
  66880. * @param otherVector vector to multiple with
  66881. * @returns the updated Vector4.
  66882. */
  66883. multiplyInPlace(otherVector: Vector4): Vector4;
  66884. /**
  66885. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  66886. * @param otherVector vector to multiple with
  66887. * @returns resulting new vector
  66888. */
  66889. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  66890. /**
  66891. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  66892. * @param otherVector vector to multiple with
  66893. * @param result vector to store the result
  66894. * @returns the current Vector4.
  66895. */
  66896. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  66897. /**
  66898. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  66899. * @param x x value multiply with
  66900. * @param y y value multiply with
  66901. * @param z z value multiply with
  66902. * @param w w value multiply with
  66903. * @returns resulting new vector
  66904. */
  66905. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  66906. /**
  66907. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  66908. * @param otherVector vector to devide with
  66909. * @returns resulting new vector
  66910. */
  66911. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  66912. /**
  66913. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  66914. * @param otherVector vector to devide with
  66915. * @param result vector to store the result
  66916. * @returns the current Vector4.
  66917. */
  66918. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  66919. /**
  66920. * Divides the current Vector3 coordinates by the given ones.
  66921. * @param otherVector vector to devide with
  66922. * @returns the updated Vector3.
  66923. */
  66924. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  66925. /**
  66926. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  66927. * @param other defines the second operand
  66928. * @returns the current updated Vector4
  66929. */
  66930. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  66931. /**
  66932. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  66933. * @param other defines the second operand
  66934. * @returns the current updated Vector4
  66935. */
  66936. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  66937. /**
  66938. * Gets a new Vector4 from current Vector4 floored values
  66939. * @returns a new Vector4
  66940. */
  66941. floor(): Vector4;
  66942. /**
  66943. * Gets a new Vector4 from current Vector3 floored values
  66944. * @returns a new Vector4
  66945. */
  66946. fract(): Vector4;
  66947. /**
  66948. * Returns the Vector4 length (float).
  66949. * @returns the length
  66950. */
  66951. length(): number;
  66952. /**
  66953. * Returns the Vector4 squared length (float).
  66954. * @returns the length squared
  66955. */
  66956. lengthSquared(): number;
  66957. /**
  66958. * Normalizes in place the Vector4.
  66959. * @returns the updated Vector4.
  66960. */
  66961. normalize(): Vector4;
  66962. /**
  66963. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  66964. * @returns this converted to a new vector3
  66965. */
  66966. toVector3(): Vector3;
  66967. /**
  66968. * Returns a new Vector4 copied from the current one.
  66969. * @returns the new cloned vector
  66970. */
  66971. clone(): Vector4;
  66972. /**
  66973. * Updates the current Vector4 with the given one coordinates.
  66974. * @param source the source vector to copy from
  66975. * @returns the updated Vector4.
  66976. */
  66977. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  66978. /**
  66979. * Updates the current Vector4 coordinates with the given floats.
  66980. * @param x float to copy from
  66981. * @param y float to copy from
  66982. * @param z float to copy from
  66983. * @param w float to copy from
  66984. * @returns the updated Vector4.
  66985. */
  66986. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  66987. /**
  66988. * Updates the current Vector4 coordinates with the given floats.
  66989. * @param x float to set from
  66990. * @param y float to set from
  66991. * @param z float to set from
  66992. * @param w float to set from
  66993. * @returns the updated Vector4.
  66994. */
  66995. set(x: number, y: number, z: number, w: number): Vector4;
  66996. /**
  66997. * Copies the given float to the current Vector3 coordinates
  66998. * @param v defines the x, y, z and w coordinates of the operand
  66999. * @returns the current updated Vector3
  67000. */
  67001. setAll(v: number): Vector4;
  67002. /**
  67003. * Returns a new Vector4 set from the starting index of the given array.
  67004. * @param array the array to pull values from
  67005. * @param offset the offset into the array to start at
  67006. * @returns the new vector
  67007. */
  67008. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  67009. /**
  67010. * Updates the given vector "result" from the starting index of the given array.
  67011. * @param array the array to pull values from
  67012. * @param offset the offset into the array to start at
  67013. * @param result the vector to store the result in
  67014. */
  67015. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  67016. /**
  67017. * Updates the given vector "result" from the starting index of the given Float32Array.
  67018. * @param array the array to pull values from
  67019. * @param offset the offset into the array to start at
  67020. * @param result the vector to store the result in
  67021. */
  67022. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  67023. /**
  67024. * Updates the given vector "result" coordinates from the given floats.
  67025. * @param x float to set from
  67026. * @param y float to set from
  67027. * @param z float to set from
  67028. * @param w float to set from
  67029. * @param result the vector to the floats in
  67030. */
  67031. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  67032. /**
  67033. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  67034. * @returns the new vector
  67035. */
  67036. static Zero(): Vector4;
  67037. /**
  67038. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  67039. * @returns the new vector
  67040. */
  67041. static One(): Vector4;
  67042. /**
  67043. * Returns a new normalized Vector4 from the given one.
  67044. * @param vector the vector to normalize
  67045. * @returns the vector
  67046. */
  67047. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  67048. /**
  67049. * Updates the given vector "result" from the normalization of the given one.
  67050. * @param vector the vector to normalize
  67051. * @param result the vector to store the result in
  67052. */
  67053. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  67054. /**
  67055. * Returns a vector with the minimum values from the left and right vectors
  67056. * @param left left vector to minimize
  67057. * @param right right vector to minimize
  67058. * @returns a new vector with the minimum of the left and right vector values
  67059. */
  67060. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  67061. /**
  67062. * Returns a vector with the maximum values from the left and right vectors
  67063. * @param left left vector to maximize
  67064. * @param right right vector to maximize
  67065. * @returns a new vector with the maximum of the left and right vector values
  67066. */
  67067. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  67068. /**
  67069. * Returns the distance (float) between the vectors "value1" and "value2".
  67070. * @param value1 value to calulate the distance between
  67071. * @param value2 value to calulate the distance between
  67072. * @return the distance between the two vectors
  67073. */
  67074. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  67075. /**
  67076. * Returns the squared distance (float) between the vectors "value1" and "value2".
  67077. * @param value1 value to calulate the distance between
  67078. * @param value2 value to calulate the distance between
  67079. * @return the distance between the two vectors squared
  67080. */
  67081. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  67082. /**
  67083. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  67084. * @param value1 value to calulate the center between
  67085. * @param value2 value to calulate the center between
  67086. * @return the center between the two vectors
  67087. */
  67088. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  67089. /**
  67090. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  67091. * This methods computes transformed normalized direction vectors only.
  67092. * @param vector the vector to transform
  67093. * @param transformation the transformation matrix to apply
  67094. * @returns the new vector
  67095. */
  67096. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  67097. /**
  67098. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  67099. * This methods computes transformed normalized direction vectors only.
  67100. * @param vector the vector to transform
  67101. * @param transformation the transformation matrix to apply
  67102. * @param result the vector to store the result in
  67103. */
  67104. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  67105. /**
  67106. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  67107. * This methods computes transformed normalized direction vectors only.
  67108. * @param x value to transform
  67109. * @param y value to transform
  67110. * @param z value to transform
  67111. * @param w value to transform
  67112. * @param transformation the transformation matrix to apply
  67113. * @param result the vector to store the results in
  67114. */
  67115. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  67116. /**
  67117. * Creates a new Vector4 from a Vector3
  67118. * @param source defines the source data
  67119. * @param w defines the 4th component (default is 0)
  67120. * @returns a new Vector4
  67121. */
  67122. static FromVector3(source: Vector3, w?: number): Vector4;
  67123. }
  67124. /**
  67125. * Class used to store quaternion data
  67126. * @see https://en.wikipedia.org/wiki/Quaternion
  67127. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  67128. */
  67129. export class Quaternion {
  67130. /** defines the first component (0 by default) */
  67131. x: number;
  67132. /** defines the second component (0 by default) */
  67133. y: number;
  67134. /** defines the third component (0 by default) */
  67135. z: number;
  67136. /** defines the fourth component (1.0 by default) */
  67137. w: number;
  67138. /**
  67139. * Creates a new Quaternion from the given floats
  67140. * @param x defines the first component (0 by default)
  67141. * @param y defines the second component (0 by default)
  67142. * @param z defines the third component (0 by default)
  67143. * @param w defines the fourth component (1.0 by default)
  67144. */
  67145. constructor(
  67146. /** defines the first component (0 by default) */
  67147. x?: number,
  67148. /** defines the second component (0 by default) */
  67149. y?: number,
  67150. /** defines the third component (0 by default) */
  67151. z?: number,
  67152. /** defines the fourth component (1.0 by default) */
  67153. w?: number);
  67154. /**
  67155. * Gets a string representation for the current quaternion
  67156. * @returns a string with the Quaternion coordinates
  67157. */
  67158. toString(): string;
  67159. /**
  67160. * Gets the class name of the quaternion
  67161. * @returns the string "Quaternion"
  67162. */
  67163. getClassName(): string;
  67164. /**
  67165. * Gets a hash code for this quaternion
  67166. * @returns the quaternion hash code
  67167. */
  67168. getHashCode(): number;
  67169. /**
  67170. * Copy the quaternion to an array
  67171. * @returns a new array populated with 4 elements from the quaternion coordinates
  67172. */
  67173. asArray(): number[];
  67174. /**
  67175. * Check if two quaternions are equals
  67176. * @param otherQuaternion defines the second operand
  67177. * @return true if the current quaternion and the given one coordinates are strictly equals
  67178. */
  67179. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  67180. /**
  67181. * Clone the current quaternion
  67182. * @returns a new quaternion copied from the current one
  67183. */
  67184. clone(): Quaternion;
  67185. /**
  67186. * Copy a quaternion to the current one
  67187. * @param other defines the other quaternion
  67188. * @returns the updated current quaternion
  67189. */
  67190. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  67191. /**
  67192. * Updates the current quaternion with the given float coordinates
  67193. * @param x defines the x coordinate
  67194. * @param y defines the y coordinate
  67195. * @param z defines the z coordinate
  67196. * @param w defines the w coordinate
  67197. * @returns the updated current quaternion
  67198. */
  67199. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  67200. /**
  67201. * Updates the current quaternion from the given float coordinates
  67202. * @param x defines the x coordinate
  67203. * @param y defines the y coordinate
  67204. * @param z defines the z coordinate
  67205. * @param w defines the w coordinate
  67206. * @returns the updated current quaternion
  67207. */
  67208. set(x: number, y: number, z: number, w: number): Quaternion;
  67209. /**
  67210. * Adds two quaternions
  67211. * @param other defines the second operand
  67212. * @returns a new quaternion as the addition result of the given one and the current quaternion
  67213. */
  67214. add(other: DeepImmutable<Quaternion>): Quaternion;
  67215. /**
  67216. * Add a quaternion to the current one
  67217. * @param other defines the quaternion to add
  67218. * @returns the current quaternion
  67219. */
  67220. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  67221. /**
  67222. * Subtract two quaternions
  67223. * @param other defines the second operand
  67224. * @returns a new quaternion as the subtraction result of the given one from the current one
  67225. */
  67226. subtract(other: Quaternion): Quaternion;
  67227. /**
  67228. * Multiplies the current quaternion by a scale factor
  67229. * @param value defines the scale factor
  67230. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  67231. */
  67232. scale(value: number): Quaternion;
  67233. /**
  67234. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  67235. * @param scale defines the scale factor
  67236. * @param result defines the Quaternion object where to store the result
  67237. * @returns the unmodified current quaternion
  67238. */
  67239. scaleToRef(scale: number, result: Quaternion): Quaternion;
  67240. /**
  67241. * Multiplies in place the current quaternion by a scale factor
  67242. * @param value defines the scale factor
  67243. * @returns the current modified quaternion
  67244. */
  67245. scaleInPlace(value: number): Quaternion;
  67246. /**
  67247. * Scale the current quaternion values by a factor and add the result to a given quaternion
  67248. * @param scale defines the scale factor
  67249. * @param result defines the Quaternion object where to store the result
  67250. * @returns the unmodified current quaternion
  67251. */
  67252. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  67253. /**
  67254. * Multiplies two quaternions
  67255. * @param q1 defines the second operand
  67256. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  67257. */
  67258. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  67259. /**
  67260. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  67261. * @param q1 defines the second operand
  67262. * @param result defines the target quaternion
  67263. * @returns the current quaternion
  67264. */
  67265. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  67266. /**
  67267. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  67268. * @param q1 defines the second operand
  67269. * @returns the currentupdated quaternion
  67270. */
  67271. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  67272. /**
  67273. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  67274. * @param ref defines the target quaternion
  67275. * @returns the current quaternion
  67276. */
  67277. conjugateToRef(ref: Quaternion): Quaternion;
  67278. /**
  67279. * Conjugates in place (1-q) the current quaternion
  67280. * @returns the current updated quaternion
  67281. */
  67282. conjugateInPlace(): Quaternion;
  67283. /**
  67284. * Conjugates in place (1-q) the current quaternion
  67285. * @returns a new quaternion
  67286. */
  67287. conjugate(): Quaternion;
  67288. /**
  67289. * Gets length of current quaternion
  67290. * @returns the quaternion length (float)
  67291. */
  67292. length(): number;
  67293. /**
  67294. * Normalize in place the current quaternion
  67295. * @returns the current updated quaternion
  67296. */
  67297. normalize(): Quaternion;
  67298. /**
  67299. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  67300. * @param order is a reserved parameter and is ignore for now
  67301. * @returns a new Vector3 containing the Euler angles
  67302. */
  67303. toEulerAngles(order?: string): Vector3;
  67304. /**
  67305. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  67306. * @param result defines the vector which will be filled with the Euler angles
  67307. * @param order is a reserved parameter and is ignore for now
  67308. * @returns the current unchanged quaternion
  67309. */
  67310. toEulerAnglesToRef(result: Vector3): Quaternion;
  67311. /**
  67312. * Updates the given rotation matrix with the current quaternion values
  67313. * @param result defines the target matrix
  67314. * @returns the current unchanged quaternion
  67315. */
  67316. toRotationMatrix(result: Matrix): Quaternion;
  67317. /**
  67318. * Updates the current quaternion from the given rotation matrix values
  67319. * @param matrix defines the source matrix
  67320. * @returns the current updated quaternion
  67321. */
  67322. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  67323. /**
  67324. * Creates a new quaternion from a rotation matrix
  67325. * @param matrix defines the source matrix
  67326. * @returns a new quaternion created from the given rotation matrix values
  67327. */
  67328. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  67329. /**
  67330. * Updates the given quaternion with the given rotation matrix values
  67331. * @param matrix defines the source matrix
  67332. * @param result defines the target quaternion
  67333. */
  67334. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  67335. /**
  67336. * Returns the dot product (float) between the quaternions "left" and "right"
  67337. * @param left defines the left operand
  67338. * @param right defines the right operand
  67339. * @returns the dot product
  67340. */
  67341. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  67342. /**
  67343. * Checks if the two quaternions are close to each other
  67344. * @param quat0 defines the first quaternion to check
  67345. * @param quat1 defines the second quaternion to check
  67346. * @returns true if the two quaternions are close to each other
  67347. */
  67348. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  67349. /**
  67350. * Creates an empty quaternion
  67351. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  67352. */
  67353. static Zero(): Quaternion;
  67354. /**
  67355. * Inverse a given quaternion
  67356. * @param q defines the source quaternion
  67357. * @returns a new quaternion as the inverted current quaternion
  67358. */
  67359. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  67360. /**
  67361. * Inverse a given quaternion
  67362. * @param q defines the source quaternion
  67363. * @param result the quaternion the result will be stored in
  67364. * @returns the result quaternion
  67365. */
  67366. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  67367. /**
  67368. * Creates an identity quaternion
  67369. * @returns the identity quaternion
  67370. */
  67371. static Identity(): Quaternion;
  67372. /**
  67373. * Gets a boolean indicating if the given quaternion is identity
  67374. * @param quaternion defines the quaternion to check
  67375. * @returns true if the quaternion is identity
  67376. */
  67377. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  67378. /**
  67379. * Creates a quaternion from a rotation around an axis
  67380. * @param axis defines the axis to use
  67381. * @param angle defines the angle to use
  67382. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  67383. */
  67384. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  67385. /**
  67386. * Creates a rotation around an axis and stores it into the given quaternion
  67387. * @param axis defines the axis to use
  67388. * @param angle defines the angle to use
  67389. * @param result defines the target quaternion
  67390. * @returns the target quaternion
  67391. */
  67392. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  67393. /**
  67394. * Creates a new quaternion from data stored into an array
  67395. * @param array defines the data source
  67396. * @param offset defines the offset in the source array where the data starts
  67397. * @returns a new quaternion
  67398. */
  67399. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  67400. /**
  67401. * Create a quaternion from Euler rotation angles
  67402. * @param x Pitch
  67403. * @param y Yaw
  67404. * @param z Roll
  67405. * @returns the new Quaternion
  67406. */
  67407. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  67408. /**
  67409. * Updates a quaternion from Euler rotation angles
  67410. * @param x Pitch
  67411. * @param y Yaw
  67412. * @param z Roll
  67413. * @param result the quaternion to store the result
  67414. * @returns the updated quaternion
  67415. */
  67416. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  67417. /**
  67418. * Create a quaternion from Euler rotation vector
  67419. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  67420. * @returns the new Quaternion
  67421. */
  67422. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  67423. /**
  67424. * Updates a quaternion from Euler rotation vector
  67425. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  67426. * @param result the quaternion to store the result
  67427. * @returns the updated quaternion
  67428. */
  67429. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  67430. /**
  67431. * Creates a new quaternion from the given Euler float angles (y, x, z)
  67432. * @param yaw defines the rotation around Y axis
  67433. * @param pitch defines the rotation around X axis
  67434. * @param roll defines the rotation around Z axis
  67435. * @returns the new quaternion
  67436. */
  67437. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  67438. /**
  67439. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  67440. * @param yaw defines the rotation around Y axis
  67441. * @param pitch defines the rotation around X axis
  67442. * @param roll defines the rotation around Z axis
  67443. * @param result defines the target quaternion
  67444. */
  67445. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  67446. /**
  67447. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  67448. * @param alpha defines the rotation around first axis
  67449. * @param beta defines the rotation around second axis
  67450. * @param gamma defines the rotation around third axis
  67451. * @returns the new quaternion
  67452. */
  67453. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  67454. /**
  67455. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  67456. * @param alpha defines the rotation around first axis
  67457. * @param beta defines the rotation around second axis
  67458. * @param gamma defines the rotation around third axis
  67459. * @param result defines the target quaternion
  67460. */
  67461. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  67462. /**
  67463. * 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)
  67464. * @param axis1 defines the first axis
  67465. * @param axis2 defines the second axis
  67466. * @param axis3 defines the third axis
  67467. * @returns the new quaternion
  67468. */
  67469. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  67470. /**
  67471. * 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
  67472. * @param axis1 defines the first axis
  67473. * @param axis2 defines the second axis
  67474. * @param axis3 defines the third axis
  67475. * @param ref defines the target quaternion
  67476. */
  67477. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  67478. /**
  67479. * Interpolates between two quaternions
  67480. * @param left defines first quaternion
  67481. * @param right defines second quaternion
  67482. * @param amount defines the gradient to use
  67483. * @returns the new interpolated quaternion
  67484. */
  67485. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  67486. /**
  67487. * Interpolates between two quaternions and stores it into a target quaternion
  67488. * @param left defines first quaternion
  67489. * @param right defines second quaternion
  67490. * @param amount defines the gradient to use
  67491. * @param result defines the target quaternion
  67492. */
  67493. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  67494. /**
  67495. * Interpolate between two quaternions using Hermite interpolation
  67496. * @param value1 defines first quaternion
  67497. * @param tangent1 defines the incoming tangent
  67498. * @param value2 defines second quaternion
  67499. * @param tangent2 defines the outgoing tangent
  67500. * @param amount defines the target quaternion
  67501. * @returns the new interpolated quaternion
  67502. */
  67503. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  67504. }
  67505. /**
  67506. * Class used to store matrix data (4x4)
  67507. */
  67508. export class Matrix {
  67509. private static _updateFlagSeed;
  67510. private static _identityReadOnly;
  67511. private _isIdentity;
  67512. private _isIdentityDirty;
  67513. private _isIdentity3x2;
  67514. private _isIdentity3x2Dirty;
  67515. /**
  67516. * Gets the update flag of the matrix which is an unique number for the matrix.
  67517. * It will be incremented every time the matrix data change.
  67518. * You can use it to speed the comparison between two versions of the same matrix.
  67519. */
  67520. updateFlag: number;
  67521. private readonly _m;
  67522. /**
  67523. * Gets the internal data of the matrix
  67524. */
  67525. readonly m: DeepImmutable<Float32Array>;
  67526. /** @hidden */
  67527. _markAsUpdated(): void;
  67528. /** @hidden */
  67529. private _updateIdentityStatus;
  67530. /**
  67531. * Creates an empty matrix (filled with zeros)
  67532. */
  67533. constructor();
  67534. /**
  67535. * Check if the current matrix is identity
  67536. * @returns true is the matrix is the identity matrix
  67537. */
  67538. isIdentity(): boolean;
  67539. /**
  67540. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  67541. * @returns true is the matrix is the identity matrix
  67542. */
  67543. isIdentityAs3x2(): boolean;
  67544. /**
  67545. * Gets the determinant of the matrix
  67546. * @returns the matrix determinant
  67547. */
  67548. determinant(): number;
  67549. /**
  67550. * Returns the matrix as a Float32Array
  67551. * @returns the matrix underlying array
  67552. */
  67553. toArray(): DeepImmutable<Float32Array>;
  67554. /**
  67555. * Returns the matrix as a Float32Array
  67556. * @returns the matrix underlying array.
  67557. */
  67558. asArray(): DeepImmutable<Float32Array>;
  67559. /**
  67560. * Inverts the current matrix in place
  67561. * @returns the current inverted matrix
  67562. */
  67563. invert(): Matrix;
  67564. /**
  67565. * Sets all the matrix elements to zero
  67566. * @returns the current matrix
  67567. */
  67568. reset(): Matrix;
  67569. /**
  67570. * Adds the current matrix with a second one
  67571. * @param other defines the matrix to add
  67572. * @returns a new matrix as the addition of the current matrix and the given one
  67573. */
  67574. add(other: DeepImmutable<Matrix>): Matrix;
  67575. /**
  67576. * Sets the given matrix "result" to the addition of the current matrix and the given one
  67577. * @param other defines the matrix to add
  67578. * @param result defines the target matrix
  67579. * @returns the current matrix
  67580. */
  67581. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  67582. /**
  67583. * Adds in place the given matrix to the current matrix
  67584. * @param other defines the second operand
  67585. * @returns the current updated matrix
  67586. */
  67587. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  67588. /**
  67589. * Sets the given matrix to the current inverted Matrix
  67590. * @param other defines the target matrix
  67591. * @returns the unmodified current matrix
  67592. */
  67593. invertToRef(other: Matrix): Matrix;
  67594. /**
  67595. * add a value at the specified position in the current Matrix
  67596. * @param index the index of the value within the matrix. between 0 and 15.
  67597. * @param value the value to be added
  67598. * @returns the current updated matrix
  67599. */
  67600. addAtIndex(index: number, value: number): Matrix;
  67601. /**
  67602. * mutiply the specified position in the current Matrix by a value
  67603. * @param index the index of the value within the matrix. between 0 and 15.
  67604. * @param value the value to be added
  67605. * @returns the current updated matrix
  67606. */
  67607. multiplyAtIndex(index: number, value: number): Matrix;
  67608. /**
  67609. * Inserts the translation vector (using 3 floats) in the current matrix
  67610. * @param x defines the 1st component of the translation
  67611. * @param y defines the 2nd component of the translation
  67612. * @param z defines the 3rd component of the translation
  67613. * @returns the current updated matrix
  67614. */
  67615. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  67616. /**
  67617. * Adds the translation vector (using 3 floats) in the current matrix
  67618. * @param x defines the 1st component of the translation
  67619. * @param y defines the 2nd component of the translation
  67620. * @param z defines the 3rd component of the translation
  67621. * @returns the current updated matrix
  67622. */
  67623. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  67624. /**
  67625. * Inserts the translation vector in the current matrix
  67626. * @param vector3 defines the translation to insert
  67627. * @returns the current updated matrix
  67628. */
  67629. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  67630. /**
  67631. * Gets the translation value of the current matrix
  67632. * @returns a new Vector3 as the extracted translation from the matrix
  67633. */
  67634. getTranslation(): Vector3;
  67635. /**
  67636. * Fill a Vector3 with the extracted translation from the matrix
  67637. * @param result defines the Vector3 where to store the translation
  67638. * @returns the current matrix
  67639. */
  67640. getTranslationToRef(result: Vector3): Matrix;
  67641. /**
  67642. * Remove rotation and scaling part from the matrix
  67643. * @returns the updated matrix
  67644. */
  67645. removeRotationAndScaling(): Matrix;
  67646. /**
  67647. * Multiply two matrices
  67648. * @param other defines the second operand
  67649. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  67650. */
  67651. multiply(other: DeepImmutable<Matrix>): Matrix;
  67652. /**
  67653. * Copy the current matrix from the given one
  67654. * @param other defines the source matrix
  67655. * @returns the current updated matrix
  67656. */
  67657. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  67658. /**
  67659. * Populates the given array from the starting index with the current matrix values
  67660. * @param array defines the target array
  67661. * @param offset defines the offset in the target array where to start storing values
  67662. * @returns the current matrix
  67663. */
  67664. copyToArray(array: Float32Array, offset?: number): Matrix;
  67665. /**
  67666. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  67667. * @param other defines the second operand
  67668. * @param result defines the matrix where to store the multiplication
  67669. * @returns the current matrix
  67670. */
  67671. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  67672. /**
  67673. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  67674. * @param other defines the second operand
  67675. * @param result defines the array where to store the multiplication
  67676. * @param offset defines the offset in the target array where to start storing values
  67677. * @returns the current matrix
  67678. */
  67679. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  67680. /**
  67681. * Check equality between this matrix and a second one
  67682. * @param value defines the second matrix to compare
  67683. * @returns true is the current matrix and the given one values are strictly equal
  67684. */
  67685. equals(value: DeepImmutable<Matrix>): boolean;
  67686. /**
  67687. * Clone the current matrix
  67688. * @returns a new matrix from the current matrix
  67689. */
  67690. clone(): Matrix;
  67691. /**
  67692. * Returns the name of the current matrix class
  67693. * @returns the string "Matrix"
  67694. */
  67695. getClassName(): string;
  67696. /**
  67697. * Gets the hash code of the current matrix
  67698. * @returns the hash code
  67699. */
  67700. getHashCode(): number;
  67701. /**
  67702. * Decomposes the current Matrix into a translation, rotation and scaling components
  67703. * @param scale defines the scale vector3 given as a reference to update
  67704. * @param rotation defines the rotation quaternion given as a reference to update
  67705. * @param translation defines the translation vector3 given as a reference to update
  67706. * @returns true if operation was successful
  67707. */
  67708. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  67709. /**
  67710. * Gets specific row of the matrix
  67711. * @param index defines the number of the row to get
  67712. * @returns the index-th row of the current matrix as a new Vector4
  67713. */
  67714. getRow(index: number): Nullable<Vector4>;
  67715. /**
  67716. * Sets the index-th row of the current matrix to the vector4 values
  67717. * @param index defines the number of the row to set
  67718. * @param row defines the target vector4
  67719. * @returns the updated current matrix
  67720. */
  67721. setRow(index: number, row: Vector4): Matrix;
  67722. /**
  67723. * Compute the transpose of the matrix
  67724. * @returns the new transposed matrix
  67725. */
  67726. transpose(): Matrix;
  67727. /**
  67728. * Compute the transpose of the matrix and store it in a given matrix
  67729. * @param result defines the target matrix
  67730. * @returns the current matrix
  67731. */
  67732. transposeToRef(result: Matrix): Matrix;
  67733. /**
  67734. * Sets the index-th row of the current matrix with the given 4 x float values
  67735. * @param index defines the row index
  67736. * @param x defines the x component to set
  67737. * @param y defines the y component to set
  67738. * @param z defines the z component to set
  67739. * @param w defines the w component to set
  67740. * @returns the updated current matrix
  67741. */
  67742. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  67743. /**
  67744. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  67745. * @param scale defines the scale factor
  67746. * @returns a new matrix
  67747. */
  67748. scale(scale: number): Matrix;
  67749. /**
  67750. * Scale the current matrix values by a factor to a given result matrix
  67751. * @param scale defines the scale factor
  67752. * @param result defines the matrix to store the result
  67753. * @returns the current matrix
  67754. */
  67755. scaleToRef(scale: number, result: Matrix): Matrix;
  67756. /**
  67757. * Scale the current matrix values by a factor and add the result to a given matrix
  67758. * @param scale defines the scale factor
  67759. * @param result defines the Matrix to store the result
  67760. * @returns the current matrix
  67761. */
  67762. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  67763. /**
  67764. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  67765. * @param ref matrix to store the result
  67766. */
  67767. toNormalMatrix(ref: Matrix): void;
  67768. /**
  67769. * Gets only rotation part of the current matrix
  67770. * @returns a new matrix sets to the extracted rotation matrix from the current one
  67771. */
  67772. getRotationMatrix(): Matrix;
  67773. /**
  67774. * Extracts the rotation matrix from the current one and sets it as the given "result"
  67775. * @param result defines the target matrix to store data to
  67776. * @returns the current matrix
  67777. */
  67778. getRotationMatrixToRef(result: Matrix): Matrix;
  67779. /**
  67780. * Toggles model matrix from being right handed to left handed in place and vice versa
  67781. */
  67782. toggleModelMatrixHandInPlace(): void;
  67783. /**
  67784. * Toggles projection matrix from being right handed to left handed in place and vice versa
  67785. */
  67786. toggleProjectionMatrixHandInPlace(): void;
  67787. /**
  67788. * Creates a matrix from an array
  67789. * @param array defines the source array
  67790. * @param offset defines an offset in the source array
  67791. * @returns a new Matrix set from the starting index of the given array
  67792. */
  67793. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  67794. /**
  67795. * Copy the content of an array into a given matrix
  67796. * @param array defines the source array
  67797. * @param offset defines an offset in the source array
  67798. * @param result defines the target matrix
  67799. */
  67800. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  67801. /**
  67802. * Stores an array into a matrix after having multiplied each component by a given factor
  67803. * @param array defines the source array
  67804. * @param offset defines the offset in the source array
  67805. * @param scale defines the scaling factor
  67806. * @param result defines the target matrix
  67807. */
  67808. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  67809. /**
  67810. * Gets an identity matrix that must not be updated
  67811. */
  67812. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  67813. /**
  67814. * Stores a list of values (16) inside a given matrix
  67815. * @param initialM11 defines 1st value of 1st row
  67816. * @param initialM12 defines 2nd value of 1st row
  67817. * @param initialM13 defines 3rd value of 1st row
  67818. * @param initialM14 defines 4th value of 1st row
  67819. * @param initialM21 defines 1st value of 2nd row
  67820. * @param initialM22 defines 2nd value of 2nd row
  67821. * @param initialM23 defines 3rd value of 2nd row
  67822. * @param initialM24 defines 4th value of 2nd row
  67823. * @param initialM31 defines 1st value of 3rd row
  67824. * @param initialM32 defines 2nd value of 3rd row
  67825. * @param initialM33 defines 3rd value of 3rd row
  67826. * @param initialM34 defines 4th value of 3rd row
  67827. * @param initialM41 defines 1st value of 4th row
  67828. * @param initialM42 defines 2nd value of 4th row
  67829. * @param initialM43 defines 3rd value of 4th row
  67830. * @param initialM44 defines 4th value of 4th row
  67831. * @param result defines the target matrix
  67832. */
  67833. 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;
  67834. /**
  67835. * Creates new matrix from a list of values (16)
  67836. * @param initialM11 defines 1st value of 1st row
  67837. * @param initialM12 defines 2nd value of 1st row
  67838. * @param initialM13 defines 3rd value of 1st row
  67839. * @param initialM14 defines 4th value of 1st row
  67840. * @param initialM21 defines 1st value of 2nd row
  67841. * @param initialM22 defines 2nd value of 2nd row
  67842. * @param initialM23 defines 3rd value of 2nd row
  67843. * @param initialM24 defines 4th value of 2nd row
  67844. * @param initialM31 defines 1st value of 3rd row
  67845. * @param initialM32 defines 2nd value of 3rd row
  67846. * @param initialM33 defines 3rd value of 3rd row
  67847. * @param initialM34 defines 4th value of 3rd row
  67848. * @param initialM41 defines 1st value of 4th row
  67849. * @param initialM42 defines 2nd value of 4th row
  67850. * @param initialM43 defines 3rd value of 4th row
  67851. * @param initialM44 defines 4th value of 4th row
  67852. * @returns the new matrix
  67853. */
  67854. 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;
  67855. /**
  67856. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  67857. * @param scale defines the scale vector3
  67858. * @param rotation defines the rotation quaternion
  67859. * @param translation defines the translation vector3
  67860. * @returns a new matrix
  67861. */
  67862. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  67863. /**
  67864. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  67865. * @param scale defines the scale vector3
  67866. * @param rotation defines the rotation quaternion
  67867. * @param translation defines the translation vector3
  67868. * @param result defines the target matrix
  67869. */
  67870. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  67871. /**
  67872. * Creates a new identity matrix
  67873. * @returns a new identity matrix
  67874. */
  67875. static Identity(): Matrix;
  67876. /**
  67877. * Creates a new identity matrix and stores the result in a given matrix
  67878. * @param result defines the target matrix
  67879. */
  67880. static IdentityToRef(result: Matrix): void;
  67881. /**
  67882. * Creates a new zero matrix
  67883. * @returns a new zero matrix
  67884. */
  67885. static Zero(): Matrix;
  67886. /**
  67887. * Creates a new rotation matrix for "angle" radians around the X axis
  67888. * @param angle defines the angle (in radians) to use
  67889. * @return the new matrix
  67890. */
  67891. static RotationX(angle: number): Matrix;
  67892. /**
  67893. * Creates a new matrix as the invert of a given matrix
  67894. * @param source defines the source matrix
  67895. * @returns the new matrix
  67896. */
  67897. static Invert(source: DeepImmutable<Matrix>): Matrix;
  67898. /**
  67899. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  67900. * @param angle defines the angle (in radians) to use
  67901. * @param result defines the target matrix
  67902. */
  67903. static RotationXToRef(angle: number, result: Matrix): void;
  67904. /**
  67905. * Creates a new rotation matrix for "angle" radians around the Y axis
  67906. * @param angle defines the angle (in radians) to use
  67907. * @return the new matrix
  67908. */
  67909. static RotationY(angle: number): Matrix;
  67910. /**
  67911. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  67912. * @param angle defines the angle (in radians) to use
  67913. * @param result defines the target matrix
  67914. */
  67915. static RotationYToRef(angle: number, result: Matrix): void;
  67916. /**
  67917. * Creates a new rotation matrix for "angle" radians around the Z axis
  67918. * @param angle defines the angle (in radians) to use
  67919. * @return the new matrix
  67920. */
  67921. static RotationZ(angle: number): Matrix;
  67922. /**
  67923. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  67924. * @param angle defines the angle (in radians) to use
  67925. * @param result defines the target matrix
  67926. */
  67927. static RotationZToRef(angle: number, result: Matrix): void;
  67928. /**
  67929. * Creates a new rotation matrix for "angle" radians around the given axis
  67930. * @param axis defines the axis to use
  67931. * @param angle defines the angle (in radians) to use
  67932. * @return the new matrix
  67933. */
  67934. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  67935. /**
  67936. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  67937. * @param axis defines the axis to use
  67938. * @param angle defines the angle (in radians) to use
  67939. * @param result defines the target matrix
  67940. */
  67941. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  67942. /**
  67943. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  67944. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  67945. * @param from defines the vector to align
  67946. * @param to defines the vector to align to
  67947. * @param result defines the target matrix
  67948. */
  67949. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  67950. /**
  67951. * Creates a rotation matrix
  67952. * @param yaw defines the yaw angle in radians (Y axis)
  67953. * @param pitch defines the pitch angle in radians (X axis)
  67954. * @param roll defines the roll angle in radians (X axis)
  67955. * @returns the new rotation matrix
  67956. */
  67957. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  67958. /**
  67959. * Creates a rotation matrix and stores it in a given matrix
  67960. * @param yaw defines the yaw angle in radians (Y axis)
  67961. * @param pitch defines the pitch angle in radians (X axis)
  67962. * @param roll defines the roll angle in radians (X axis)
  67963. * @param result defines the target matrix
  67964. */
  67965. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  67966. /**
  67967. * Creates a scaling matrix
  67968. * @param x defines the scale factor on X axis
  67969. * @param y defines the scale factor on Y axis
  67970. * @param z defines the scale factor on Z axis
  67971. * @returns the new matrix
  67972. */
  67973. static Scaling(x: number, y: number, z: number): Matrix;
  67974. /**
  67975. * Creates a scaling matrix and stores it in a given matrix
  67976. * @param x defines the scale factor on X axis
  67977. * @param y defines the scale factor on Y axis
  67978. * @param z defines the scale factor on Z axis
  67979. * @param result defines the target matrix
  67980. */
  67981. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  67982. /**
  67983. * Creates a translation matrix
  67984. * @param x defines the translation on X axis
  67985. * @param y defines the translation on Y axis
  67986. * @param z defines the translationon Z axis
  67987. * @returns the new matrix
  67988. */
  67989. static Translation(x: number, y: number, z: number): Matrix;
  67990. /**
  67991. * Creates a translation matrix and stores it in a given matrix
  67992. * @param x defines the translation on X axis
  67993. * @param y defines the translation on Y axis
  67994. * @param z defines the translationon Z axis
  67995. * @param result defines the target matrix
  67996. */
  67997. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  67998. /**
  67999. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  68000. * @param startValue defines the start value
  68001. * @param endValue defines the end value
  68002. * @param gradient defines the gradient factor
  68003. * @returns the new matrix
  68004. */
  68005. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  68006. /**
  68007. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  68008. * @param startValue defines the start value
  68009. * @param endValue defines the end value
  68010. * @param gradient defines the gradient factor
  68011. * @param result defines the Matrix object where to store data
  68012. */
  68013. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  68014. /**
  68015. * Builds a new matrix whose values are computed by:
  68016. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  68017. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  68018. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  68019. * @param startValue defines the first matrix
  68020. * @param endValue defines the second matrix
  68021. * @param gradient defines the gradient between the two matrices
  68022. * @returns the new matrix
  68023. */
  68024. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  68025. /**
  68026. * Update a matrix to values which are computed by:
  68027. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  68028. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  68029. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  68030. * @param startValue defines the first matrix
  68031. * @param endValue defines the second matrix
  68032. * @param gradient defines the gradient between the two matrices
  68033. * @param result defines the target matrix
  68034. */
  68035. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  68036. /**
  68037. * 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"
  68038. * This function works in left handed mode
  68039. * @param eye defines the final position of the entity
  68040. * @param target defines where the entity should look at
  68041. * @param up defines the up vector for the entity
  68042. * @returns the new matrix
  68043. */
  68044. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  68045. /**
  68046. * 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".
  68047. * This function works in left handed mode
  68048. * @param eye defines the final position of the entity
  68049. * @param target defines where the entity should look at
  68050. * @param up defines the up vector for the entity
  68051. * @param result defines the target matrix
  68052. */
  68053. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  68054. /**
  68055. * 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"
  68056. * This function works in right handed mode
  68057. * @param eye defines the final position of the entity
  68058. * @param target defines where the entity should look at
  68059. * @param up defines the up vector for the entity
  68060. * @returns the new matrix
  68061. */
  68062. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  68063. /**
  68064. * 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".
  68065. * This function works in right handed mode
  68066. * @param eye defines the final position of the entity
  68067. * @param target defines where the entity should look at
  68068. * @param up defines the up vector for the entity
  68069. * @param result defines the target matrix
  68070. */
  68071. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  68072. /**
  68073. * Create a left-handed orthographic projection matrix
  68074. * @param width defines the viewport width
  68075. * @param height defines the viewport height
  68076. * @param znear defines the near clip plane
  68077. * @param zfar defines the far clip plane
  68078. * @returns a new matrix as a left-handed orthographic projection matrix
  68079. */
  68080. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  68081. /**
  68082. * Store a left-handed orthographic projection to a given matrix
  68083. * @param width defines the viewport width
  68084. * @param height defines the viewport height
  68085. * @param znear defines the near clip plane
  68086. * @param zfar defines the far clip plane
  68087. * @param result defines the target matrix
  68088. */
  68089. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  68090. /**
  68091. * Create a left-handed orthographic projection matrix
  68092. * @param left defines the viewport left coordinate
  68093. * @param right defines the viewport right coordinate
  68094. * @param bottom defines the viewport bottom coordinate
  68095. * @param top defines the viewport top coordinate
  68096. * @param znear defines the near clip plane
  68097. * @param zfar defines the far clip plane
  68098. * @returns a new matrix as a left-handed orthographic projection matrix
  68099. */
  68100. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  68101. /**
  68102. * Stores a left-handed orthographic projection into a given matrix
  68103. * @param left defines the viewport left coordinate
  68104. * @param right defines the viewport right coordinate
  68105. * @param bottom defines the viewport bottom coordinate
  68106. * @param top defines the viewport top coordinate
  68107. * @param znear defines the near clip plane
  68108. * @param zfar defines the far clip plane
  68109. * @param result defines the target matrix
  68110. */
  68111. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  68112. /**
  68113. * Creates a right-handed orthographic projection matrix
  68114. * @param left defines the viewport left coordinate
  68115. * @param right defines the viewport right coordinate
  68116. * @param bottom defines the viewport bottom coordinate
  68117. * @param top defines the viewport top coordinate
  68118. * @param znear defines the near clip plane
  68119. * @param zfar defines the far clip plane
  68120. * @returns a new matrix as a right-handed orthographic projection matrix
  68121. */
  68122. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  68123. /**
  68124. * Stores a right-handed orthographic projection into a given matrix
  68125. * @param left defines the viewport left coordinate
  68126. * @param right defines the viewport right coordinate
  68127. * @param bottom defines the viewport bottom coordinate
  68128. * @param top defines the viewport top coordinate
  68129. * @param znear defines the near clip plane
  68130. * @param zfar defines the far clip plane
  68131. * @param result defines the target matrix
  68132. */
  68133. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  68134. /**
  68135. * Creates a left-handed perspective projection matrix
  68136. * @param width defines the viewport width
  68137. * @param height defines the viewport height
  68138. * @param znear defines the near clip plane
  68139. * @param zfar defines the far clip plane
  68140. * @returns a new matrix as a left-handed perspective projection matrix
  68141. */
  68142. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  68143. /**
  68144. * Creates a left-handed perspective projection matrix
  68145. * @param fov defines the horizontal field of view
  68146. * @param aspect defines the aspect ratio
  68147. * @param znear defines the near clip plane
  68148. * @param zfar defines the far clip plane
  68149. * @returns a new matrix as a left-handed perspective projection matrix
  68150. */
  68151. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  68152. /**
  68153. * Stores a left-handed perspective projection into a given matrix
  68154. * @param fov defines the horizontal field of view
  68155. * @param aspect defines the aspect ratio
  68156. * @param znear defines the near clip plane
  68157. * @param zfar defines the far clip plane
  68158. * @param result defines the target matrix
  68159. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  68160. */
  68161. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  68162. /**
  68163. * Creates a right-handed perspective projection matrix
  68164. * @param fov defines the horizontal field of view
  68165. * @param aspect defines the aspect ratio
  68166. * @param znear defines the near clip plane
  68167. * @param zfar defines the far clip plane
  68168. * @returns a new matrix as a right-handed perspective projection matrix
  68169. */
  68170. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  68171. /**
  68172. * Stores a right-handed perspective projection into a given matrix
  68173. * @param fov defines the horizontal field of view
  68174. * @param aspect defines the aspect ratio
  68175. * @param znear defines the near clip plane
  68176. * @param zfar defines the far clip plane
  68177. * @param result defines the target matrix
  68178. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  68179. */
  68180. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  68181. /**
  68182. * Stores a perspective projection for WebVR info a given matrix
  68183. * @param fov defines the field of view
  68184. * @param znear defines the near clip plane
  68185. * @param zfar defines the far clip plane
  68186. * @param result defines the target matrix
  68187. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  68188. */
  68189. static PerspectiveFovWebVRToRef(fov: {
  68190. upDegrees: number;
  68191. downDegrees: number;
  68192. leftDegrees: number;
  68193. rightDegrees: number;
  68194. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  68195. /**
  68196. * Computes a complete transformation matrix
  68197. * @param viewport defines the viewport to use
  68198. * @param world defines the world matrix
  68199. * @param view defines the view matrix
  68200. * @param projection defines the projection matrix
  68201. * @param zmin defines the near clip plane
  68202. * @param zmax defines the far clip plane
  68203. * @returns the transformation matrix
  68204. */
  68205. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  68206. /**
  68207. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  68208. * @param matrix defines the matrix to use
  68209. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  68210. */
  68211. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  68212. /**
  68213. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  68214. * @param matrix defines the matrix to use
  68215. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  68216. */
  68217. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  68218. /**
  68219. * Compute the transpose of a given matrix
  68220. * @param matrix defines the matrix to transpose
  68221. * @returns the new matrix
  68222. */
  68223. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  68224. /**
  68225. * Compute the transpose of a matrix and store it in a target matrix
  68226. * @param matrix defines the matrix to transpose
  68227. * @param result defines the target matrix
  68228. */
  68229. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  68230. /**
  68231. * Computes a reflection matrix from a plane
  68232. * @param plane defines the reflection plane
  68233. * @returns a new matrix
  68234. */
  68235. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  68236. /**
  68237. * Computes a reflection matrix from a plane
  68238. * @param plane defines the reflection plane
  68239. * @param result defines the target matrix
  68240. */
  68241. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  68242. /**
  68243. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  68244. * @param xaxis defines the value of the 1st axis
  68245. * @param yaxis defines the value of the 2nd axis
  68246. * @param zaxis defines the value of the 3rd axis
  68247. * @param result defines the target matrix
  68248. */
  68249. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  68250. /**
  68251. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  68252. * @param quat defines the quaternion to use
  68253. * @param result defines the target matrix
  68254. */
  68255. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  68256. }
  68257. /**
  68258. * @hidden
  68259. */
  68260. export class TmpVectors {
  68261. static Vector2: Vector2[];
  68262. static Vector3: Vector3[];
  68263. static Vector4: Vector4[];
  68264. static Quaternion: Quaternion[];
  68265. static Matrix: Matrix[];
  68266. }
  68267. }
  68268. declare module BABYLON {
  68269. /** Defines the cross module used constants to avoid circular dependncies */
  68270. export class Constants {
  68271. /** Defines that alpha blending is disabled */
  68272. static readonly ALPHA_DISABLE: number;
  68273. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  68274. static readonly ALPHA_ADD: number;
  68275. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  68276. static readonly ALPHA_COMBINE: number;
  68277. /** Defines that alpha blending to DEST - SRC * DEST */
  68278. static readonly ALPHA_SUBTRACT: number;
  68279. /** Defines that alpha blending to SRC * DEST */
  68280. static readonly ALPHA_MULTIPLY: number;
  68281. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  68282. static readonly ALPHA_MAXIMIZED: number;
  68283. /** Defines that alpha blending to SRC + DEST */
  68284. static readonly ALPHA_ONEONE: number;
  68285. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  68286. static readonly ALPHA_PREMULTIPLIED: number;
  68287. /**
  68288. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  68289. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  68290. */
  68291. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  68292. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  68293. static readonly ALPHA_INTERPOLATE: number;
  68294. /**
  68295. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  68296. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  68297. */
  68298. static readonly ALPHA_SCREENMODE: number;
  68299. /** Defines that the ressource is not delayed*/
  68300. static readonly DELAYLOADSTATE_NONE: number;
  68301. /** Defines that the ressource was successfully delay loaded */
  68302. static readonly DELAYLOADSTATE_LOADED: number;
  68303. /** Defines that the ressource is currently delay loading */
  68304. static readonly DELAYLOADSTATE_LOADING: number;
  68305. /** Defines that the ressource is delayed and has not started loading */
  68306. static readonly DELAYLOADSTATE_NOTLOADED: number;
  68307. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  68308. static readonly NEVER: number;
  68309. /** 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 */
  68310. static readonly ALWAYS: number;
  68311. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  68312. static readonly LESS: number;
  68313. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  68314. static readonly EQUAL: number;
  68315. /** 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 */
  68316. static readonly LEQUAL: number;
  68317. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  68318. static readonly GREATER: number;
  68319. /** 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 */
  68320. static readonly GEQUAL: number;
  68321. /** 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 */
  68322. static readonly NOTEQUAL: number;
  68323. /** Passed to stencilOperation to specify that stencil value must be kept */
  68324. static readonly KEEP: number;
  68325. /** Passed to stencilOperation to specify that stencil value must be replaced */
  68326. static readonly REPLACE: number;
  68327. /** Passed to stencilOperation to specify that stencil value must be incremented */
  68328. static readonly INCR: number;
  68329. /** Passed to stencilOperation to specify that stencil value must be decremented */
  68330. static readonly DECR: number;
  68331. /** Passed to stencilOperation to specify that stencil value must be inverted */
  68332. static readonly INVERT: number;
  68333. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  68334. static readonly INCR_WRAP: number;
  68335. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  68336. static readonly DECR_WRAP: number;
  68337. /** Texture is not repeating outside of 0..1 UVs */
  68338. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  68339. /** Texture is repeating outside of 0..1 UVs */
  68340. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  68341. /** Texture is repeating and mirrored */
  68342. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  68343. /** ALPHA */
  68344. static readonly TEXTUREFORMAT_ALPHA: number;
  68345. /** LUMINANCE */
  68346. static readonly TEXTUREFORMAT_LUMINANCE: number;
  68347. /** LUMINANCE_ALPHA */
  68348. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  68349. /** RGB */
  68350. static readonly TEXTUREFORMAT_RGB: number;
  68351. /** RGBA */
  68352. static readonly TEXTUREFORMAT_RGBA: number;
  68353. /** RED */
  68354. static readonly TEXTUREFORMAT_RED: number;
  68355. /** RED (2nd reference) */
  68356. static readonly TEXTUREFORMAT_R: number;
  68357. /** RG */
  68358. static readonly TEXTUREFORMAT_RG: number;
  68359. /** RED_INTEGER */
  68360. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  68361. /** RED_INTEGER (2nd reference) */
  68362. static readonly TEXTUREFORMAT_R_INTEGER: number;
  68363. /** RG_INTEGER */
  68364. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  68365. /** RGB_INTEGER */
  68366. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  68367. /** RGBA_INTEGER */
  68368. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  68369. /** UNSIGNED_BYTE */
  68370. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  68371. /** UNSIGNED_BYTE (2nd reference) */
  68372. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  68373. /** FLOAT */
  68374. static readonly TEXTURETYPE_FLOAT: number;
  68375. /** HALF_FLOAT */
  68376. static readonly TEXTURETYPE_HALF_FLOAT: number;
  68377. /** BYTE */
  68378. static readonly TEXTURETYPE_BYTE: number;
  68379. /** SHORT */
  68380. static readonly TEXTURETYPE_SHORT: number;
  68381. /** UNSIGNED_SHORT */
  68382. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  68383. /** INT */
  68384. static readonly TEXTURETYPE_INT: number;
  68385. /** UNSIGNED_INT */
  68386. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  68387. /** UNSIGNED_SHORT_4_4_4_4 */
  68388. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  68389. /** UNSIGNED_SHORT_5_5_5_1 */
  68390. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  68391. /** UNSIGNED_SHORT_5_6_5 */
  68392. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  68393. /** UNSIGNED_INT_2_10_10_10_REV */
  68394. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  68395. /** UNSIGNED_INT_24_8 */
  68396. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  68397. /** UNSIGNED_INT_10F_11F_11F_REV */
  68398. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  68399. /** UNSIGNED_INT_5_9_9_9_REV */
  68400. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  68401. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  68402. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  68403. /** nearest is mag = nearest and min = nearest and mip = linear */
  68404. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  68405. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68406. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  68407. /** Trilinear is mag = linear and min = linear and mip = linear */
  68408. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  68409. /** nearest is mag = nearest and min = nearest and mip = linear */
  68410. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  68411. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68412. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  68413. /** Trilinear is mag = linear and min = linear and mip = linear */
  68414. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  68415. /** mag = nearest and min = nearest and mip = nearest */
  68416. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  68417. /** mag = nearest and min = linear and mip = nearest */
  68418. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  68419. /** mag = nearest and min = linear and mip = linear */
  68420. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  68421. /** mag = nearest and min = linear and mip = none */
  68422. static readonly TEXTURE_NEAREST_LINEAR: number;
  68423. /** mag = nearest and min = nearest and mip = none */
  68424. static readonly TEXTURE_NEAREST_NEAREST: number;
  68425. /** mag = linear and min = nearest and mip = nearest */
  68426. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  68427. /** mag = linear and min = nearest and mip = linear */
  68428. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  68429. /** mag = linear and min = linear and mip = none */
  68430. static readonly TEXTURE_LINEAR_LINEAR: number;
  68431. /** mag = linear and min = nearest and mip = none */
  68432. static readonly TEXTURE_LINEAR_NEAREST: number;
  68433. /** Explicit coordinates mode */
  68434. static readonly TEXTURE_EXPLICIT_MODE: number;
  68435. /** Spherical coordinates mode */
  68436. static readonly TEXTURE_SPHERICAL_MODE: number;
  68437. /** Planar coordinates mode */
  68438. static readonly TEXTURE_PLANAR_MODE: number;
  68439. /** Cubic coordinates mode */
  68440. static readonly TEXTURE_CUBIC_MODE: number;
  68441. /** Projection coordinates mode */
  68442. static readonly TEXTURE_PROJECTION_MODE: number;
  68443. /** Skybox coordinates mode */
  68444. static readonly TEXTURE_SKYBOX_MODE: number;
  68445. /** Inverse Cubic coordinates mode */
  68446. static readonly TEXTURE_INVCUBIC_MODE: number;
  68447. /** Equirectangular coordinates mode */
  68448. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  68449. /** Equirectangular Fixed coordinates mode */
  68450. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  68451. /** Equirectangular Fixed Mirrored coordinates mode */
  68452. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  68453. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  68454. static readonly SCALEMODE_FLOOR: number;
  68455. /** Defines that texture rescaling will look for the nearest power of 2 size */
  68456. static readonly SCALEMODE_NEAREST: number;
  68457. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  68458. static readonly SCALEMODE_CEILING: number;
  68459. /**
  68460. * The dirty texture flag value
  68461. */
  68462. static readonly MATERIAL_TextureDirtyFlag: number;
  68463. /**
  68464. * The dirty light flag value
  68465. */
  68466. static readonly MATERIAL_LightDirtyFlag: number;
  68467. /**
  68468. * The dirty fresnel flag value
  68469. */
  68470. static readonly MATERIAL_FresnelDirtyFlag: number;
  68471. /**
  68472. * The dirty attribute flag value
  68473. */
  68474. static readonly MATERIAL_AttributesDirtyFlag: number;
  68475. /**
  68476. * The dirty misc flag value
  68477. */
  68478. static readonly MATERIAL_MiscDirtyFlag: number;
  68479. /**
  68480. * The all dirty flag value
  68481. */
  68482. static readonly MATERIAL_AllDirtyFlag: number;
  68483. /**
  68484. * Returns the triangle fill mode
  68485. */
  68486. static readonly MATERIAL_TriangleFillMode: number;
  68487. /**
  68488. * Returns the wireframe mode
  68489. */
  68490. static readonly MATERIAL_WireFrameFillMode: number;
  68491. /**
  68492. * Returns the point fill mode
  68493. */
  68494. static readonly MATERIAL_PointFillMode: number;
  68495. /**
  68496. * Returns the point list draw mode
  68497. */
  68498. static readonly MATERIAL_PointListDrawMode: number;
  68499. /**
  68500. * Returns the line list draw mode
  68501. */
  68502. static readonly MATERIAL_LineListDrawMode: number;
  68503. /**
  68504. * Returns the line loop draw mode
  68505. */
  68506. static readonly MATERIAL_LineLoopDrawMode: number;
  68507. /**
  68508. * Returns the line strip draw mode
  68509. */
  68510. static readonly MATERIAL_LineStripDrawMode: number;
  68511. /**
  68512. * Returns the triangle strip draw mode
  68513. */
  68514. static readonly MATERIAL_TriangleStripDrawMode: number;
  68515. /**
  68516. * Returns the triangle fan draw mode
  68517. */
  68518. static readonly MATERIAL_TriangleFanDrawMode: number;
  68519. /**
  68520. * Stores the clock-wise side orientation
  68521. */
  68522. static readonly MATERIAL_ClockWiseSideOrientation: number;
  68523. /**
  68524. * Stores the counter clock-wise side orientation
  68525. */
  68526. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  68527. /**
  68528. * Nothing
  68529. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68530. */
  68531. static readonly ACTION_NothingTrigger: number;
  68532. /**
  68533. * On pick
  68534. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68535. */
  68536. static readonly ACTION_OnPickTrigger: number;
  68537. /**
  68538. * On left pick
  68539. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68540. */
  68541. static readonly ACTION_OnLeftPickTrigger: number;
  68542. /**
  68543. * On right pick
  68544. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68545. */
  68546. static readonly ACTION_OnRightPickTrigger: number;
  68547. /**
  68548. * On center pick
  68549. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68550. */
  68551. static readonly ACTION_OnCenterPickTrigger: number;
  68552. /**
  68553. * On pick down
  68554. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68555. */
  68556. static readonly ACTION_OnPickDownTrigger: number;
  68557. /**
  68558. * On double pick
  68559. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68560. */
  68561. static readonly ACTION_OnDoublePickTrigger: number;
  68562. /**
  68563. * On pick up
  68564. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68565. */
  68566. static readonly ACTION_OnPickUpTrigger: number;
  68567. /**
  68568. * On pick out.
  68569. * This trigger will only be raised if you also declared a OnPickDown
  68570. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68571. */
  68572. static readonly ACTION_OnPickOutTrigger: number;
  68573. /**
  68574. * On long press
  68575. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68576. */
  68577. static readonly ACTION_OnLongPressTrigger: number;
  68578. /**
  68579. * On pointer over
  68580. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68581. */
  68582. static readonly ACTION_OnPointerOverTrigger: number;
  68583. /**
  68584. * On pointer out
  68585. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68586. */
  68587. static readonly ACTION_OnPointerOutTrigger: number;
  68588. /**
  68589. * On every frame
  68590. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68591. */
  68592. static readonly ACTION_OnEveryFrameTrigger: number;
  68593. /**
  68594. * On intersection enter
  68595. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68596. */
  68597. static readonly ACTION_OnIntersectionEnterTrigger: number;
  68598. /**
  68599. * On intersection exit
  68600. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68601. */
  68602. static readonly ACTION_OnIntersectionExitTrigger: number;
  68603. /**
  68604. * On key down
  68605. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68606. */
  68607. static readonly ACTION_OnKeyDownTrigger: number;
  68608. /**
  68609. * On key up
  68610. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68611. */
  68612. static readonly ACTION_OnKeyUpTrigger: number;
  68613. /**
  68614. * Billboard mode will only apply to Y axis
  68615. */
  68616. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  68617. /**
  68618. * Billboard mode will apply to all axes
  68619. */
  68620. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  68621. /**
  68622. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  68623. */
  68624. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  68625. /**
  68626. * Gets or sets base Assets URL
  68627. */
  68628. static PARTICLES_BaseAssetsUrl: string;
  68629. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  68630. * Test order :
  68631. * Is the bounding sphere outside the frustum ?
  68632. * If not, are the bounding box vertices outside the frustum ?
  68633. * It not, then the cullable object is in the frustum.
  68634. */
  68635. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  68636. /** Culling strategy : Bounding Sphere Only.
  68637. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  68638. * It's also less accurate than the standard because some not visible objects can still be selected.
  68639. * Test : is the bounding sphere outside the frustum ?
  68640. * If not, then the cullable object is in the frustum.
  68641. */
  68642. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  68643. /** Culling strategy : Optimistic Inclusion.
  68644. * This in an inclusion test first, then the standard exclusion test.
  68645. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  68646. * 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.
  68647. * Anyway, it's as accurate as the standard strategy.
  68648. * Test :
  68649. * Is the cullable object bounding sphere center in the frustum ?
  68650. * If not, apply the default culling strategy.
  68651. */
  68652. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  68653. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  68654. * This in an inclusion test first, then the bounding sphere only exclusion test.
  68655. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  68656. * 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.
  68657. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  68658. * Test :
  68659. * Is the cullable object bounding sphere center in the frustum ?
  68660. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  68661. */
  68662. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  68663. /**
  68664. * No logging while loading
  68665. */
  68666. static readonly SCENELOADER_NO_LOGGING: number;
  68667. /**
  68668. * Minimal logging while loading
  68669. */
  68670. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  68671. /**
  68672. * Summary logging while loading
  68673. */
  68674. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  68675. /**
  68676. * Detailled logging while loading
  68677. */
  68678. static readonly SCENELOADER_DETAILED_LOGGING: number;
  68679. }
  68680. }
  68681. declare module BABYLON {
  68682. /**
  68683. * Class used to store and describe the pipeline context associated with an effect
  68684. */
  68685. export interface IPipelineContext {
  68686. /**
  68687. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  68688. */
  68689. isAsync: boolean;
  68690. /**
  68691. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  68692. */
  68693. isReady: boolean;
  68694. /** @hidden */
  68695. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  68696. }
  68697. }
  68698. declare module BABYLON {
  68699. /** @hidden */
  68700. export interface IShaderProcessor {
  68701. attributeProcessor?: (attribute: string) => string;
  68702. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  68703. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  68704. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  68705. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  68706. lineProcessor?: (line: string, isFragment: boolean) => string;
  68707. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  68708. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  68709. }
  68710. }
  68711. declare module BABYLON {
  68712. /** @hidden */
  68713. export interface ProcessingOptions {
  68714. defines: string[];
  68715. indexParameters: any;
  68716. isFragment: boolean;
  68717. shouldUseHighPrecisionShader: boolean;
  68718. supportsUniformBuffers: boolean;
  68719. shadersRepository: string;
  68720. includesShadersStore: {
  68721. [key: string]: string;
  68722. };
  68723. processor?: IShaderProcessor;
  68724. version: string;
  68725. platformName: string;
  68726. lookForClosingBracketForUniformBuffer?: boolean;
  68727. }
  68728. }
  68729. declare module BABYLON {
  68730. /**
  68731. * Helper to manipulate strings
  68732. */
  68733. export class StringTools {
  68734. /**
  68735. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  68736. * @param str Source string
  68737. * @param suffix Suffix to search for in the source string
  68738. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68739. */
  68740. static EndsWith(str: string, suffix: string): boolean;
  68741. /**
  68742. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  68743. * @param str Source string
  68744. * @param suffix Suffix to search for in the source string
  68745. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68746. */
  68747. static StartsWith(str: string, suffix: string): boolean;
  68748. }
  68749. }
  68750. declare module BABYLON {
  68751. /** @hidden */
  68752. export class ShaderCodeNode {
  68753. line: string;
  68754. children: ShaderCodeNode[];
  68755. additionalDefineKey?: string;
  68756. additionalDefineValue?: string;
  68757. isValid(preprocessors: {
  68758. [key: string]: string;
  68759. }): boolean;
  68760. process(preprocessors: {
  68761. [key: string]: string;
  68762. }, options: ProcessingOptions): string;
  68763. }
  68764. }
  68765. declare module BABYLON {
  68766. /** @hidden */
  68767. export class ShaderCodeCursor {
  68768. private _lines;
  68769. lineIndex: number;
  68770. readonly currentLine: string;
  68771. readonly canRead: boolean;
  68772. lines: string[];
  68773. }
  68774. }
  68775. declare module BABYLON {
  68776. /** @hidden */
  68777. export class ShaderCodeConditionNode extends ShaderCodeNode {
  68778. process(preprocessors: {
  68779. [key: string]: string;
  68780. }, options: ProcessingOptions): string;
  68781. }
  68782. }
  68783. declare module BABYLON {
  68784. /** @hidden */
  68785. export class ShaderDefineExpression {
  68786. isTrue(preprocessors: {
  68787. [key: string]: string;
  68788. }): boolean;
  68789. }
  68790. }
  68791. declare module BABYLON {
  68792. /** @hidden */
  68793. export class ShaderCodeTestNode extends ShaderCodeNode {
  68794. testExpression: ShaderDefineExpression;
  68795. isValid(preprocessors: {
  68796. [key: string]: string;
  68797. }): boolean;
  68798. }
  68799. }
  68800. declare module BABYLON {
  68801. /** @hidden */
  68802. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  68803. define: string;
  68804. not: boolean;
  68805. constructor(define: string, not?: boolean);
  68806. isTrue(preprocessors: {
  68807. [key: string]: string;
  68808. }): boolean;
  68809. }
  68810. }
  68811. declare module BABYLON {
  68812. /** @hidden */
  68813. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  68814. leftOperand: ShaderDefineExpression;
  68815. rightOperand: ShaderDefineExpression;
  68816. isTrue(preprocessors: {
  68817. [key: string]: string;
  68818. }): boolean;
  68819. }
  68820. }
  68821. declare module BABYLON {
  68822. /** @hidden */
  68823. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  68824. leftOperand: ShaderDefineExpression;
  68825. rightOperand: ShaderDefineExpression;
  68826. isTrue(preprocessors: {
  68827. [key: string]: string;
  68828. }): boolean;
  68829. }
  68830. }
  68831. declare module BABYLON {
  68832. /** @hidden */
  68833. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  68834. define: string;
  68835. operand: string;
  68836. testValue: string;
  68837. constructor(define: string, operand: string, testValue: string);
  68838. isTrue(preprocessors: {
  68839. [key: string]: string;
  68840. }): boolean;
  68841. }
  68842. }
  68843. declare module BABYLON {
  68844. /**
  68845. * @ignore
  68846. * Application error to support additional information when loading a file
  68847. */
  68848. export class LoadFileError extends Error {
  68849. /** defines the optional web request */
  68850. request?: WebRequest | undefined;
  68851. private static _setPrototypeOf;
  68852. /**
  68853. * Creates a new LoadFileError
  68854. * @param message defines the message of the error
  68855. * @param request defines the optional web request
  68856. */
  68857. constructor(message: string,
  68858. /** defines the optional web request */
  68859. request?: WebRequest | undefined);
  68860. }
  68861. }
  68862. declare module BABYLON {
  68863. /**
  68864. * Class used to enable access to offline support
  68865. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  68866. */
  68867. export interface IOfflineProvider {
  68868. /**
  68869. * Gets a boolean indicating if scene must be saved in the database
  68870. */
  68871. enableSceneOffline: boolean;
  68872. /**
  68873. * Gets a boolean indicating if textures must be saved in the database
  68874. */
  68875. enableTexturesOffline: boolean;
  68876. /**
  68877. * Open the offline support and make it available
  68878. * @param successCallback defines the callback to call on success
  68879. * @param errorCallback defines the callback to call on error
  68880. */
  68881. open(successCallback: () => void, errorCallback: () => void): void;
  68882. /**
  68883. * Loads an image from the offline support
  68884. * @param url defines the url to load from
  68885. * @param image defines the target DOM image
  68886. */
  68887. loadImage(url: string, image: HTMLImageElement): void;
  68888. /**
  68889. * Loads a file from offline support
  68890. * @param url defines the URL to load from
  68891. * @param sceneLoaded defines a callback to call on success
  68892. * @param progressCallBack defines a callback to call when progress changed
  68893. * @param errorCallback defines a callback to call on error
  68894. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  68895. */
  68896. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  68897. }
  68898. }
  68899. declare module BABYLON {
  68900. /**
  68901. * Class used to help managing file picking and drag'n'drop
  68902. * File Storage
  68903. */
  68904. export class FilesInputStore {
  68905. /**
  68906. * List of files ready to be loaded
  68907. */
  68908. static FilesToLoad: {
  68909. [key: string]: File;
  68910. };
  68911. }
  68912. }
  68913. declare module BABYLON {
  68914. /**
  68915. * Class used to define a retry strategy when error happens while loading assets
  68916. */
  68917. export class RetryStrategy {
  68918. /**
  68919. * Function used to defines an exponential back off strategy
  68920. * @param maxRetries defines the maximum number of retries (3 by default)
  68921. * @param baseInterval defines the interval between retries
  68922. * @returns the strategy function to use
  68923. */
  68924. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  68925. }
  68926. }
  68927. declare module BABYLON {
  68928. /**
  68929. * @hidden
  68930. */
  68931. export class FileTools {
  68932. /**
  68933. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  68934. */
  68935. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  68936. /**
  68937. * Gets or sets the base URL to use to load assets
  68938. */
  68939. static BaseUrl: string;
  68940. /**
  68941. * Default behaviour for cors in the application.
  68942. * It can be a string if the expected behavior is identical in the entire app.
  68943. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  68944. */
  68945. static CorsBehavior: string | ((url: string | string[]) => string);
  68946. /**
  68947. * Gets or sets a function used to pre-process url before using them to load assets
  68948. */
  68949. static PreprocessUrl: (url: string) => string;
  68950. /**
  68951. * Removes unwanted characters from an url
  68952. * @param url defines the url to clean
  68953. * @returns the cleaned url
  68954. */
  68955. private static _CleanUrl;
  68956. /**
  68957. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  68958. * @param url define the url we are trying
  68959. * @param element define the dom element where to configure the cors policy
  68960. */
  68961. static SetCorsBehavior(url: string | string[], element: {
  68962. crossOrigin: string | null;
  68963. }): void;
  68964. /**
  68965. * Loads an image as an HTMLImageElement.
  68966. * @param input url string, ArrayBuffer, or Blob to load
  68967. * @param onLoad callback called when the image successfully loads
  68968. * @param onError callback called when the image fails to load
  68969. * @param offlineProvider offline provider for caching
  68970. * @returns the HTMLImageElement of the loaded image
  68971. */
  68972. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  68973. /**
  68974. * Loads a file
  68975. * @param fileToLoad defines the file to load
  68976. * @param callback defines the callback to call when data is loaded
  68977. * @param progressCallBack defines the callback to call during loading process
  68978. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  68979. * @returns a file request object
  68980. */
  68981. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  68982. /**
  68983. * Loads a file
  68984. * @param url url string, ArrayBuffer, or Blob to load
  68985. * @param onSuccess callback called when the file successfully loads
  68986. * @param onProgress callback called while file is loading (if the server supports this mode)
  68987. * @param offlineProvider defines the offline provider for caching
  68988. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  68989. * @param onError callback called when the file fails to load
  68990. * @returns a file request object
  68991. */
  68992. 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;
  68993. /**
  68994. * Checks if the loaded document was accessed via `file:`-Protocol.
  68995. * @returns boolean
  68996. */
  68997. static IsFileURL(): boolean;
  68998. }
  68999. }
  69000. declare module BABYLON {
  69001. /** @hidden */
  69002. export class ShaderProcessor {
  69003. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  69004. private static _ProcessPrecision;
  69005. private static _ExtractOperation;
  69006. private static _BuildSubExpression;
  69007. private static _BuildExpression;
  69008. private static _MoveCursorWithinIf;
  69009. private static _MoveCursor;
  69010. private static _EvaluatePreProcessors;
  69011. private static _PreparePreProcessors;
  69012. private static _ProcessShaderConversion;
  69013. private static _ProcessIncludes;
  69014. }
  69015. }
  69016. declare module BABYLON {
  69017. /**
  69018. * Class used to hold a RBG color
  69019. */
  69020. export class Color3 {
  69021. /**
  69022. * Defines the red component (between 0 and 1, default is 0)
  69023. */
  69024. r: number;
  69025. /**
  69026. * Defines the green component (between 0 and 1, default is 0)
  69027. */
  69028. g: number;
  69029. /**
  69030. * Defines the blue component (between 0 and 1, default is 0)
  69031. */
  69032. b: number;
  69033. /**
  69034. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  69035. * @param r defines the red component (between 0 and 1, default is 0)
  69036. * @param g defines the green component (between 0 and 1, default is 0)
  69037. * @param b defines the blue component (between 0 and 1, default is 0)
  69038. */
  69039. constructor(
  69040. /**
  69041. * Defines the red component (between 0 and 1, default is 0)
  69042. */
  69043. r?: number,
  69044. /**
  69045. * Defines the green component (between 0 and 1, default is 0)
  69046. */
  69047. g?: number,
  69048. /**
  69049. * Defines the blue component (between 0 and 1, default is 0)
  69050. */
  69051. b?: number);
  69052. /**
  69053. * Creates a string with the Color3 current values
  69054. * @returns the string representation of the Color3 object
  69055. */
  69056. toString(): string;
  69057. /**
  69058. * Returns the string "Color3"
  69059. * @returns "Color3"
  69060. */
  69061. getClassName(): string;
  69062. /**
  69063. * Compute the Color3 hash code
  69064. * @returns an unique number that can be used to hash Color3 objects
  69065. */
  69066. getHashCode(): number;
  69067. /**
  69068. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  69069. * @param array defines the array where to store the r,g,b components
  69070. * @param index defines an optional index in the target array to define where to start storing values
  69071. * @returns the current Color3 object
  69072. */
  69073. toArray(array: FloatArray, index?: number): Color3;
  69074. /**
  69075. * Returns a new Color4 object from the current Color3 and the given alpha
  69076. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  69077. * @returns a new Color4 object
  69078. */
  69079. toColor4(alpha?: number): Color4;
  69080. /**
  69081. * Returns a new array populated with 3 numeric elements : red, green and blue values
  69082. * @returns the new array
  69083. */
  69084. asArray(): number[];
  69085. /**
  69086. * Returns the luminance value
  69087. * @returns a float value
  69088. */
  69089. toLuminance(): number;
  69090. /**
  69091. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  69092. * @param otherColor defines the second operand
  69093. * @returns the new Color3 object
  69094. */
  69095. multiply(otherColor: DeepImmutable<Color3>): Color3;
  69096. /**
  69097. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  69098. * @param otherColor defines the second operand
  69099. * @param result defines the Color3 object where to store the result
  69100. * @returns the current Color3
  69101. */
  69102. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  69103. /**
  69104. * Determines equality between Color3 objects
  69105. * @param otherColor defines the second operand
  69106. * @returns true if the rgb values are equal to the given ones
  69107. */
  69108. equals(otherColor: DeepImmutable<Color3>): boolean;
  69109. /**
  69110. * Determines equality between the current Color3 object and a set of r,b,g values
  69111. * @param r defines the red component to check
  69112. * @param g defines the green component to check
  69113. * @param b defines the blue component to check
  69114. * @returns true if the rgb values are equal to the given ones
  69115. */
  69116. equalsFloats(r: number, g: number, b: number): boolean;
  69117. /**
  69118. * Multiplies in place each rgb value by scale
  69119. * @param scale defines the scaling factor
  69120. * @returns the updated Color3
  69121. */
  69122. scale(scale: number): Color3;
  69123. /**
  69124. * Multiplies the rgb values by scale and stores the result into "result"
  69125. * @param scale defines the scaling factor
  69126. * @param result defines the Color3 object where to store the result
  69127. * @returns the unmodified current Color3
  69128. */
  69129. scaleToRef(scale: number, result: Color3): Color3;
  69130. /**
  69131. * Scale the current Color3 values by a factor and add the result to a given Color3
  69132. * @param scale defines the scale factor
  69133. * @param result defines color to store the result into
  69134. * @returns the unmodified current Color3
  69135. */
  69136. scaleAndAddToRef(scale: number, result: Color3): Color3;
  69137. /**
  69138. * Clamps the rgb values by the min and max values and stores the result into "result"
  69139. * @param min defines minimum clamping value (default is 0)
  69140. * @param max defines maximum clamping value (default is 1)
  69141. * @param result defines color to store the result into
  69142. * @returns the original Color3
  69143. */
  69144. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  69145. /**
  69146. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  69147. * @param otherColor defines the second operand
  69148. * @returns the new Color3
  69149. */
  69150. add(otherColor: DeepImmutable<Color3>): Color3;
  69151. /**
  69152. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  69153. * @param otherColor defines the second operand
  69154. * @param result defines Color3 object to store the result into
  69155. * @returns the unmodified current Color3
  69156. */
  69157. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  69158. /**
  69159. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  69160. * @param otherColor defines the second operand
  69161. * @returns the new Color3
  69162. */
  69163. subtract(otherColor: DeepImmutable<Color3>): Color3;
  69164. /**
  69165. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  69166. * @param otherColor defines the second operand
  69167. * @param result defines Color3 object to store the result into
  69168. * @returns the unmodified current Color3
  69169. */
  69170. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  69171. /**
  69172. * Copy the current object
  69173. * @returns a new Color3 copied the current one
  69174. */
  69175. clone(): Color3;
  69176. /**
  69177. * Copies the rgb values from the source in the current Color3
  69178. * @param source defines the source Color3 object
  69179. * @returns the updated Color3 object
  69180. */
  69181. copyFrom(source: DeepImmutable<Color3>): Color3;
  69182. /**
  69183. * Updates the Color3 rgb values from the given floats
  69184. * @param r defines the red component to read from
  69185. * @param g defines the green component to read from
  69186. * @param b defines the blue component to read from
  69187. * @returns the current Color3 object
  69188. */
  69189. copyFromFloats(r: number, g: number, b: number): Color3;
  69190. /**
  69191. * Updates the Color3 rgb values from the given floats
  69192. * @param r defines the red component to read from
  69193. * @param g defines the green component to read from
  69194. * @param b defines the blue component to read from
  69195. * @returns the current Color3 object
  69196. */
  69197. set(r: number, g: number, b: number): Color3;
  69198. /**
  69199. * Compute the Color3 hexadecimal code as a string
  69200. * @returns a string containing the hexadecimal representation of the Color3 object
  69201. */
  69202. toHexString(): string;
  69203. /**
  69204. * Computes a new Color3 converted from the current one to linear space
  69205. * @returns a new Color3 object
  69206. */
  69207. toLinearSpace(): Color3;
  69208. /**
  69209. * Converts current color in rgb space to HSV values
  69210. * @returns a new color3 representing the HSV values
  69211. */
  69212. toHSV(): Color3;
  69213. /**
  69214. * Converts current color in rgb space to HSV values
  69215. * @param result defines the Color3 where to store the HSV values
  69216. */
  69217. toHSVToRef(result: Color3): void;
  69218. /**
  69219. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  69220. * @param convertedColor defines the Color3 object where to store the linear space version
  69221. * @returns the unmodified Color3
  69222. */
  69223. toLinearSpaceToRef(convertedColor: Color3): Color3;
  69224. /**
  69225. * Computes a new Color3 converted from the current one to gamma space
  69226. * @returns a new Color3 object
  69227. */
  69228. toGammaSpace(): Color3;
  69229. /**
  69230. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  69231. * @param convertedColor defines the Color3 object where to store the gamma space version
  69232. * @returns the unmodified Color3
  69233. */
  69234. toGammaSpaceToRef(convertedColor: Color3): Color3;
  69235. private static _BlackReadOnly;
  69236. /**
  69237. * Convert Hue, saturation and value to a Color3 (RGB)
  69238. * @param hue defines the hue
  69239. * @param saturation defines the saturation
  69240. * @param value defines the value
  69241. * @param result defines the Color3 where to store the RGB values
  69242. */
  69243. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  69244. /**
  69245. * Creates a new Color3 from the string containing valid hexadecimal values
  69246. * @param hex defines a string containing valid hexadecimal values
  69247. * @returns a new Color3 object
  69248. */
  69249. static FromHexString(hex: string): Color3;
  69250. /**
  69251. * Creates a new Color3 from the starting index of the given array
  69252. * @param array defines the source array
  69253. * @param offset defines an offset in the source array
  69254. * @returns a new Color3 object
  69255. */
  69256. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  69257. /**
  69258. * Creates a new Color3 from integer values (< 256)
  69259. * @param r defines the red component to read from (value between 0 and 255)
  69260. * @param g defines the green component to read from (value between 0 and 255)
  69261. * @param b defines the blue component to read from (value between 0 and 255)
  69262. * @returns a new Color3 object
  69263. */
  69264. static FromInts(r: number, g: number, b: number): Color3;
  69265. /**
  69266. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  69267. * @param start defines the start Color3 value
  69268. * @param end defines the end Color3 value
  69269. * @param amount defines the gradient value between start and end
  69270. * @returns a new Color3 object
  69271. */
  69272. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  69273. /**
  69274. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  69275. * @param left defines the start value
  69276. * @param right defines the end value
  69277. * @param amount defines the gradient factor
  69278. * @param result defines the Color3 object where to store the result
  69279. */
  69280. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  69281. /**
  69282. * Returns a Color3 value containing a red color
  69283. * @returns a new Color3 object
  69284. */
  69285. static Red(): Color3;
  69286. /**
  69287. * Returns a Color3 value containing a green color
  69288. * @returns a new Color3 object
  69289. */
  69290. static Green(): Color3;
  69291. /**
  69292. * Returns a Color3 value containing a blue color
  69293. * @returns a new Color3 object
  69294. */
  69295. static Blue(): Color3;
  69296. /**
  69297. * Returns a Color3 value containing a black color
  69298. * @returns a new Color3 object
  69299. */
  69300. static Black(): Color3;
  69301. /**
  69302. * Gets a Color3 value containing a black color that must not be updated
  69303. */
  69304. static readonly BlackReadOnly: DeepImmutable<Color3>;
  69305. /**
  69306. * Returns a Color3 value containing a white color
  69307. * @returns a new Color3 object
  69308. */
  69309. static White(): Color3;
  69310. /**
  69311. * Returns a Color3 value containing a purple color
  69312. * @returns a new Color3 object
  69313. */
  69314. static Purple(): Color3;
  69315. /**
  69316. * Returns a Color3 value containing a magenta color
  69317. * @returns a new Color3 object
  69318. */
  69319. static Magenta(): Color3;
  69320. /**
  69321. * Returns a Color3 value containing a yellow color
  69322. * @returns a new Color3 object
  69323. */
  69324. static Yellow(): Color3;
  69325. /**
  69326. * Returns a Color3 value containing a gray color
  69327. * @returns a new Color3 object
  69328. */
  69329. static Gray(): Color3;
  69330. /**
  69331. * Returns a Color3 value containing a teal color
  69332. * @returns a new Color3 object
  69333. */
  69334. static Teal(): Color3;
  69335. /**
  69336. * Returns a Color3 value containing a random color
  69337. * @returns a new Color3 object
  69338. */
  69339. static Random(): Color3;
  69340. }
  69341. /**
  69342. * Class used to hold a RBGA color
  69343. */
  69344. export class Color4 {
  69345. /**
  69346. * Defines the red component (between 0 and 1, default is 0)
  69347. */
  69348. r: number;
  69349. /**
  69350. * Defines the green component (between 0 and 1, default is 0)
  69351. */
  69352. g: number;
  69353. /**
  69354. * Defines the blue component (between 0 and 1, default is 0)
  69355. */
  69356. b: number;
  69357. /**
  69358. * Defines the alpha component (between 0 and 1, default is 1)
  69359. */
  69360. a: number;
  69361. /**
  69362. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  69363. * @param r defines the red component (between 0 and 1, default is 0)
  69364. * @param g defines the green component (between 0 and 1, default is 0)
  69365. * @param b defines the blue component (between 0 and 1, default is 0)
  69366. * @param a defines the alpha component (between 0 and 1, default is 1)
  69367. */
  69368. constructor(
  69369. /**
  69370. * Defines the red component (between 0 and 1, default is 0)
  69371. */
  69372. r?: number,
  69373. /**
  69374. * Defines the green component (between 0 and 1, default is 0)
  69375. */
  69376. g?: number,
  69377. /**
  69378. * Defines the blue component (between 0 and 1, default is 0)
  69379. */
  69380. b?: number,
  69381. /**
  69382. * Defines the alpha component (between 0 and 1, default is 1)
  69383. */
  69384. a?: number);
  69385. /**
  69386. * Adds in place the given Color4 values to the current Color4 object
  69387. * @param right defines the second operand
  69388. * @returns the current updated Color4 object
  69389. */
  69390. addInPlace(right: DeepImmutable<Color4>): Color4;
  69391. /**
  69392. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  69393. * @returns the new array
  69394. */
  69395. asArray(): number[];
  69396. /**
  69397. * Stores from the starting index in the given array the Color4 successive values
  69398. * @param array defines the array where to store the r,g,b components
  69399. * @param index defines an optional index in the target array to define where to start storing values
  69400. * @returns the current Color4 object
  69401. */
  69402. toArray(array: number[], index?: number): Color4;
  69403. /**
  69404. * Determines equality between Color4 objects
  69405. * @param otherColor defines the second operand
  69406. * @returns true if the rgba values are equal to the given ones
  69407. */
  69408. equals(otherColor: DeepImmutable<Color4>): boolean;
  69409. /**
  69410. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  69411. * @param right defines the second operand
  69412. * @returns a new Color4 object
  69413. */
  69414. add(right: DeepImmutable<Color4>): Color4;
  69415. /**
  69416. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  69417. * @param right defines the second operand
  69418. * @returns a new Color4 object
  69419. */
  69420. subtract(right: DeepImmutable<Color4>): Color4;
  69421. /**
  69422. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  69423. * @param right defines the second operand
  69424. * @param result defines the Color4 object where to store the result
  69425. * @returns the current Color4 object
  69426. */
  69427. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  69428. /**
  69429. * Creates a new Color4 with the current Color4 values multiplied by scale
  69430. * @param scale defines the scaling factor to apply
  69431. * @returns a new Color4 object
  69432. */
  69433. scale(scale: number): Color4;
  69434. /**
  69435. * Multiplies the current Color4 values by scale and stores the result in "result"
  69436. * @param scale defines the scaling factor to apply
  69437. * @param result defines the Color4 object where to store the result
  69438. * @returns the current unmodified Color4
  69439. */
  69440. scaleToRef(scale: number, result: Color4): Color4;
  69441. /**
  69442. * Scale the current Color4 values by a factor and add the result to a given Color4
  69443. * @param scale defines the scale factor
  69444. * @param result defines the Color4 object where to store the result
  69445. * @returns the unmodified current Color4
  69446. */
  69447. scaleAndAddToRef(scale: number, result: Color4): Color4;
  69448. /**
  69449. * Clamps the rgb values by the min and max values and stores the result into "result"
  69450. * @param min defines minimum clamping value (default is 0)
  69451. * @param max defines maximum clamping value (default is 1)
  69452. * @param result defines color to store the result into.
  69453. * @returns the cuurent Color4
  69454. */
  69455. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  69456. /**
  69457. * Multipy an Color4 value by another and return a new Color4 object
  69458. * @param color defines the Color4 value to multiply by
  69459. * @returns a new Color4 object
  69460. */
  69461. multiply(color: Color4): Color4;
  69462. /**
  69463. * Multipy a Color4 value by another and push the result in a reference value
  69464. * @param color defines the Color4 value to multiply by
  69465. * @param result defines the Color4 to fill the result in
  69466. * @returns the result Color4
  69467. */
  69468. multiplyToRef(color: Color4, result: Color4): Color4;
  69469. /**
  69470. * Creates a string with the Color4 current values
  69471. * @returns the string representation of the Color4 object
  69472. */
  69473. toString(): string;
  69474. /**
  69475. * Returns the string "Color4"
  69476. * @returns "Color4"
  69477. */
  69478. getClassName(): string;
  69479. /**
  69480. * Compute the Color4 hash code
  69481. * @returns an unique number that can be used to hash Color4 objects
  69482. */
  69483. getHashCode(): number;
  69484. /**
  69485. * Creates a new Color4 copied from the current one
  69486. * @returns a new Color4 object
  69487. */
  69488. clone(): Color4;
  69489. /**
  69490. * Copies the given Color4 values into the current one
  69491. * @param source defines the source Color4 object
  69492. * @returns the current updated Color4 object
  69493. */
  69494. copyFrom(source: Color4): Color4;
  69495. /**
  69496. * Copies the given float values into the current one
  69497. * @param r defines the red component to read from
  69498. * @param g defines the green component to read from
  69499. * @param b defines the blue component to read from
  69500. * @param a defines the alpha component to read from
  69501. * @returns the current updated Color4 object
  69502. */
  69503. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  69504. /**
  69505. * Copies the given float values into the current one
  69506. * @param r defines the red component to read from
  69507. * @param g defines the green component to read from
  69508. * @param b defines the blue component to read from
  69509. * @param a defines the alpha component to read from
  69510. * @returns the current updated Color4 object
  69511. */
  69512. set(r: number, g: number, b: number, a: number): Color4;
  69513. /**
  69514. * Compute the Color4 hexadecimal code as a string
  69515. * @returns a string containing the hexadecimal representation of the Color4 object
  69516. */
  69517. toHexString(): string;
  69518. /**
  69519. * Computes a new Color4 converted from the current one to linear space
  69520. * @returns a new Color4 object
  69521. */
  69522. toLinearSpace(): Color4;
  69523. /**
  69524. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  69525. * @param convertedColor defines the Color4 object where to store the linear space version
  69526. * @returns the unmodified Color4
  69527. */
  69528. toLinearSpaceToRef(convertedColor: Color4): Color4;
  69529. /**
  69530. * Computes a new Color4 converted from the current one to gamma space
  69531. * @returns a new Color4 object
  69532. */
  69533. toGammaSpace(): Color4;
  69534. /**
  69535. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  69536. * @param convertedColor defines the Color4 object where to store the gamma space version
  69537. * @returns the unmodified Color4
  69538. */
  69539. toGammaSpaceToRef(convertedColor: Color4): Color4;
  69540. /**
  69541. * Creates a new Color4 from the string containing valid hexadecimal values
  69542. * @param hex defines a string containing valid hexadecimal values
  69543. * @returns a new Color4 object
  69544. */
  69545. static FromHexString(hex: string): Color4;
  69546. /**
  69547. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  69548. * @param left defines the start value
  69549. * @param right defines the end value
  69550. * @param amount defines the gradient factor
  69551. * @returns a new Color4 object
  69552. */
  69553. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  69554. /**
  69555. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  69556. * @param left defines the start value
  69557. * @param right defines the end value
  69558. * @param amount defines the gradient factor
  69559. * @param result defines the Color4 object where to store data
  69560. */
  69561. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  69562. /**
  69563. * Creates a new Color4 from a Color3 and an alpha value
  69564. * @param color3 defines the source Color3 to read from
  69565. * @param alpha defines the alpha component (1.0 by default)
  69566. * @returns a new Color4 object
  69567. */
  69568. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  69569. /**
  69570. * Creates a new Color4 from the starting index element of the given array
  69571. * @param array defines the source array to read from
  69572. * @param offset defines the offset in the source array
  69573. * @returns a new Color4 object
  69574. */
  69575. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  69576. /**
  69577. * Creates a new Color3 from integer values (< 256)
  69578. * @param r defines the red component to read from (value between 0 and 255)
  69579. * @param g defines the green component to read from (value between 0 and 255)
  69580. * @param b defines the blue component to read from (value between 0 and 255)
  69581. * @param a defines the alpha component to read from (value between 0 and 255)
  69582. * @returns a new Color3 object
  69583. */
  69584. static FromInts(r: number, g: number, b: number, a: number): Color4;
  69585. /**
  69586. * Check the content of a given array and convert it to an array containing RGBA data
  69587. * If the original array was already containing count * 4 values then it is returned directly
  69588. * @param colors defines the array to check
  69589. * @param count defines the number of RGBA data to expect
  69590. * @returns an array containing count * 4 values (RGBA)
  69591. */
  69592. static CheckColors4(colors: number[], count: number): number[];
  69593. }
  69594. /**
  69595. * @hidden
  69596. */
  69597. export class TmpColors {
  69598. static Color3: Color3[];
  69599. static Color4: Color4[];
  69600. }
  69601. }
  69602. declare module BABYLON {
  69603. /**
  69604. * Class representing spherical harmonics coefficients to the 3rd degree
  69605. */
  69606. export class SphericalHarmonics {
  69607. /**
  69608. * Defines whether or not the harmonics have been prescaled for rendering.
  69609. */
  69610. preScaled: boolean;
  69611. /**
  69612. * The l0,0 coefficients of the spherical harmonics
  69613. */
  69614. l00: Vector3;
  69615. /**
  69616. * The l1,-1 coefficients of the spherical harmonics
  69617. */
  69618. l1_1: Vector3;
  69619. /**
  69620. * The l1,0 coefficients of the spherical harmonics
  69621. */
  69622. l10: Vector3;
  69623. /**
  69624. * The l1,1 coefficients of the spherical harmonics
  69625. */
  69626. l11: Vector3;
  69627. /**
  69628. * The l2,-2 coefficients of the spherical harmonics
  69629. */
  69630. l2_2: Vector3;
  69631. /**
  69632. * The l2,-1 coefficients of the spherical harmonics
  69633. */
  69634. l2_1: Vector3;
  69635. /**
  69636. * The l2,0 coefficients of the spherical harmonics
  69637. */
  69638. l20: Vector3;
  69639. /**
  69640. * The l2,1 coefficients of the spherical harmonics
  69641. */
  69642. l21: Vector3;
  69643. /**
  69644. * The l2,2 coefficients of the spherical harmonics
  69645. */
  69646. l22: Vector3;
  69647. /**
  69648. * Adds a light to the spherical harmonics
  69649. * @param direction the direction of the light
  69650. * @param color the color of the light
  69651. * @param deltaSolidAngle the delta solid angle of the light
  69652. */
  69653. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  69654. /**
  69655. * Scales the spherical harmonics by the given amount
  69656. * @param scale the amount to scale
  69657. */
  69658. scaleInPlace(scale: number): void;
  69659. /**
  69660. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  69661. *
  69662. * ```
  69663. * E_lm = A_l * L_lm
  69664. * ```
  69665. *
  69666. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  69667. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  69668. * the scaling factors are given in equation 9.
  69669. */
  69670. convertIncidentRadianceToIrradiance(): void;
  69671. /**
  69672. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  69673. *
  69674. * ```
  69675. * L = (1/pi) * E * rho
  69676. * ```
  69677. *
  69678. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  69679. */
  69680. convertIrradianceToLambertianRadiance(): void;
  69681. /**
  69682. * Integrates the reconstruction coefficients directly in to the SH preventing further
  69683. * required operations at run time.
  69684. *
  69685. * This is simply done by scaling back the SH with Ylm constants parameter.
  69686. * The trigonometric part being applied by the shader at run time.
  69687. */
  69688. preScaleForRendering(): void;
  69689. /**
  69690. * Constructs a spherical harmonics from an array.
  69691. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  69692. * @returns the spherical harmonics
  69693. */
  69694. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  69695. /**
  69696. * Gets the spherical harmonics from polynomial
  69697. * @param polynomial the spherical polynomial
  69698. * @returns the spherical harmonics
  69699. */
  69700. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  69701. }
  69702. /**
  69703. * Class representing spherical polynomial coefficients to the 3rd degree
  69704. */
  69705. export class SphericalPolynomial {
  69706. private _harmonics;
  69707. /**
  69708. * The spherical harmonics used to create the polynomials.
  69709. */
  69710. readonly preScaledHarmonics: SphericalHarmonics;
  69711. /**
  69712. * The x coefficients of the spherical polynomial
  69713. */
  69714. x: Vector3;
  69715. /**
  69716. * The y coefficients of the spherical polynomial
  69717. */
  69718. y: Vector3;
  69719. /**
  69720. * The z coefficients of the spherical polynomial
  69721. */
  69722. z: Vector3;
  69723. /**
  69724. * The xx coefficients of the spherical polynomial
  69725. */
  69726. xx: Vector3;
  69727. /**
  69728. * The yy coefficients of the spherical polynomial
  69729. */
  69730. yy: Vector3;
  69731. /**
  69732. * The zz coefficients of the spherical polynomial
  69733. */
  69734. zz: Vector3;
  69735. /**
  69736. * The xy coefficients of the spherical polynomial
  69737. */
  69738. xy: Vector3;
  69739. /**
  69740. * The yz coefficients of the spherical polynomial
  69741. */
  69742. yz: Vector3;
  69743. /**
  69744. * The zx coefficients of the spherical polynomial
  69745. */
  69746. zx: Vector3;
  69747. /**
  69748. * Adds an ambient color to the spherical polynomial
  69749. * @param color the color to add
  69750. */
  69751. addAmbient(color: Color3): void;
  69752. /**
  69753. * Scales the spherical polynomial by the given amount
  69754. * @param scale the amount to scale
  69755. */
  69756. scaleInPlace(scale: number): void;
  69757. /**
  69758. * Gets the spherical polynomial from harmonics
  69759. * @param harmonics the spherical harmonics
  69760. * @returns the spherical polynomial
  69761. */
  69762. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  69763. /**
  69764. * Constructs a spherical polynomial from an array.
  69765. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  69766. * @returns the spherical polynomial
  69767. */
  69768. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  69769. }
  69770. }
  69771. declare module BABYLON {
  69772. /**
  69773. * Define options used to create a render target texture
  69774. */
  69775. export class RenderTargetCreationOptions {
  69776. /**
  69777. * Specifies is mipmaps must be generated
  69778. */
  69779. generateMipMaps?: boolean;
  69780. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  69781. generateDepthBuffer?: boolean;
  69782. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  69783. generateStencilBuffer?: boolean;
  69784. /** Defines texture type (int by default) */
  69785. type?: number;
  69786. /** Defines sampling mode (trilinear by default) */
  69787. samplingMode?: number;
  69788. /** Defines format (RGBA by default) */
  69789. format?: number;
  69790. }
  69791. }
  69792. declare module BABYLON {
  69793. /**
  69794. * @hidden
  69795. **/
  69796. export class _AlphaState {
  69797. private _isAlphaBlendDirty;
  69798. private _isBlendFunctionParametersDirty;
  69799. private _isBlendEquationParametersDirty;
  69800. private _isBlendConstantsDirty;
  69801. private _alphaBlend;
  69802. private _blendFunctionParameters;
  69803. private _blendEquationParameters;
  69804. private _blendConstants;
  69805. /**
  69806. * Initializes the state.
  69807. */
  69808. constructor();
  69809. readonly isDirty: boolean;
  69810. alphaBlend: boolean;
  69811. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  69812. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  69813. setAlphaEquationParameters(rgb: number, alpha: number): void;
  69814. reset(): void;
  69815. apply(gl: WebGLRenderingContext): void;
  69816. }
  69817. }
  69818. declare module BABYLON {
  69819. /**
  69820. * @hidden
  69821. **/
  69822. export class _DepthCullingState {
  69823. private _isDepthTestDirty;
  69824. private _isDepthMaskDirty;
  69825. private _isDepthFuncDirty;
  69826. private _isCullFaceDirty;
  69827. private _isCullDirty;
  69828. private _isZOffsetDirty;
  69829. private _isFrontFaceDirty;
  69830. private _depthTest;
  69831. private _depthMask;
  69832. private _depthFunc;
  69833. private _cull;
  69834. private _cullFace;
  69835. private _zOffset;
  69836. private _frontFace;
  69837. /**
  69838. * Initializes the state.
  69839. */
  69840. constructor();
  69841. readonly isDirty: boolean;
  69842. zOffset: number;
  69843. cullFace: Nullable<number>;
  69844. cull: Nullable<boolean>;
  69845. depthFunc: Nullable<number>;
  69846. depthMask: boolean;
  69847. depthTest: boolean;
  69848. frontFace: Nullable<number>;
  69849. reset(): void;
  69850. apply(gl: WebGLRenderingContext): void;
  69851. }
  69852. }
  69853. declare module BABYLON {
  69854. /**
  69855. * @hidden
  69856. **/
  69857. export class _StencilState {
  69858. /** 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 */
  69859. static readonly ALWAYS: number;
  69860. /** Passed to stencilOperation to specify that stencil value must be kept */
  69861. static readonly KEEP: number;
  69862. /** Passed to stencilOperation to specify that stencil value must be replaced */
  69863. static readonly REPLACE: number;
  69864. private _isStencilTestDirty;
  69865. private _isStencilMaskDirty;
  69866. private _isStencilFuncDirty;
  69867. private _isStencilOpDirty;
  69868. private _stencilTest;
  69869. private _stencilMask;
  69870. private _stencilFunc;
  69871. private _stencilFuncRef;
  69872. private _stencilFuncMask;
  69873. private _stencilOpStencilFail;
  69874. private _stencilOpDepthFail;
  69875. private _stencilOpStencilDepthPass;
  69876. readonly isDirty: boolean;
  69877. stencilFunc: number;
  69878. stencilFuncRef: number;
  69879. stencilFuncMask: number;
  69880. stencilOpStencilFail: number;
  69881. stencilOpDepthFail: number;
  69882. stencilOpStencilDepthPass: number;
  69883. stencilMask: number;
  69884. stencilTest: boolean;
  69885. constructor();
  69886. reset(): void;
  69887. apply(gl: WebGLRenderingContext): void;
  69888. }
  69889. }
  69890. declare module BABYLON {
  69891. /**
  69892. * @hidden
  69893. **/
  69894. export class _TimeToken {
  69895. _startTimeQuery: Nullable<WebGLQuery>;
  69896. _endTimeQuery: Nullable<WebGLQuery>;
  69897. _timeElapsedQuery: Nullable<WebGLQuery>;
  69898. _timeElapsedQueryEnded: boolean;
  69899. }
  69900. }
  69901. declare module BABYLON {
  69902. /**
  69903. * Class used to evalaute queries containing `and` and `or` operators
  69904. */
  69905. export class AndOrNotEvaluator {
  69906. /**
  69907. * Evaluate a query
  69908. * @param query defines the query to evaluate
  69909. * @param evaluateCallback defines the callback used to filter result
  69910. * @returns true if the query matches
  69911. */
  69912. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  69913. private static _HandleParenthesisContent;
  69914. private static _SimplifyNegation;
  69915. }
  69916. }
  69917. declare module BABYLON {
  69918. /**
  69919. * Class used to store custom tags
  69920. */
  69921. export class Tags {
  69922. /**
  69923. * Adds support for tags on the given object
  69924. * @param obj defines the object to use
  69925. */
  69926. static EnableFor(obj: any): void;
  69927. /**
  69928. * Removes tags support
  69929. * @param obj defines the object to use
  69930. */
  69931. static DisableFor(obj: any): void;
  69932. /**
  69933. * Gets a boolean indicating if the given object has tags
  69934. * @param obj defines the object to use
  69935. * @returns a boolean
  69936. */
  69937. static HasTags(obj: any): boolean;
  69938. /**
  69939. * Gets the tags available on a given object
  69940. * @param obj defines the object to use
  69941. * @param asString defines if the tags must be returned as a string instead of an array of strings
  69942. * @returns the tags
  69943. */
  69944. static GetTags(obj: any, asString?: boolean): any;
  69945. /**
  69946. * Adds tags to an object
  69947. * @param obj defines the object to use
  69948. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  69949. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  69950. */
  69951. static AddTagsTo(obj: any, tagsString: string): void;
  69952. /**
  69953. * @hidden
  69954. */
  69955. static _AddTagTo(obj: any, tag: string): void;
  69956. /**
  69957. * Removes specific tags from a specific object
  69958. * @param obj defines the object to use
  69959. * @param tagsString defines the tags to remove
  69960. */
  69961. static RemoveTagsFrom(obj: any, tagsString: string): void;
  69962. /**
  69963. * @hidden
  69964. */
  69965. static _RemoveTagFrom(obj: any, tag: string): void;
  69966. /**
  69967. * Defines if tags hosted on an object match a given query
  69968. * @param obj defines the object to use
  69969. * @param tagsQuery defines the tag query
  69970. * @returns a boolean
  69971. */
  69972. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  69973. }
  69974. }
  69975. declare module BABYLON {
  69976. /**
  69977. * Defines potential orientation for back face culling
  69978. */
  69979. export enum Orientation {
  69980. /**
  69981. * Clockwise
  69982. */
  69983. CW = 0,
  69984. /** Counter clockwise */
  69985. CCW = 1
  69986. }
  69987. /** Class used to represent a Bezier curve */
  69988. export class BezierCurve {
  69989. /**
  69990. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  69991. * @param t defines the time
  69992. * @param x1 defines the left coordinate on X axis
  69993. * @param y1 defines the left coordinate on Y axis
  69994. * @param x2 defines the right coordinate on X axis
  69995. * @param y2 defines the right coordinate on Y axis
  69996. * @returns the interpolated value
  69997. */
  69998. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  69999. }
  70000. /**
  70001. * Defines angle representation
  70002. */
  70003. export class Angle {
  70004. private _radians;
  70005. /**
  70006. * Creates an Angle object of "radians" radians (float).
  70007. * @param radians the angle in radians
  70008. */
  70009. constructor(radians: number);
  70010. /**
  70011. * Get value in degrees
  70012. * @returns the Angle value in degrees (float)
  70013. */
  70014. degrees(): number;
  70015. /**
  70016. * Get value in radians
  70017. * @returns the Angle value in radians (float)
  70018. */
  70019. radians(): number;
  70020. /**
  70021. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  70022. * @param a defines first vector
  70023. * @param b defines second vector
  70024. * @returns a new Angle
  70025. */
  70026. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  70027. /**
  70028. * Gets a new Angle object from the given float in radians
  70029. * @param radians defines the angle value in radians
  70030. * @returns a new Angle
  70031. */
  70032. static FromRadians(radians: number): Angle;
  70033. /**
  70034. * Gets a new Angle object from the given float in degrees
  70035. * @param degrees defines the angle value in degrees
  70036. * @returns a new Angle
  70037. */
  70038. static FromDegrees(degrees: number): Angle;
  70039. }
  70040. /**
  70041. * This represents an arc in a 2d space.
  70042. */
  70043. export class Arc2 {
  70044. /** Defines the start point of the arc */
  70045. startPoint: Vector2;
  70046. /** Defines the mid point of the arc */
  70047. midPoint: Vector2;
  70048. /** Defines the end point of the arc */
  70049. endPoint: Vector2;
  70050. /**
  70051. * Defines the center point of the arc.
  70052. */
  70053. centerPoint: Vector2;
  70054. /**
  70055. * Defines the radius of the arc.
  70056. */
  70057. radius: number;
  70058. /**
  70059. * Defines the angle of the arc (from mid point to end point).
  70060. */
  70061. angle: Angle;
  70062. /**
  70063. * Defines the start angle of the arc (from start point to middle point).
  70064. */
  70065. startAngle: Angle;
  70066. /**
  70067. * Defines the orientation of the arc (clock wise/counter clock wise).
  70068. */
  70069. orientation: Orientation;
  70070. /**
  70071. * Creates an Arc object from the three given points : start, middle and end.
  70072. * @param startPoint Defines the start point of the arc
  70073. * @param midPoint Defines the midlle point of the arc
  70074. * @param endPoint Defines the end point of the arc
  70075. */
  70076. constructor(
  70077. /** Defines the start point of the arc */
  70078. startPoint: Vector2,
  70079. /** Defines the mid point of the arc */
  70080. midPoint: Vector2,
  70081. /** Defines the end point of the arc */
  70082. endPoint: Vector2);
  70083. }
  70084. /**
  70085. * Represents a 2D path made up of multiple 2D points
  70086. */
  70087. export class Path2 {
  70088. private _points;
  70089. private _length;
  70090. /**
  70091. * If the path start and end point are the same
  70092. */
  70093. closed: boolean;
  70094. /**
  70095. * Creates a Path2 object from the starting 2D coordinates x and y.
  70096. * @param x the starting points x value
  70097. * @param y the starting points y value
  70098. */
  70099. constructor(x: number, y: number);
  70100. /**
  70101. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  70102. * @param x the added points x value
  70103. * @param y the added points y value
  70104. * @returns the updated Path2.
  70105. */
  70106. addLineTo(x: number, y: number): Path2;
  70107. /**
  70108. * 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.
  70109. * @param midX middle point x value
  70110. * @param midY middle point y value
  70111. * @param endX end point x value
  70112. * @param endY end point y value
  70113. * @param numberOfSegments (default: 36)
  70114. * @returns the updated Path2.
  70115. */
  70116. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  70117. /**
  70118. * Closes the Path2.
  70119. * @returns the Path2.
  70120. */
  70121. close(): Path2;
  70122. /**
  70123. * Gets the sum of the distance between each sequential point in the path
  70124. * @returns the Path2 total length (float).
  70125. */
  70126. length(): number;
  70127. /**
  70128. * Gets the points which construct the path
  70129. * @returns the Path2 internal array of points.
  70130. */
  70131. getPoints(): Vector2[];
  70132. /**
  70133. * Retreives the point at the distance aways from the starting point
  70134. * @param normalizedLengthPosition the length along the path to retreive the point from
  70135. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  70136. */
  70137. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  70138. /**
  70139. * Creates a new path starting from an x and y position
  70140. * @param x starting x value
  70141. * @param y starting y value
  70142. * @returns a new Path2 starting at the coordinates (x, y).
  70143. */
  70144. static StartingAt(x: number, y: number): Path2;
  70145. }
  70146. /**
  70147. * Represents a 3D path made up of multiple 3D points
  70148. */
  70149. export class Path3D {
  70150. /**
  70151. * an array of Vector3, the curve axis of the Path3D
  70152. */
  70153. path: Vector3[];
  70154. private _curve;
  70155. private _distances;
  70156. private _tangents;
  70157. private _normals;
  70158. private _binormals;
  70159. private _raw;
  70160. /**
  70161. * new Path3D(path, normal, raw)
  70162. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  70163. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  70164. * @param path an array of Vector3, the curve axis of the Path3D
  70165. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  70166. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  70167. */
  70168. constructor(
  70169. /**
  70170. * an array of Vector3, the curve axis of the Path3D
  70171. */
  70172. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  70173. /**
  70174. * Returns the Path3D array of successive Vector3 designing its curve.
  70175. * @returns the Path3D array of successive Vector3 designing its curve.
  70176. */
  70177. getCurve(): Vector3[];
  70178. /**
  70179. * Returns an array populated with tangent vectors on each Path3D curve point.
  70180. * @returns an array populated with tangent vectors on each Path3D curve point.
  70181. */
  70182. getTangents(): Vector3[];
  70183. /**
  70184. * Returns an array populated with normal vectors on each Path3D curve point.
  70185. * @returns an array populated with normal vectors on each Path3D curve point.
  70186. */
  70187. getNormals(): Vector3[];
  70188. /**
  70189. * Returns an array populated with binormal vectors on each Path3D curve point.
  70190. * @returns an array populated with binormal vectors on each Path3D curve point.
  70191. */
  70192. getBinormals(): Vector3[];
  70193. /**
  70194. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  70195. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  70196. */
  70197. getDistances(): number[];
  70198. /**
  70199. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  70200. * @param path path which all values are copied into the curves points
  70201. * @param firstNormal which should be projected onto the curve
  70202. * @returns the same object updated.
  70203. */
  70204. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  70205. private _compute;
  70206. private _getFirstNonNullVector;
  70207. private _getLastNonNullVector;
  70208. private _normalVector;
  70209. }
  70210. /**
  70211. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  70212. * A Curve3 is designed from a series of successive Vector3.
  70213. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  70214. */
  70215. export class Curve3 {
  70216. private _points;
  70217. private _length;
  70218. /**
  70219. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  70220. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  70221. * @param v1 (Vector3) the control point
  70222. * @param v2 (Vector3) the end point of the Quadratic Bezier
  70223. * @param nbPoints (integer) the wanted number of points in the curve
  70224. * @returns the created Curve3
  70225. */
  70226. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  70227. /**
  70228. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  70229. * @param v0 (Vector3) the origin point of the Cubic Bezier
  70230. * @param v1 (Vector3) the first control point
  70231. * @param v2 (Vector3) the second control point
  70232. * @param v3 (Vector3) the end point of the Cubic Bezier
  70233. * @param nbPoints (integer) the wanted number of points in the curve
  70234. * @returns the created Curve3
  70235. */
  70236. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  70237. /**
  70238. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  70239. * @param p1 (Vector3) the origin point of the Hermite Spline
  70240. * @param t1 (Vector3) the tangent vector at the origin point
  70241. * @param p2 (Vector3) the end point of the Hermite Spline
  70242. * @param t2 (Vector3) the tangent vector at the end point
  70243. * @param nbPoints (integer) the wanted number of points in the curve
  70244. * @returns the created Curve3
  70245. */
  70246. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  70247. /**
  70248. * Returns a Curve3 object along a CatmullRom Spline curve :
  70249. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  70250. * @param nbPoints (integer) the wanted number of points between each curve control points
  70251. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  70252. * @returns the created Curve3
  70253. */
  70254. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  70255. /**
  70256. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  70257. * A Curve3 is designed from a series of successive Vector3.
  70258. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  70259. * @param points points which make up the curve
  70260. */
  70261. constructor(points: Vector3[]);
  70262. /**
  70263. * @returns the Curve3 stored array of successive Vector3
  70264. */
  70265. getPoints(): Vector3[];
  70266. /**
  70267. * @returns the computed length (float) of the curve.
  70268. */
  70269. length(): number;
  70270. /**
  70271. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  70272. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  70273. * curveA and curveB keep unchanged.
  70274. * @param curve the curve to continue from this curve
  70275. * @returns the newly constructed curve
  70276. */
  70277. continue(curve: DeepImmutable<Curve3>): Curve3;
  70278. private _computeLength;
  70279. }
  70280. }
  70281. declare module BABYLON {
  70282. /**
  70283. * This represents the main contract an easing function should follow.
  70284. * Easing functions are used throughout the animation system.
  70285. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70286. */
  70287. export interface IEasingFunction {
  70288. /**
  70289. * Given an input gradient between 0 and 1, this returns the corrseponding value
  70290. * of the easing function.
  70291. * The link below provides some of the most common examples of easing functions.
  70292. * @see https://easings.net/
  70293. * @param gradient Defines the value between 0 and 1 we want the easing value for
  70294. * @returns the corresponding value on the curve defined by the easing function
  70295. */
  70296. ease(gradient: number): number;
  70297. }
  70298. /**
  70299. * Base class used for every default easing function.
  70300. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70301. */
  70302. export class EasingFunction implements IEasingFunction {
  70303. /**
  70304. * Interpolation follows the mathematical formula associated with the easing function.
  70305. */
  70306. static readonly EASINGMODE_EASEIN: number;
  70307. /**
  70308. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  70309. */
  70310. static readonly EASINGMODE_EASEOUT: number;
  70311. /**
  70312. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  70313. */
  70314. static readonly EASINGMODE_EASEINOUT: number;
  70315. private _easingMode;
  70316. /**
  70317. * Sets the easing mode of the current function.
  70318. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  70319. */
  70320. setEasingMode(easingMode: number): void;
  70321. /**
  70322. * Gets the current easing mode.
  70323. * @returns the easing mode
  70324. */
  70325. getEasingMode(): number;
  70326. /**
  70327. * @hidden
  70328. */
  70329. easeInCore(gradient: number): number;
  70330. /**
  70331. * Given an input gradient between 0 and 1, this returns the corresponding value
  70332. * of the easing function.
  70333. * @param gradient Defines the value between 0 and 1 we want the easing value for
  70334. * @returns the corresponding value on the curve defined by the easing function
  70335. */
  70336. ease(gradient: number): number;
  70337. }
  70338. /**
  70339. * Easing function with a circle shape (see link below).
  70340. * @see https://easings.net/#easeInCirc
  70341. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70342. */
  70343. export class CircleEase extends EasingFunction implements IEasingFunction {
  70344. /** @hidden */
  70345. easeInCore(gradient: number): number;
  70346. }
  70347. /**
  70348. * Easing function with a ease back shape (see link below).
  70349. * @see https://easings.net/#easeInBack
  70350. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70351. */
  70352. export class BackEase extends EasingFunction implements IEasingFunction {
  70353. /** Defines the amplitude of the function */
  70354. amplitude: number;
  70355. /**
  70356. * Instantiates a back ease easing
  70357. * @see https://easings.net/#easeInBack
  70358. * @param amplitude Defines the amplitude of the function
  70359. */
  70360. constructor(
  70361. /** Defines the amplitude of the function */
  70362. amplitude?: number);
  70363. /** @hidden */
  70364. easeInCore(gradient: number): number;
  70365. }
  70366. /**
  70367. * Easing function with a bouncing shape (see link below).
  70368. * @see https://easings.net/#easeInBounce
  70369. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70370. */
  70371. export class BounceEase extends EasingFunction implements IEasingFunction {
  70372. /** Defines the number of bounces */
  70373. bounces: number;
  70374. /** Defines the amplitude of the bounce */
  70375. bounciness: number;
  70376. /**
  70377. * Instantiates a bounce easing
  70378. * @see https://easings.net/#easeInBounce
  70379. * @param bounces Defines the number of bounces
  70380. * @param bounciness Defines the amplitude of the bounce
  70381. */
  70382. constructor(
  70383. /** Defines the number of bounces */
  70384. bounces?: number,
  70385. /** Defines the amplitude of the bounce */
  70386. bounciness?: number);
  70387. /** @hidden */
  70388. easeInCore(gradient: number): number;
  70389. }
  70390. /**
  70391. * Easing function with a power of 3 shape (see link below).
  70392. * @see https://easings.net/#easeInCubic
  70393. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70394. */
  70395. export class CubicEase extends EasingFunction implements IEasingFunction {
  70396. /** @hidden */
  70397. easeInCore(gradient: number): number;
  70398. }
  70399. /**
  70400. * Easing function with an elastic shape (see link below).
  70401. * @see https://easings.net/#easeInElastic
  70402. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70403. */
  70404. export class ElasticEase extends EasingFunction implements IEasingFunction {
  70405. /** Defines the number of oscillations*/
  70406. oscillations: number;
  70407. /** Defines the amplitude of the oscillations*/
  70408. springiness: number;
  70409. /**
  70410. * Instantiates an elastic easing function
  70411. * @see https://easings.net/#easeInElastic
  70412. * @param oscillations Defines the number of oscillations
  70413. * @param springiness Defines the amplitude of the oscillations
  70414. */
  70415. constructor(
  70416. /** Defines the number of oscillations*/
  70417. oscillations?: number,
  70418. /** Defines the amplitude of the oscillations*/
  70419. springiness?: number);
  70420. /** @hidden */
  70421. easeInCore(gradient: number): number;
  70422. }
  70423. /**
  70424. * Easing function with an exponential shape (see link below).
  70425. * @see https://easings.net/#easeInExpo
  70426. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70427. */
  70428. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  70429. /** Defines the exponent of the function */
  70430. exponent: number;
  70431. /**
  70432. * Instantiates an exponential easing function
  70433. * @see https://easings.net/#easeInExpo
  70434. * @param exponent Defines the exponent of the function
  70435. */
  70436. constructor(
  70437. /** Defines the exponent of the function */
  70438. exponent?: number);
  70439. /** @hidden */
  70440. easeInCore(gradient: number): number;
  70441. }
  70442. /**
  70443. * Easing function with a power shape (see link below).
  70444. * @see https://easings.net/#easeInQuad
  70445. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70446. */
  70447. export class PowerEase extends EasingFunction implements IEasingFunction {
  70448. /** Defines the power of the function */
  70449. power: number;
  70450. /**
  70451. * Instantiates an power base easing function
  70452. * @see https://easings.net/#easeInQuad
  70453. * @param power Defines the power of the function
  70454. */
  70455. constructor(
  70456. /** Defines the power of the function */
  70457. power?: number);
  70458. /** @hidden */
  70459. easeInCore(gradient: number): number;
  70460. }
  70461. /**
  70462. * Easing function with a power of 2 shape (see link below).
  70463. * @see https://easings.net/#easeInQuad
  70464. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70465. */
  70466. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  70467. /** @hidden */
  70468. easeInCore(gradient: number): number;
  70469. }
  70470. /**
  70471. * Easing function with a power of 4 shape (see link below).
  70472. * @see https://easings.net/#easeInQuart
  70473. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70474. */
  70475. export class QuarticEase extends EasingFunction implements IEasingFunction {
  70476. /** @hidden */
  70477. easeInCore(gradient: number): number;
  70478. }
  70479. /**
  70480. * Easing function with a power of 5 shape (see link below).
  70481. * @see https://easings.net/#easeInQuint
  70482. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70483. */
  70484. export class QuinticEase extends EasingFunction implements IEasingFunction {
  70485. /** @hidden */
  70486. easeInCore(gradient: number): number;
  70487. }
  70488. /**
  70489. * Easing function with a sin shape (see link below).
  70490. * @see https://easings.net/#easeInSine
  70491. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70492. */
  70493. export class SineEase extends EasingFunction implements IEasingFunction {
  70494. /** @hidden */
  70495. easeInCore(gradient: number): number;
  70496. }
  70497. /**
  70498. * Easing function with a bezier shape (see link below).
  70499. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  70500. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  70501. */
  70502. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  70503. /** Defines the x component of the start tangent in the bezier curve */
  70504. x1: number;
  70505. /** Defines the y component of the start tangent in the bezier curve */
  70506. y1: number;
  70507. /** Defines the x component of the end tangent in the bezier curve */
  70508. x2: number;
  70509. /** Defines the y component of the end tangent in the bezier curve */
  70510. y2: number;
  70511. /**
  70512. * Instantiates a bezier function
  70513. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  70514. * @param x1 Defines the x component of the start tangent in the bezier curve
  70515. * @param y1 Defines the y component of the start tangent in the bezier curve
  70516. * @param x2 Defines the x component of the end tangent in the bezier curve
  70517. * @param y2 Defines the y component of the end tangent in the bezier curve
  70518. */
  70519. constructor(
  70520. /** Defines the x component of the start tangent in the bezier curve */
  70521. x1?: number,
  70522. /** Defines the y component of the start tangent in the bezier curve */
  70523. y1?: number,
  70524. /** Defines the x component of the end tangent in the bezier curve */
  70525. x2?: number,
  70526. /** Defines the y component of the end tangent in the bezier curve */
  70527. y2?: number);
  70528. /** @hidden */
  70529. easeInCore(gradient: number): number;
  70530. }
  70531. }
  70532. declare module BABYLON {
  70533. /**
  70534. * Defines an interface which represents an animation key frame
  70535. */
  70536. export interface IAnimationKey {
  70537. /**
  70538. * Frame of the key frame
  70539. */
  70540. frame: number;
  70541. /**
  70542. * Value at the specifies key frame
  70543. */
  70544. value: any;
  70545. /**
  70546. * The input tangent for the cubic hermite spline
  70547. */
  70548. inTangent?: any;
  70549. /**
  70550. * The output tangent for the cubic hermite spline
  70551. */
  70552. outTangent?: any;
  70553. /**
  70554. * The animation interpolation type
  70555. */
  70556. interpolation?: AnimationKeyInterpolation;
  70557. }
  70558. /**
  70559. * Enum for the animation key frame interpolation type
  70560. */
  70561. export enum AnimationKeyInterpolation {
  70562. /**
  70563. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  70564. */
  70565. STEP = 1
  70566. }
  70567. }
  70568. declare module BABYLON {
  70569. /**
  70570. * Represents the range of an animation
  70571. */
  70572. export class AnimationRange {
  70573. /**The name of the animation range**/
  70574. name: string;
  70575. /**The starting frame of the animation */
  70576. from: number;
  70577. /**The ending frame of the animation*/
  70578. to: number;
  70579. /**
  70580. * Initializes the range of an animation
  70581. * @param name The name of the animation range
  70582. * @param from The starting frame of the animation
  70583. * @param to The ending frame of the animation
  70584. */
  70585. constructor(
  70586. /**The name of the animation range**/
  70587. name: string,
  70588. /**The starting frame of the animation */
  70589. from: number,
  70590. /**The ending frame of the animation*/
  70591. to: number);
  70592. /**
  70593. * Makes a copy of the animation range
  70594. * @returns A copy of the animation range
  70595. */
  70596. clone(): AnimationRange;
  70597. }
  70598. }
  70599. declare module BABYLON {
  70600. /**
  70601. * Composed of a frame, and an action function
  70602. */
  70603. export class AnimationEvent {
  70604. /** The frame for which the event is triggered **/
  70605. frame: number;
  70606. /** The event to perform when triggered **/
  70607. action: (currentFrame: number) => void;
  70608. /** Specifies if the event should be triggered only once**/
  70609. onlyOnce?: boolean | undefined;
  70610. /**
  70611. * Specifies if the animation event is done
  70612. */
  70613. isDone: boolean;
  70614. /**
  70615. * Initializes the animation event
  70616. * @param frame The frame for which the event is triggered
  70617. * @param action The event to perform when triggered
  70618. * @param onlyOnce Specifies if the event should be triggered only once
  70619. */
  70620. constructor(
  70621. /** The frame for which the event is triggered **/
  70622. frame: number,
  70623. /** The event to perform when triggered **/
  70624. action: (currentFrame: number) => void,
  70625. /** Specifies if the event should be triggered only once**/
  70626. onlyOnce?: boolean | undefined);
  70627. /** @hidden */
  70628. _clone(): AnimationEvent;
  70629. }
  70630. }
  70631. declare module BABYLON {
  70632. /**
  70633. * Interface used to define a behavior
  70634. */
  70635. export interface Behavior<T> {
  70636. /** gets or sets behavior's name */
  70637. name: string;
  70638. /**
  70639. * Function called when the behavior needs to be initialized (after attaching it to a target)
  70640. */
  70641. init(): void;
  70642. /**
  70643. * Called when the behavior is attached to a target
  70644. * @param target defines the target where the behavior is attached to
  70645. */
  70646. attach(target: T): void;
  70647. /**
  70648. * Called when the behavior is detached from its target
  70649. */
  70650. detach(): void;
  70651. }
  70652. /**
  70653. * Interface implemented by classes supporting behaviors
  70654. */
  70655. export interface IBehaviorAware<T> {
  70656. /**
  70657. * Attach a behavior
  70658. * @param behavior defines the behavior to attach
  70659. * @returns the current host
  70660. */
  70661. addBehavior(behavior: Behavior<T>): T;
  70662. /**
  70663. * Remove a behavior from the current object
  70664. * @param behavior defines the behavior to detach
  70665. * @returns the current host
  70666. */
  70667. removeBehavior(behavior: Behavior<T>): T;
  70668. /**
  70669. * Gets a behavior using its name to search
  70670. * @param name defines the name to search
  70671. * @returns the behavior or null if not found
  70672. */
  70673. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  70674. }
  70675. }
  70676. declare module BABYLON {
  70677. /**
  70678. * Defines an array and its length.
  70679. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  70680. */
  70681. export interface ISmartArrayLike<T> {
  70682. /**
  70683. * The data of the array.
  70684. */
  70685. data: Array<T>;
  70686. /**
  70687. * The active length of the array.
  70688. */
  70689. length: number;
  70690. }
  70691. /**
  70692. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  70693. */
  70694. export class SmartArray<T> implements ISmartArrayLike<T> {
  70695. /**
  70696. * The full set of data from the array.
  70697. */
  70698. data: Array<T>;
  70699. /**
  70700. * The active length of the array.
  70701. */
  70702. length: number;
  70703. protected _id: number;
  70704. /**
  70705. * Instantiates a Smart Array.
  70706. * @param capacity defines the default capacity of the array.
  70707. */
  70708. constructor(capacity: number);
  70709. /**
  70710. * Pushes a value at the end of the active data.
  70711. * @param value defines the object to push in the array.
  70712. */
  70713. push(value: T): void;
  70714. /**
  70715. * Iterates over the active data and apply the lambda to them.
  70716. * @param func defines the action to apply on each value.
  70717. */
  70718. forEach(func: (content: T) => void): void;
  70719. /**
  70720. * Sorts the full sets of data.
  70721. * @param compareFn defines the comparison function to apply.
  70722. */
  70723. sort(compareFn: (a: T, b: T) => number): void;
  70724. /**
  70725. * Resets the active data to an empty array.
  70726. */
  70727. reset(): void;
  70728. /**
  70729. * Releases all the data from the array as well as the array.
  70730. */
  70731. dispose(): void;
  70732. /**
  70733. * Concats the active data with a given array.
  70734. * @param array defines the data to concatenate with.
  70735. */
  70736. concat(array: any): void;
  70737. /**
  70738. * Returns the position of a value in the active data.
  70739. * @param value defines the value to find the index for
  70740. * @returns the index if found in the active data otherwise -1
  70741. */
  70742. indexOf(value: T): number;
  70743. /**
  70744. * Returns whether an element is part of the active data.
  70745. * @param value defines the value to look for
  70746. * @returns true if found in the active data otherwise false
  70747. */
  70748. contains(value: T): boolean;
  70749. private static _GlobalId;
  70750. }
  70751. /**
  70752. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  70753. * The data in this array can only be present once
  70754. */
  70755. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  70756. private _duplicateId;
  70757. /**
  70758. * Pushes a value at the end of the active data.
  70759. * THIS DOES NOT PREVENT DUPPLICATE DATA
  70760. * @param value defines the object to push in the array.
  70761. */
  70762. push(value: T): void;
  70763. /**
  70764. * Pushes a value at the end of the active data.
  70765. * If the data is already present, it won t be added again
  70766. * @param value defines the object to push in the array.
  70767. * @returns true if added false if it was already present
  70768. */
  70769. pushNoDuplicate(value: T): boolean;
  70770. /**
  70771. * Resets the active data to an empty array.
  70772. */
  70773. reset(): void;
  70774. /**
  70775. * Concats the active data with a given array.
  70776. * This ensures no dupplicate will be present in the result.
  70777. * @param array defines the data to concatenate with.
  70778. */
  70779. concatWithNoDuplicate(array: any): void;
  70780. }
  70781. }
  70782. declare module BABYLON {
  70783. /**
  70784. * @ignore
  70785. * This is a list of all the different input types that are available in the application.
  70786. * Fo instance: ArcRotateCameraGamepadInput...
  70787. */
  70788. export var CameraInputTypes: {};
  70789. /**
  70790. * This is the contract to implement in order to create a new input class.
  70791. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  70792. */
  70793. export interface ICameraInput<TCamera extends Camera> {
  70794. /**
  70795. * Defines the camera the input is attached to.
  70796. */
  70797. camera: Nullable<TCamera>;
  70798. /**
  70799. * Gets the class name of the current intput.
  70800. * @returns the class name
  70801. */
  70802. getClassName(): string;
  70803. /**
  70804. * Get the friendly name associated with the input class.
  70805. * @returns the input friendly name
  70806. */
  70807. getSimpleName(): string;
  70808. /**
  70809. * Attach the input controls to a specific dom element to get the input from.
  70810. * @param element Defines the element the controls should be listened from
  70811. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  70812. */
  70813. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  70814. /**
  70815. * Detach the current controls from the specified dom element.
  70816. * @param element Defines the element to stop listening the inputs from
  70817. */
  70818. detachControl(element: Nullable<HTMLElement>): void;
  70819. /**
  70820. * Update the current camera state depending on the inputs that have been used this frame.
  70821. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  70822. */
  70823. checkInputs?: () => void;
  70824. }
  70825. /**
  70826. * Represents a map of input types to input instance or input index to input instance.
  70827. */
  70828. export interface CameraInputsMap<TCamera extends Camera> {
  70829. /**
  70830. * Accessor to the input by input type.
  70831. */
  70832. [name: string]: ICameraInput<TCamera>;
  70833. /**
  70834. * Accessor to the input by input index.
  70835. */
  70836. [idx: number]: ICameraInput<TCamera>;
  70837. }
  70838. /**
  70839. * This represents the input manager used within a camera.
  70840. * It helps dealing with all the different kind of input attached to a camera.
  70841. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  70842. */
  70843. export class CameraInputsManager<TCamera extends Camera> {
  70844. /**
  70845. * Defines the list of inputs attahed to the camera.
  70846. */
  70847. attached: CameraInputsMap<TCamera>;
  70848. /**
  70849. * Defines the dom element the camera is collecting inputs from.
  70850. * This is null if the controls have not been attached.
  70851. */
  70852. attachedElement: Nullable<HTMLElement>;
  70853. /**
  70854. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  70855. */
  70856. noPreventDefault: boolean;
  70857. /**
  70858. * Defined the camera the input manager belongs to.
  70859. */
  70860. camera: TCamera;
  70861. /**
  70862. * Update the current camera state depending on the inputs that have been used this frame.
  70863. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  70864. */
  70865. checkInputs: () => void;
  70866. /**
  70867. * Instantiate a new Camera Input Manager.
  70868. * @param camera Defines the camera the input manager blongs to
  70869. */
  70870. constructor(camera: TCamera);
  70871. /**
  70872. * Add an input method to a camera
  70873. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  70874. * @param input camera input method
  70875. */
  70876. add(input: ICameraInput<TCamera>): void;
  70877. /**
  70878. * Remove a specific input method from a camera
  70879. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  70880. * @param inputToRemove camera input method
  70881. */
  70882. remove(inputToRemove: ICameraInput<TCamera>): void;
  70883. /**
  70884. * Remove a specific input type from a camera
  70885. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  70886. * @param inputType the type of the input to remove
  70887. */
  70888. removeByType(inputType: string): void;
  70889. private _addCheckInputs;
  70890. /**
  70891. * Attach the input controls to the currently attached dom element to listen the events from.
  70892. * @param input Defines the input to attach
  70893. */
  70894. attachInput(input: ICameraInput<TCamera>): void;
  70895. /**
  70896. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  70897. * @param element Defines the dom element to collect the events from
  70898. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  70899. */
  70900. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  70901. /**
  70902. * Detach the current manager inputs controls from a specific dom element.
  70903. * @param element Defines the dom element to collect the events from
  70904. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  70905. */
  70906. detachElement(element: HTMLElement, disconnect?: boolean): void;
  70907. /**
  70908. * Rebuild the dynamic inputCheck function from the current list of
  70909. * defined inputs in the manager.
  70910. */
  70911. rebuildInputCheck(): void;
  70912. /**
  70913. * Remove all attached input methods from a camera
  70914. */
  70915. clear(): void;
  70916. /**
  70917. * Serialize the current input manager attached to a camera.
  70918. * This ensures than once parsed,
  70919. * the input associated to the camera will be identical to the current ones
  70920. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  70921. */
  70922. serialize(serializedCamera: any): void;
  70923. /**
  70924. * Parses an input manager serialized JSON to restore the previous list of inputs
  70925. * and states associated to a camera.
  70926. * @param parsedCamera Defines the JSON to parse
  70927. */
  70928. parse(parsedCamera: any): void;
  70929. }
  70930. }
  70931. declare module BABYLON {
  70932. /**
  70933. * @hidden
  70934. */
  70935. export class IntersectionInfo {
  70936. bu: Nullable<number>;
  70937. bv: Nullable<number>;
  70938. distance: number;
  70939. faceId: number;
  70940. subMeshId: number;
  70941. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  70942. }
  70943. }
  70944. declare module BABYLON {
  70945. /**
  70946. * Represens a plane by the equation ax + by + cz + d = 0
  70947. */
  70948. export class Plane {
  70949. private static _TmpMatrix;
  70950. /**
  70951. * Normal of the plane (a,b,c)
  70952. */
  70953. normal: Vector3;
  70954. /**
  70955. * d component of the plane
  70956. */
  70957. d: number;
  70958. /**
  70959. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  70960. * @param a a component of the plane
  70961. * @param b b component of the plane
  70962. * @param c c component of the plane
  70963. * @param d d component of the plane
  70964. */
  70965. constructor(a: number, b: number, c: number, d: number);
  70966. /**
  70967. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  70968. */
  70969. asArray(): number[];
  70970. /**
  70971. * @returns a new plane copied from the current Plane.
  70972. */
  70973. clone(): Plane;
  70974. /**
  70975. * @returns the string "Plane".
  70976. */
  70977. getClassName(): string;
  70978. /**
  70979. * @returns the Plane hash code.
  70980. */
  70981. getHashCode(): number;
  70982. /**
  70983. * Normalize the current Plane in place.
  70984. * @returns the updated Plane.
  70985. */
  70986. normalize(): Plane;
  70987. /**
  70988. * Applies a transformation the plane and returns the result
  70989. * @param transformation the transformation matrix to be applied to the plane
  70990. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  70991. */
  70992. transform(transformation: DeepImmutable<Matrix>): Plane;
  70993. /**
  70994. * Calcualtte the dot product between the point and the plane normal
  70995. * @param point point to calculate the dot product with
  70996. * @returns the dot product (float) of the point coordinates and the plane normal.
  70997. */
  70998. dotCoordinate(point: DeepImmutable<Vector3>): number;
  70999. /**
  71000. * Updates the current Plane from the plane defined by the three given points.
  71001. * @param point1 one of the points used to contruct the plane
  71002. * @param point2 one of the points used to contruct the plane
  71003. * @param point3 one of the points used to contruct the plane
  71004. * @returns the updated Plane.
  71005. */
  71006. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  71007. /**
  71008. * Checks if the plane is facing a given direction
  71009. * @param direction the direction to check if the plane is facing
  71010. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  71011. * @returns True is the vector "direction" is the same side than the plane normal.
  71012. */
  71013. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  71014. /**
  71015. * Calculates the distance to a point
  71016. * @param point point to calculate distance to
  71017. * @returns the signed distance (float) from the given point to the Plane.
  71018. */
  71019. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  71020. /**
  71021. * Creates a plane from an array
  71022. * @param array the array to create a plane from
  71023. * @returns a new Plane from the given array.
  71024. */
  71025. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  71026. /**
  71027. * Creates a plane from three points
  71028. * @param point1 point used to create the plane
  71029. * @param point2 point used to create the plane
  71030. * @param point3 point used to create the plane
  71031. * @returns a new Plane defined by the three given points.
  71032. */
  71033. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  71034. /**
  71035. * Creates a plane from an origin point and a normal
  71036. * @param origin origin of the plane to be constructed
  71037. * @param normal normal of the plane to be constructed
  71038. * @returns a new Plane the normal vector to this plane at the given origin point.
  71039. * Note : the vector "normal" is updated because normalized.
  71040. */
  71041. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  71042. /**
  71043. * Calculates the distance from a plane and a point
  71044. * @param origin origin of the plane to be constructed
  71045. * @param normal normal of the plane to be constructed
  71046. * @param point point to calculate distance to
  71047. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  71048. */
  71049. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  71050. }
  71051. }
  71052. declare module BABYLON {
  71053. /**
  71054. * Class used to store bounding sphere information
  71055. */
  71056. export class BoundingSphere {
  71057. /**
  71058. * Gets the center of the bounding sphere in local space
  71059. */
  71060. readonly center: Vector3;
  71061. /**
  71062. * Radius of the bounding sphere in local space
  71063. */
  71064. radius: number;
  71065. /**
  71066. * Gets the center of the bounding sphere in world space
  71067. */
  71068. readonly centerWorld: Vector3;
  71069. /**
  71070. * Radius of the bounding sphere in world space
  71071. */
  71072. radiusWorld: number;
  71073. /**
  71074. * Gets the minimum vector in local space
  71075. */
  71076. readonly minimum: Vector3;
  71077. /**
  71078. * Gets the maximum vector in local space
  71079. */
  71080. readonly maximum: Vector3;
  71081. private _worldMatrix;
  71082. private static readonly TmpVector3;
  71083. /**
  71084. * Creates a new bounding sphere
  71085. * @param min defines the minimum vector (in local space)
  71086. * @param max defines the maximum vector (in local space)
  71087. * @param worldMatrix defines the new world matrix
  71088. */
  71089. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  71090. /**
  71091. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  71092. * @param min defines the new minimum vector (in local space)
  71093. * @param max defines the new maximum vector (in local space)
  71094. * @param worldMatrix defines the new world matrix
  71095. */
  71096. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  71097. /**
  71098. * Scale the current bounding sphere by applying a scale factor
  71099. * @param factor defines the scale factor to apply
  71100. * @returns the current bounding box
  71101. */
  71102. scale(factor: number): BoundingSphere;
  71103. /**
  71104. * Gets the world matrix of the bounding box
  71105. * @returns a matrix
  71106. */
  71107. getWorldMatrix(): DeepImmutable<Matrix>;
  71108. /** @hidden */
  71109. _update(worldMatrix: DeepImmutable<Matrix>): void;
  71110. /**
  71111. * Tests if the bounding sphere is intersecting the frustum planes
  71112. * @param frustumPlanes defines the frustum planes to test
  71113. * @returns true if there is an intersection
  71114. */
  71115. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71116. /**
  71117. * Tests if the bounding sphere center is in between the frustum planes.
  71118. * Used for optimistic fast inclusion.
  71119. * @param frustumPlanes defines the frustum planes to test
  71120. * @returns true if the sphere center is in between the frustum planes
  71121. */
  71122. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71123. /**
  71124. * Tests if a point is inside the bounding sphere
  71125. * @param point defines the point to test
  71126. * @returns true if the point is inside the bounding sphere
  71127. */
  71128. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  71129. /**
  71130. * Checks if two sphere intersct
  71131. * @param sphere0 sphere 0
  71132. * @param sphere1 sphere 1
  71133. * @returns true if the speres intersect
  71134. */
  71135. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  71136. }
  71137. }
  71138. declare module BABYLON {
  71139. /**
  71140. * Class used to store bounding box information
  71141. */
  71142. export class BoundingBox implements ICullable {
  71143. /**
  71144. * Gets the 8 vectors representing the bounding box in local space
  71145. */
  71146. readonly vectors: Vector3[];
  71147. /**
  71148. * Gets the center of the bounding box in local space
  71149. */
  71150. readonly center: Vector3;
  71151. /**
  71152. * Gets the center of the bounding box in world space
  71153. */
  71154. readonly centerWorld: Vector3;
  71155. /**
  71156. * Gets the extend size in local space
  71157. */
  71158. readonly extendSize: Vector3;
  71159. /**
  71160. * Gets the extend size in world space
  71161. */
  71162. readonly extendSizeWorld: Vector3;
  71163. /**
  71164. * Gets the OBB (object bounding box) directions
  71165. */
  71166. readonly directions: Vector3[];
  71167. /**
  71168. * Gets the 8 vectors representing the bounding box in world space
  71169. */
  71170. readonly vectorsWorld: Vector3[];
  71171. /**
  71172. * Gets the minimum vector in world space
  71173. */
  71174. readonly minimumWorld: Vector3;
  71175. /**
  71176. * Gets the maximum vector in world space
  71177. */
  71178. readonly maximumWorld: Vector3;
  71179. /**
  71180. * Gets the minimum vector in local space
  71181. */
  71182. readonly minimum: Vector3;
  71183. /**
  71184. * Gets the maximum vector in local space
  71185. */
  71186. readonly maximum: Vector3;
  71187. private _worldMatrix;
  71188. private static readonly TmpVector3;
  71189. /**
  71190. * @hidden
  71191. */
  71192. _tag: number;
  71193. /**
  71194. * Creates a new bounding box
  71195. * @param min defines the minimum vector (in local space)
  71196. * @param max defines the maximum vector (in local space)
  71197. * @param worldMatrix defines the new world matrix
  71198. */
  71199. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  71200. /**
  71201. * Recreates the entire bounding box from scratch as if we call the constructor in place
  71202. * @param min defines the new minimum vector (in local space)
  71203. * @param max defines the new maximum vector (in local space)
  71204. * @param worldMatrix defines the new world matrix
  71205. */
  71206. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  71207. /**
  71208. * Scale the current bounding box by applying a scale factor
  71209. * @param factor defines the scale factor to apply
  71210. * @returns the current bounding box
  71211. */
  71212. scale(factor: number): BoundingBox;
  71213. /**
  71214. * Gets the world matrix of the bounding box
  71215. * @returns a matrix
  71216. */
  71217. getWorldMatrix(): DeepImmutable<Matrix>;
  71218. /** @hidden */
  71219. _update(world: DeepImmutable<Matrix>): void;
  71220. /**
  71221. * Tests if the bounding box is intersecting the frustum planes
  71222. * @param frustumPlanes defines the frustum planes to test
  71223. * @returns true if there is an intersection
  71224. */
  71225. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71226. /**
  71227. * Tests if the bounding box is entirely inside the frustum planes
  71228. * @param frustumPlanes defines the frustum planes to test
  71229. * @returns true if there is an inclusion
  71230. */
  71231. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71232. /**
  71233. * Tests if a point is inside the bounding box
  71234. * @param point defines the point to test
  71235. * @returns true if the point is inside the bounding box
  71236. */
  71237. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  71238. /**
  71239. * Tests if the bounding box intersects with a bounding sphere
  71240. * @param sphere defines the sphere to test
  71241. * @returns true if there is an intersection
  71242. */
  71243. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  71244. /**
  71245. * Tests if the bounding box intersects with a box defined by a min and max vectors
  71246. * @param min defines the min vector to use
  71247. * @param max defines the max vector to use
  71248. * @returns true if there is an intersection
  71249. */
  71250. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  71251. /**
  71252. * Tests if two bounding boxes are intersections
  71253. * @param box0 defines the first box to test
  71254. * @param box1 defines the second box to test
  71255. * @returns true if there is an intersection
  71256. */
  71257. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  71258. /**
  71259. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  71260. * @param minPoint defines the minimum vector of the bounding box
  71261. * @param maxPoint defines the maximum vector of the bounding box
  71262. * @param sphereCenter defines the sphere center
  71263. * @param sphereRadius defines the sphere radius
  71264. * @returns true if there is an intersection
  71265. */
  71266. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  71267. /**
  71268. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  71269. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  71270. * @param frustumPlanes defines the frustum planes to test
  71271. * @return true if there is an inclusion
  71272. */
  71273. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71274. /**
  71275. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  71276. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  71277. * @param frustumPlanes defines the frustum planes to test
  71278. * @return true if there is an intersection
  71279. */
  71280. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71281. }
  71282. }
  71283. declare module BABYLON {
  71284. /** @hidden */
  71285. export class Collider {
  71286. /** Define if a collision was found */
  71287. collisionFound: boolean;
  71288. /**
  71289. * Define last intersection point in local space
  71290. */
  71291. intersectionPoint: Vector3;
  71292. /**
  71293. * Define last collided mesh
  71294. */
  71295. collidedMesh: Nullable<AbstractMesh>;
  71296. private _collisionPoint;
  71297. private _planeIntersectionPoint;
  71298. private _tempVector;
  71299. private _tempVector2;
  71300. private _tempVector3;
  71301. private _tempVector4;
  71302. private _edge;
  71303. private _baseToVertex;
  71304. private _destinationPoint;
  71305. private _slidePlaneNormal;
  71306. private _displacementVector;
  71307. /** @hidden */
  71308. _radius: Vector3;
  71309. /** @hidden */
  71310. _retry: number;
  71311. private _velocity;
  71312. private _basePoint;
  71313. private _epsilon;
  71314. /** @hidden */
  71315. _velocityWorldLength: number;
  71316. /** @hidden */
  71317. _basePointWorld: Vector3;
  71318. private _velocityWorld;
  71319. private _normalizedVelocity;
  71320. /** @hidden */
  71321. _initialVelocity: Vector3;
  71322. /** @hidden */
  71323. _initialPosition: Vector3;
  71324. private _nearestDistance;
  71325. private _collisionMask;
  71326. collisionMask: number;
  71327. /**
  71328. * Gets the plane normal used to compute the sliding response (in local space)
  71329. */
  71330. readonly slidePlaneNormal: Vector3;
  71331. /** @hidden */
  71332. _initialize(source: Vector3, dir: Vector3, e: number): void;
  71333. /** @hidden */
  71334. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  71335. /** @hidden */
  71336. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  71337. /** @hidden */
  71338. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  71339. /** @hidden */
  71340. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  71341. /** @hidden */
  71342. _getResponse(pos: Vector3, vel: Vector3): void;
  71343. }
  71344. }
  71345. declare module BABYLON {
  71346. /**
  71347. * Interface for cullable objects
  71348. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  71349. */
  71350. export interface ICullable {
  71351. /**
  71352. * Checks if the object or part of the object is in the frustum
  71353. * @param frustumPlanes Camera near/planes
  71354. * @returns true if the object is in frustum otherwise false
  71355. */
  71356. isInFrustum(frustumPlanes: Plane[]): boolean;
  71357. /**
  71358. * Checks if a cullable object (mesh...) is in the camera frustum
  71359. * Unlike isInFrustum this cheks the full bounding box
  71360. * @param frustumPlanes Camera near/planes
  71361. * @returns true if the object is in frustum otherwise false
  71362. */
  71363. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  71364. }
  71365. /**
  71366. * Info for a bounding data of a mesh
  71367. */
  71368. export class BoundingInfo implements ICullable {
  71369. /**
  71370. * Bounding box for the mesh
  71371. */
  71372. readonly boundingBox: BoundingBox;
  71373. /**
  71374. * Bounding sphere for the mesh
  71375. */
  71376. readonly boundingSphere: BoundingSphere;
  71377. private _isLocked;
  71378. private static readonly TmpVector3;
  71379. /**
  71380. * Constructs bounding info
  71381. * @param minimum min vector of the bounding box/sphere
  71382. * @param maximum max vector of the bounding box/sphere
  71383. * @param worldMatrix defines the new world matrix
  71384. */
  71385. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  71386. /**
  71387. * Recreates the entire bounding info from scratch as if we call the constructor in place
  71388. * @param min defines the new minimum vector (in local space)
  71389. * @param max defines the new maximum vector (in local space)
  71390. * @param worldMatrix defines the new world matrix
  71391. */
  71392. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  71393. /**
  71394. * min vector of the bounding box/sphere
  71395. */
  71396. readonly minimum: Vector3;
  71397. /**
  71398. * max vector of the bounding box/sphere
  71399. */
  71400. readonly maximum: Vector3;
  71401. /**
  71402. * If the info is locked and won't be updated to avoid perf overhead
  71403. */
  71404. isLocked: boolean;
  71405. /**
  71406. * Updates the bounding sphere and box
  71407. * @param world world matrix to be used to update
  71408. */
  71409. update(world: DeepImmutable<Matrix>): void;
  71410. /**
  71411. * Recreate the bounding info to be centered around a specific point given a specific extend.
  71412. * @param center New center of the bounding info
  71413. * @param extend New extend of the bounding info
  71414. * @returns the current bounding info
  71415. */
  71416. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  71417. /**
  71418. * Scale the current bounding info by applying a scale factor
  71419. * @param factor defines the scale factor to apply
  71420. * @returns the current bounding info
  71421. */
  71422. scale(factor: number): BoundingInfo;
  71423. /**
  71424. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  71425. * @param frustumPlanes defines the frustum to test
  71426. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  71427. * @returns true if the bounding info is in the frustum planes
  71428. */
  71429. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  71430. /**
  71431. * Gets the world distance between the min and max points of the bounding box
  71432. */
  71433. readonly diagonalLength: number;
  71434. /**
  71435. * Checks if a cullable object (mesh...) is in the camera frustum
  71436. * Unlike isInFrustum this cheks the full bounding box
  71437. * @param frustumPlanes Camera near/planes
  71438. * @returns true if the object is in frustum otherwise false
  71439. */
  71440. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  71441. /** @hidden */
  71442. _checkCollision(collider: Collider): boolean;
  71443. /**
  71444. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  71445. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  71446. * @param point the point to check intersection with
  71447. * @returns if the point intersects
  71448. */
  71449. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  71450. /**
  71451. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  71452. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  71453. * @param boundingInfo the bounding info to check intersection with
  71454. * @param precise if the intersection should be done using OBB
  71455. * @returns if the bounding info intersects
  71456. */
  71457. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  71458. }
  71459. }
  71460. declare module BABYLON {
  71461. /**
  71462. * Extracts minimum and maximum values from a list of indexed positions
  71463. * @param positions defines the positions to use
  71464. * @param indices defines the indices to the positions
  71465. * @param indexStart defines the start index
  71466. * @param indexCount defines the end index
  71467. * @param bias defines bias value to add to the result
  71468. * @return minimum and maximum values
  71469. */
  71470. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  71471. minimum: Vector3;
  71472. maximum: Vector3;
  71473. };
  71474. /**
  71475. * Extracts minimum and maximum values from a list of positions
  71476. * @param positions defines the positions to use
  71477. * @param start defines the start index in the positions array
  71478. * @param count defines the number of positions to handle
  71479. * @param bias defines bias value to add to the result
  71480. * @param stride defines the stride size to use (distance between two positions in the positions array)
  71481. * @return minimum and maximum values
  71482. */
  71483. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  71484. minimum: Vector3;
  71485. maximum: Vector3;
  71486. };
  71487. }
  71488. declare module BABYLON {
  71489. /**
  71490. * Enum that determines the text-wrapping mode to use.
  71491. */
  71492. export enum InspectableType {
  71493. /**
  71494. * Checkbox for booleans
  71495. */
  71496. Checkbox = 0,
  71497. /**
  71498. * Sliders for numbers
  71499. */
  71500. Slider = 1,
  71501. /**
  71502. * Vector3
  71503. */
  71504. Vector3 = 2,
  71505. /**
  71506. * Quaternions
  71507. */
  71508. Quaternion = 3,
  71509. /**
  71510. * Color3
  71511. */
  71512. Color3 = 4,
  71513. /**
  71514. * String
  71515. */
  71516. String = 5
  71517. }
  71518. /**
  71519. * Interface used to define custom inspectable properties.
  71520. * This interface is used by the inspector to display custom property grids
  71521. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  71522. */
  71523. export interface IInspectable {
  71524. /**
  71525. * Gets the label to display
  71526. */
  71527. label: string;
  71528. /**
  71529. * Gets the name of the property to edit
  71530. */
  71531. propertyName: string;
  71532. /**
  71533. * Gets the type of the editor to use
  71534. */
  71535. type: InspectableType;
  71536. /**
  71537. * Gets the minimum value of the property when using in "slider" mode
  71538. */
  71539. min?: number;
  71540. /**
  71541. * Gets the maximum value of the property when using in "slider" mode
  71542. */
  71543. max?: number;
  71544. /**
  71545. * Gets the setp to use when using in "slider" mode
  71546. */
  71547. step?: number;
  71548. }
  71549. }
  71550. declare module BABYLON {
  71551. /**
  71552. * Class used to provide helper for timing
  71553. */
  71554. export class TimingTools {
  71555. /**
  71556. * Polyfill for setImmediate
  71557. * @param action defines the action to execute after the current execution block
  71558. */
  71559. static SetImmediate(action: () => void): void;
  71560. }
  71561. }
  71562. declare module BABYLON {
  71563. /**
  71564. * Class used to enable instatition of objects by class name
  71565. */
  71566. export class InstantiationTools {
  71567. /**
  71568. * Use this object to register external classes like custom textures or material
  71569. * to allow the laoders to instantiate them
  71570. */
  71571. static RegisteredExternalClasses: {
  71572. [key: string]: Object;
  71573. };
  71574. /**
  71575. * Tries to instantiate a new object from a given class name
  71576. * @param className defines the class name to instantiate
  71577. * @returns the new object or null if the system was not able to do the instantiation
  71578. */
  71579. static Instantiate(className: string): any;
  71580. }
  71581. }
  71582. declare module BABYLON {
  71583. /**
  71584. * This represents the required contract to create a new type of texture loader.
  71585. */
  71586. export interface IInternalTextureLoader {
  71587. /**
  71588. * Defines wether the loader supports cascade loading the different faces.
  71589. */
  71590. supportCascades: boolean;
  71591. /**
  71592. * This returns if the loader support the current file information.
  71593. * @param extension defines the file extension of the file being loaded
  71594. * @param textureFormatInUse defines the current compressed format in use iun the engine
  71595. * @param fallback defines the fallback internal texture if any
  71596. * @param isBase64 defines whether the texture is encoded as a base64
  71597. * @param isBuffer defines whether the texture data are stored as a buffer
  71598. * @returns true if the loader can load the specified file
  71599. */
  71600. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  71601. /**
  71602. * Transform the url before loading if required.
  71603. * @param rootUrl the url of the texture
  71604. * @param textureFormatInUse defines the current compressed format in use iun the engine
  71605. * @returns the transformed texture
  71606. */
  71607. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  71608. /**
  71609. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  71610. * @param rootUrl the url of the texture
  71611. * @param textureFormatInUse defines the current compressed format in use iun the engine
  71612. * @returns the fallback texture
  71613. */
  71614. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  71615. /**
  71616. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  71617. * @param data contains the texture data
  71618. * @param texture defines the BabylonJS internal texture
  71619. * @param createPolynomials will be true if polynomials have been requested
  71620. * @param onLoad defines the callback to trigger once the texture is ready
  71621. * @param onError defines the callback to trigger in case of error
  71622. */
  71623. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  71624. /**
  71625. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  71626. * @param data contains the texture data
  71627. * @param texture defines the BabylonJS internal texture
  71628. * @param callback defines the method to call once ready to upload
  71629. */
  71630. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  71631. }
  71632. }
  71633. declare module BABYLON {
  71634. interface Engine {
  71635. /**
  71636. * Creates a depth stencil cube texture.
  71637. * This is only available in WebGL 2.
  71638. * @param size The size of face edge in the cube texture.
  71639. * @param options The options defining the cube texture.
  71640. * @returns The cube texture
  71641. */
  71642. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  71643. /**
  71644. * Creates a cube texture
  71645. * @param rootUrl defines the url where the files to load is located
  71646. * @param scene defines the current scene
  71647. * @param files defines the list of files to load (1 per face)
  71648. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  71649. * @param onLoad defines an optional callback raised when the texture is loaded
  71650. * @param onError defines an optional callback raised if there is an issue to load the texture
  71651. * @param format defines the format of the data
  71652. * @param forcedExtension defines the extension to use to pick the right loader
  71653. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  71654. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  71655. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  71656. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  71657. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  71658. * @returns the cube texture as an InternalTexture
  71659. */
  71660. 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;
  71661. /**
  71662. * Creates a cube texture
  71663. * @param rootUrl defines the url where the files to load is located
  71664. * @param scene defines the current scene
  71665. * @param files defines the list of files to load (1 per face)
  71666. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  71667. * @param onLoad defines an optional callback raised when the texture is loaded
  71668. * @param onError defines an optional callback raised if there is an issue to load the texture
  71669. * @param format defines the format of the data
  71670. * @param forcedExtension defines the extension to use to pick the right loader
  71671. * @returns the cube texture as an InternalTexture
  71672. */
  71673. 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;
  71674. /**
  71675. * Creates a cube texture
  71676. * @param rootUrl defines the url where the files to load is located
  71677. * @param scene defines the current scene
  71678. * @param files defines the list of files to load (1 per face)
  71679. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  71680. * @param onLoad defines an optional callback raised when the texture is loaded
  71681. * @param onError defines an optional callback raised if there is an issue to load the texture
  71682. * @param format defines the format of the data
  71683. * @param forcedExtension defines the extension to use to pick the right loader
  71684. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  71685. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  71686. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  71687. * @returns the cube texture as an InternalTexture
  71688. */
  71689. 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;
  71690. /** @hidden */
  71691. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  71692. /** @hidden */
  71693. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  71694. /** @hidden */
  71695. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  71696. /** @hidden */
  71697. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  71698. }
  71699. }
  71700. declare module BABYLON {
  71701. /**
  71702. * Class for creating a cube texture
  71703. */
  71704. export class CubeTexture extends BaseTexture {
  71705. private _delayedOnLoad;
  71706. /**
  71707. * The url of the texture
  71708. */
  71709. url: string;
  71710. /**
  71711. * Gets or sets the center of the bounding box associated with the cube texture.
  71712. * It must define where the camera used to render the texture was set
  71713. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  71714. */
  71715. boundingBoxPosition: Vector3;
  71716. private _boundingBoxSize;
  71717. /**
  71718. * Gets or sets the size of the bounding box associated with the cube texture
  71719. * When defined, the cubemap will switch to local mode
  71720. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  71721. * @example https://www.babylonjs-playground.com/#RNASML
  71722. */
  71723. /**
  71724. * Returns the bounding box size
  71725. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  71726. */
  71727. boundingBoxSize: Vector3;
  71728. protected _rotationY: number;
  71729. /**
  71730. * Sets texture matrix rotation angle around Y axis in radians.
  71731. */
  71732. /**
  71733. * Gets texture matrix rotation angle around Y axis radians.
  71734. */
  71735. rotationY: number;
  71736. /**
  71737. * Are mip maps generated for this texture or not.
  71738. */
  71739. readonly noMipmap: boolean;
  71740. private _noMipmap;
  71741. private _files;
  71742. private _extensions;
  71743. private _textureMatrix;
  71744. private _format;
  71745. private _createPolynomials;
  71746. /** @hidden */
  71747. _prefiltered: boolean;
  71748. /**
  71749. * Creates a cube texture from an array of image urls
  71750. * @param files defines an array of image urls
  71751. * @param scene defines the hosting scene
  71752. * @param noMipmap specifies if mip maps are not used
  71753. * @returns a cube texture
  71754. */
  71755. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  71756. /**
  71757. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  71758. * @param url defines the url of the prefiltered texture
  71759. * @param scene defines the scene the texture is attached to
  71760. * @param forcedExtension defines the extension of the file if different from the url
  71761. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  71762. * @return the prefiltered texture
  71763. */
  71764. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  71765. /**
  71766. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  71767. * as prefiltered data.
  71768. * @param rootUrl defines the url of the texture or the root name of the six images
  71769. * @param scene defines the scene the texture is attached to
  71770. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  71771. * @param noMipmap defines if mipmaps should be created or not
  71772. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  71773. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  71774. * @param onError defines a callback triggered in case of error during load
  71775. * @param format defines the internal format to use for the texture once loaded
  71776. * @param prefiltered defines whether or not the texture is created from prefiltered data
  71777. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  71778. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  71779. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  71780. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  71781. * @return the cube texture
  71782. */
  71783. 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);
  71784. /**
  71785. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  71786. */
  71787. readonly isPrefiltered: boolean;
  71788. /**
  71789. * Get the current class name of the texture useful for serialization or dynamic coding.
  71790. * @returns "CubeTexture"
  71791. */
  71792. getClassName(): string;
  71793. /**
  71794. * Update the url (and optional buffer) of this texture if url was null during construction.
  71795. * @param url the url of the texture
  71796. * @param forcedExtension defines the extension to use
  71797. * @param onLoad callback called when the texture is loaded (defaults to null)
  71798. */
  71799. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  71800. /**
  71801. * Delays loading of the cube texture
  71802. * @param forcedExtension defines the extension to use
  71803. */
  71804. delayLoad(forcedExtension?: string): void;
  71805. /**
  71806. * Returns the reflection texture matrix
  71807. * @returns the reflection texture matrix
  71808. */
  71809. getReflectionTextureMatrix(): Matrix;
  71810. /**
  71811. * Sets the reflection texture matrix
  71812. * @param value Reflection texture matrix
  71813. */
  71814. setReflectionTextureMatrix(value: Matrix): void;
  71815. /**
  71816. * Parses text to create a cube texture
  71817. * @param parsedTexture define the serialized text to read from
  71818. * @param scene defines the hosting scene
  71819. * @param rootUrl defines the root url of the cube texture
  71820. * @returns a cube texture
  71821. */
  71822. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  71823. /**
  71824. * Makes a clone, or deep copy, of the cube texture
  71825. * @returns a new cube texture
  71826. */
  71827. clone(): CubeTexture;
  71828. }
  71829. }
  71830. declare module BABYLON {
  71831. /**
  71832. * Manages the defines for the Material
  71833. */
  71834. export class MaterialDefines {
  71835. /** @hidden */
  71836. protected _keys: string[];
  71837. private _isDirty;
  71838. /** @hidden */
  71839. _renderId: number;
  71840. /** @hidden */
  71841. _areLightsDirty: boolean;
  71842. /** @hidden */
  71843. _areAttributesDirty: boolean;
  71844. /** @hidden */
  71845. _areTexturesDirty: boolean;
  71846. /** @hidden */
  71847. _areFresnelDirty: boolean;
  71848. /** @hidden */
  71849. _areMiscDirty: boolean;
  71850. /** @hidden */
  71851. _areImageProcessingDirty: boolean;
  71852. /** @hidden */
  71853. _normals: boolean;
  71854. /** @hidden */
  71855. _uvs: boolean;
  71856. /** @hidden */
  71857. _needNormals: boolean;
  71858. /** @hidden */
  71859. _needUVs: boolean;
  71860. [id: string]: any;
  71861. /**
  71862. * Specifies if the material needs to be re-calculated
  71863. */
  71864. readonly isDirty: boolean;
  71865. /**
  71866. * Marks the material to indicate that it has been re-calculated
  71867. */
  71868. markAsProcessed(): void;
  71869. /**
  71870. * Marks the material to indicate that it needs to be re-calculated
  71871. */
  71872. markAsUnprocessed(): void;
  71873. /**
  71874. * Marks the material to indicate all of its defines need to be re-calculated
  71875. */
  71876. markAllAsDirty(): void;
  71877. /**
  71878. * Marks the material to indicate that image processing needs to be re-calculated
  71879. */
  71880. markAsImageProcessingDirty(): void;
  71881. /**
  71882. * Marks the material to indicate the lights need to be re-calculated
  71883. */
  71884. markAsLightDirty(): void;
  71885. /**
  71886. * Marks the attribute state as changed
  71887. */
  71888. markAsAttributesDirty(): void;
  71889. /**
  71890. * Marks the texture state as changed
  71891. */
  71892. markAsTexturesDirty(): void;
  71893. /**
  71894. * Marks the fresnel state as changed
  71895. */
  71896. markAsFresnelDirty(): void;
  71897. /**
  71898. * Marks the misc state as changed
  71899. */
  71900. markAsMiscDirty(): void;
  71901. /**
  71902. * Rebuilds the material defines
  71903. */
  71904. rebuild(): void;
  71905. /**
  71906. * Specifies if two material defines are equal
  71907. * @param other - A material define instance to compare to
  71908. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  71909. */
  71910. isEqual(other: MaterialDefines): boolean;
  71911. /**
  71912. * Clones this instance's defines to another instance
  71913. * @param other - material defines to clone values to
  71914. */
  71915. cloneTo(other: MaterialDefines): void;
  71916. /**
  71917. * Resets the material define values
  71918. */
  71919. reset(): void;
  71920. /**
  71921. * Converts the material define values to a string
  71922. * @returns - String of material define information
  71923. */
  71924. toString(): string;
  71925. }
  71926. }
  71927. declare module BABYLON {
  71928. /**
  71929. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  71930. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  71931. * 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;
  71932. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  71933. */
  71934. export class ColorCurves {
  71935. private _dirty;
  71936. private _tempColor;
  71937. private _globalCurve;
  71938. private _highlightsCurve;
  71939. private _midtonesCurve;
  71940. private _shadowsCurve;
  71941. private _positiveCurve;
  71942. private _negativeCurve;
  71943. private _globalHue;
  71944. private _globalDensity;
  71945. private _globalSaturation;
  71946. private _globalExposure;
  71947. /**
  71948. * Gets the global Hue value.
  71949. * 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).
  71950. */
  71951. /**
  71952. * Sets the global Hue value.
  71953. * 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).
  71954. */
  71955. globalHue: number;
  71956. /**
  71957. * Gets the global Density value.
  71958. * 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.
  71959. * Values less than zero provide a filter of opposite hue.
  71960. */
  71961. /**
  71962. * Sets the global Density value.
  71963. * 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.
  71964. * Values less than zero provide a filter of opposite hue.
  71965. */
  71966. globalDensity: number;
  71967. /**
  71968. * Gets the global Saturation value.
  71969. * 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.
  71970. */
  71971. /**
  71972. * Sets the global Saturation value.
  71973. * 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.
  71974. */
  71975. globalSaturation: number;
  71976. /**
  71977. * Gets the global Exposure value.
  71978. * 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.
  71979. */
  71980. /**
  71981. * Sets the global Exposure value.
  71982. * 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.
  71983. */
  71984. globalExposure: number;
  71985. private _highlightsHue;
  71986. private _highlightsDensity;
  71987. private _highlightsSaturation;
  71988. private _highlightsExposure;
  71989. /**
  71990. * Gets the highlights Hue value.
  71991. * 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).
  71992. */
  71993. /**
  71994. * Sets the highlights Hue value.
  71995. * 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).
  71996. */
  71997. highlightsHue: number;
  71998. /**
  71999. * Gets the highlights Density value.
  72000. * 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.
  72001. * Values less than zero provide a filter of opposite hue.
  72002. */
  72003. /**
  72004. * Sets the highlights Density value.
  72005. * 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.
  72006. * Values less than zero provide a filter of opposite hue.
  72007. */
  72008. highlightsDensity: number;
  72009. /**
  72010. * Gets the highlights Saturation value.
  72011. * 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.
  72012. */
  72013. /**
  72014. * Sets the highlights Saturation value.
  72015. * 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.
  72016. */
  72017. highlightsSaturation: number;
  72018. /**
  72019. * Gets the highlights Exposure value.
  72020. * 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.
  72021. */
  72022. /**
  72023. * Sets the highlights Exposure value.
  72024. * 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.
  72025. */
  72026. highlightsExposure: number;
  72027. private _midtonesHue;
  72028. private _midtonesDensity;
  72029. private _midtonesSaturation;
  72030. private _midtonesExposure;
  72031. /**
  72032. * Gets the midtones Hue value.
  72033. * 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).
  72034. */
  72035. /**
  72036. * Sets the midtones Hue value.
  72037. * 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).
  72038. */
  72039. midtonesHue: number;
  72040. /**
  72041. * Gets the midtones Density value.
  72042. * 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.
  72043. * Values less than zero provide a filter of opposite hue.
  72044. */
  72045. /**
  72046. * Sets the midtones Density value.
  72047. * 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.
  72048. * Values less than zero provide a filter of opposite hue.
  72049. */
  72050. midtonesDensity: number;
  72051. /**
  72052. * Gets the midtones Saturation value.
  72053. * 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.
  72054. */
  72055. /**
  72056. * Sets the midtones Saturation value.
  72057. * 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.
  72058. */
  72059. midtonesSaturation: number;
  72060. /**
  72061. * Gets the midtones Exposure value.
  72062. * 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.
  72063. */
  72064. /**
  72065. * Sets the midtones Exposure value.
  72066. * 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.
  72067. */
  72068. midtonesExposure: number;
  72069. private _shadowsHue;
  72070. private _shadowsDensity;
  72071. private _shadowsSaturation;
  72072. private _shadowsExposure;
  72073. /**
  72074. * Gets the shadows Hue value.
  72075. * 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).
  72076. */
  72077. /**
  72078. * Sets the shadows Hue value.
  72079. * 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).
  72080. */
  72081. shadowsHue: number;
  72082. /**
  72083. * Gets the shadows Density value.
  72084. * 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.
  72085. * Values less than zero provide a filter of opposite hue.
  72086. */
  72087. /**
  72088. * Sets the shadows Density value.
  72089. * 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.
  72090. * Values less than zero provide a filter of opposite hue.
  72091. */
  72092. shadowsDensity: number;
  72093. /**
  72094. * Gets the shadows Saturation value.
  72095. * 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.
  72096. */
  72097. /**
  72098. * Sets the shadows Saturation value.
  72099. * 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.
  72100. */
  72101. shadowsSaturation: number;
  72102. /**
  72103. * Gets the shadows Exposure value.
  72104. * 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.
  72105. */
  72106. /**
  72107. * Sets the shadows Exposure value.
  72108. * 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.
  72109. */
  72110. shadowsExposure: number;
  72111. /**
  72112. * Returns the class name
  72113. * @returns The class name
  72114. */
  72115. getClassName(): string;
  72116. /**
  72117. * Binds the color curves to the shader.
  72118. * @param colorCurves The color curve to bind
  72119. * @param effect The effect to bind to
  72120. * @param positiveUniform The positive uniform shader parameter
  72121. * @param neutralUniform The neutral uniform shader parameter
  72122. * @param negativeUniform The negative uniform shader parameter
  72123. */
  72124. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  72125. /**
  72126. * Prepare the list of uniforms associated with the ColorCurves effects.
  72127. * @param uniformsList The list of uniforms used in the effect
  72128. */
  72129. static PrepareUniforms(uniformsList: string[]): void;
  72130. /**
  72131. * Returns color grading data based on a hue, density, saturation and exposure value.
  72132. * @param filterHue The hue of the color filter.
  72133. * @param filterDensity The density of the color filter.
  72134. * @param saturation The saturation.
  72135. * @param exposure The exposure.
  72136. * @param result The result data container.
  72137. */
  72138. private getColorGradingDataToRef;
  72139. /**
  72140. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  72141. * @param value The input slider value in range [-100,100].
  72142. * @returns Adjusted value.
  72143. */
  72144. private static applyColorGradingSliderNonlinear;
  72145. /**
  72146. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  72147. * @param hue The hue (H) input.
  72148. * @param saturation The saturation (S) input.
  72149. * @param brightness The brightness (B) input.
  72150. * @result An RGBA color represented as Vector4.
  72151. */
  72152. private static fromHSBToRef;
  72153. /**
  72154. * Returns a value clamped between min and max
  72155. * @param value The value to clamp
  72156. * @param min The minimum of value
  72157. * @param max The maximum of value
  72158. * @returns The clamped value.
  72159. */
  72160. private static clamp;
  72161. /**
  72162. * Clones the current color curve instance.
  72163. * @return The cloned curves
  72164. */
  72165. clone(): ColorCurves;
  72166. /**
  72167. * Serializes the current color curve instance to a json representation.
  72168. * @return a JSON representation
  72169. */
  72170. serialize(): any;
  72171. /**
  72172. * Parses the color curve from a json representation.
  72173. * @param source the JSON source to parse
  72174. * @return The parsed curves
  72175. */
  72176. static Parse(source: any): ColorCurves;
  72177. }
  72178. }
  72179. declare module BABYLON {
  72180. /**
  72181. * Interface to follow in your material defines to integrate easily the
  72182. * Image proccessing functions.
  72183. * @hidden
  72184. */
  72185. export interface IImageProcessingConfigurationDefines {
  72186. IMAGEPROCESSING: boolean;
  72187. VIGNETTE: boolean;
  72188. VIGNETTEBLENDMODEMULTIPLY: boolean;
  72189. VIGNETTEBLENDMODEOPAQUE: boolean;
  72190. TONEMAPPING: boolean;
  72191. TONEMAPPING_ACES: boolean;
  72192. CONTRAST: boolean;
  72193. EXPOSURE: boolean;
  72194. COLORCURVES: boolean;
  72195. COLORGRADING: boolean;
  72196. COLORGRADING3D: boolean;
  72197. SAMPLER3DGREENDEPTH: boolean;
  72198. SAMPLER3DBGRMAP: boolean;
  72199. IMAGEPROCESSINGPOSTPROCESS: boolean;
  72200. }
  72201. /**
  72202. * @hidden
  72203. */
  72204. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  72205. IMAGEPROCESSING: boolean;
  72206. VIGNETTE: boolean;
  72207. VIGNETTEBLENDMODEMULTIPLY: boolean;
  72208. VIGNETTEBLENDMODEOPAQUE: boolean;
  72209. TONEMAPPING: boolean;
  72210. TONEMAPPING_ACES: boolean;
  72211. CONTRAST: boolean;
  72212. COLORCURVES: boolean;
  72213. COLORGRADING: boolean;
  72214. COLORGRADING3D: boolean;
  72215. SAMPLER3DGREENDEPTH: boolean;
  72216. SAMPLER3DBGRMAP: boolean;
  72217. IMAGEPROCESSINGPOSTPROCESS: boolean;
  72218. EXPOSURE: boolean;
  72219. constructor();
  72220. }
  72221. /**
  72222. * This groups together the common properties used for image processing either in direct forward pass
  72223. * or through post processing effect depending on the use of the image processing pipeline in your scene
  72224. * or not.
  72225. */
  72226. export class ImageProcessingConfiguration {
  72227. /**
  72228. * Default tone mapping applied in BabylonJS.
  72229. */
  72230. static readonly TONEMAPPING_STANDARD: number;
  72231. /**
  72232. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  72233. * to other engines rendering to increase portability.
  72234. */
  72235. static readonly TONEMAPPING_ACES: number;
  72236. /**
  72237. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  72238. */
  72239. colorCurves: Nullable<ColorCurves>;
  72240. private _colorCurvesEnabled;
  72241. /**
  72242. * Gets wether the color curves effect is enabled.
  72243. */
  72244. /**
  72245. * Sets wether the color curves effect is enabled.
  72246. */
  72247. colorCurvesEnabled: boolean;
  72248. private _colorGradingTexture;
  72249. /**
  72250. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  72251. */
  72252. /**
  72253. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  72254. */
  72255. colorGradingTexture: Nullable<BaseTexture>;
  72256. private _colorGradingEnabled;
  72257. /**
  72258. * Gets wether the color grading effect is enabled.
  72259. */
  72260. /**
  72261. * Sets wether the color grading effect is enabled.
  72262. */
  72263. colorGradingEnabled: boolean;
  72264. private _colorGradingWithGreenDepth;
  72265. /**
  72266. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  72267. */
  72268. /**
  72269. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  72270. */
  72271. colorGradingWithGreenDepth: boolean;
  72272. private _colorGradingBGR;
  72273. /**
  72274. * Gets wether the color grading texture contains BGR values.
  72275. */
  72276. /**
  72277. * Sets wether the color grading texture contains BGR values.
  72278. */
  72279. colorGradingBGR: boolean;
  72280. /** @hidden */
  72281. _exposure: number;
  72282. /**
  72283. * Gets the Exposure used in the effect.
  72284. */
  72285. /**
  72286. * Sets the Exposure used in the effect.
  72287. */
  72288. exposure: number;
  72289. private _toneMappingEnabled;
  72290. /**
  72291. * Gets wether the tone mapping effect is enabled.
  72292. */
  72293. /**
  72294. * Sets wether the tone mapping effect is enabled.
  72295. */
  72296. toneMappingEnabled: boolean;
  72297. private _toneMappingType;
  72298. /**
  72299. * Gets the type of tone mapping effect.
  72300. */
  72301. /**
  72302. * Sets the type of tone mapping effect used in BabylonJS.
  72303. */
  72304. toneMappingType: number;
  72305. protected _contrast: number;
  72306. /**
  72307. * Gets the contrast used in the effect.
  72308. */
  72309. /**
  72310. * Sets the contrast used in the effect.
  72311. */
  72312. contrast: number;
  72313. /**
  72314. * Vignette stretch size.
  72315. */
  72316. vignetteStretch: number;
  72317. /**
  72318. * Vignette centre X Offset.
  72319. */
  72320. vignetteCentreX: number;
  72321. /**
  72322. * Vignette centre Y Offset.
  72323. */
  72324. vignetteCentreY: number;
  72325. /**
  72326. * Vignette weight or intensity of the vignette effect.
  72327. */
  72328. vignetteWeight: number;
  72329. /**
  72330. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  72331. * if vignetteEnabled is set to true.
  72332. */
  72333. vignetteColor: Color4;
  72334. /**
  72335. * Camera field of view used by the Vignette effect.
  72336. */
  72337. vignetteCameraFov: number;
  72338. private _vignetteBlendMode;
  72339. /**
  72340. * Gets the vignette blend mode allowing different kind of effect.
  72341. */
  72342. /**
  72343. * Sets the vignette blend mode allowing different kind of effect.
  72344. */
  72345. vignetteBlendMode: number;
  72346. private _vignetteEnabled;
  72347. /**
  72348. * Gets wether the vignette effect is enabled.
  72349. */
  72350. /**
  72351. * Sets wether the vignette effect is enabled.
  72352. */
  72353. vignetteEnabled: boolean;
  72354. private _applyByPostProcess;
  72355. /**
  72356. * Gets wether the image processing is applied through a post process or not.
  72357. */
  72358. /**
  72359. * Sets wether the image processing is applied through a post process or not.
  72360. */
  72361. applyByPostProcess: boolean;
  72362. private _isEnabled;
  72363. /**
  72364. * Gets wether the image processing is enabled or not.
  72365. */
  72366. /**
  72367. * Sets wether the image processing is enabled or not.
  72368. */
  72369. isEnabled: boolean;
  72370. /**
  72371. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  72372. */
  72373. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  72374. /**
  72375. * Method called each time the image processing information changes requires to recompile the effect.
  72376. */
  72377. protected _updateParameters(): void;
  72378. /**
  72379. * Gets the current class name.
  72380. * @return "ImageProcessingConfiguration"
  72381. */
  72382. getClassName(): string;
  72383. /**
  72384. * Prepare the list of uniforms associated with the Image Processing effects.
  72385. * @param uniforms The list of uniforms used in the effect
  72386. * @param defines the list of defines currently in use
  72387. */
  72388. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  72389. /**
  72390. * Prepare the list of samplers associated with the Image Processing effects.
  72391. * @param samplersList The list of uniforms used in the effect
  72392. * @param defines the list of defines currently in use
  72393. */
  72394. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  72395. /**
  72396. * Prepare the list of defines associated to the shader.
  72397. * @param defines the list of defines to complete
  72398. * @param forPostProcess Define if we are currently in post process mode or not
  72399. */
  72400. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  72401. /**
  72402. * Returns true if all the image processing information are ready.
  72403. * @returns True if ready, otherwise, false
  72404. */
  72405. isReady(): boolean;
  72406. /**
  72407. * Binds the image processing to the shader.
  72408. * @param effect The effect to bind to
  72409. * @param aspectRatio Define the current aspect ratio of the effect
  72410. */
  72411. bind(effect: Effect, aspectRatio?: number): void;
  72412. /**
  72413. * Clones the current image processing instance.
  72414. * @return The cloned image processing
  72415. */
  72416. clone(): ImageProcessingConfiguration;
  72417. /**
  72418. * Serializes the current image processing instance to a json representation.
  72419. * @return a JSON representation
  72420. */
  72421. serialize(): any;
  72422. /**
  72423. * Parses the image processing from a json representation.
  72424. * @param source the JSON source to parse
  72425. * @return The parsed image processing
  72426. */
  72427. static Parse(source: any): ImageProcessingConfiguration;
  72428. private static _VIGNETTEMODE_MULTIPLY;
  72429. private static _VIGNETTEMODE_OPAQUE;
  72430. /**
  72431. * Used to apply the vignette as a mix with the pixel color.
  72432. */
  72433. static readonly VIGNETTEMODE_MULTIPLY: number;
  72434. /**
  72435. * Used to apply the vignette as a replacement of the pixel color.
  72436. */
  72437. static readonly VIGNETTEMODE_OPAQUE: number;
  72438. }
  72439. }
  72440. declare module BABYLON {
  72441. /** @hidden */
  72442. export var postprocessVertexShader: {
  72443. name: string;
  72444. shader: string;
  72445. };
  72446. }
  72447. declare module BABYLON {
  72448. /** Defines supported spaces */
  72449. export enum Space {
  72450. /** Local (object) space */
  72451. LOCAL = 0,
  72452. /** World space */
  72453. WORLD = 1,
  72454. /** Bone space */
  72455. BONE = 2
  72456. }
  72457. /** Defines the 3 main axes */
  72458. export class Axis {
  72459. /** X axis */
  72460. static X: Vector3;
  72461. /** Y axis */
  72462. static Y: Vector3;
  72463. /** Z axis */
  72464. static Z: Vector3;
  72465. }
  72466. }
  72467. declare module BABYLON {
  72468. /**
  72469. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  72470. * This is the base of the follow, arc rotate cameras and Free camera
  72471. * @see http://doc.babylonjs.com/features/cameras
  72472. */
  72473. export class TargetCamera extends Camera {
  72474. private static _RigCamTransformMatrix;
  72475. private static _TargetTransformMatrix;
  72476. private static _TargetFocalPoint;
  72477. /**
  72478. * Define the current direction the camera is moving to
  72479. */
  72480. cameraDirection: Vector3;
  72481. /**
  72482. * Define the current rotation the camera is rotating to
  72483. */
  72484. cameraRotation: Vector2;
  72485. /**
  72486. * When set, the up vector of the camera will be updated by the rotation of the camera
  72487. */
  72488. updateUpVectorFromRotation: boolean;
  72489. private _tmpQuaternion;
  72490. /**
  72491. * Define the current rotation of the camera
  72492. */
  72493. rotation: Vector3;
  72494. /**
  72495. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  72496. */
  72497. rotationQuaternion: Quaternion;
  72498. /**
  72499. * Define the current speed of the camera
  72500. */
  72501. speed: number;
  72502. /**
  72503. * Add cconstraint to the camera to prevent it to move freely in all directions and
  72504. * around all axis.
  72505. */
  72506. noRotationConstraint: boolean;
  72507. /**
  72508. * Define the current target of the camera as an object or a position.
  72509. */
  72510. lockedTarget: any;
  72511. /** @hidden */
  72512. _currentTarget: Vector3;
  72513. /** @hidden */
  72514. _initialFocalDistance: number;
  72515. /** @hidden */
  72516. _viewMatrix: Matrix;
  72517. /** @hidden */
  72518. _camMatrix: Matrix;
  72519. /** @hidden */
  72520. _cameraTransformMatrix: Matrix;
  72521. /** @hidden */
  72522. _cameraRotationMatrix: Matrix;
  72523. /** @hidden */
  72524. _referencePoint: Vector3;
  72525. /** @hidden */
  72526. _transformedReferencePoint: Vector3;
  72527. protected _globalCurrentTarget: Vector3;
  72528. protected _globalCurrentUpVector: Vector3;
  72529. /** @hidden */
  72530. _reset: () => void;
  72531. private _defaultUp;
  72532. /**
  72533. * Instantiates a target camera that takes a meshor position as a target and continues to look at it while it moves.
  72534. * This is the base of the follow, arc rotate cameras and Free camera
  72535. * @see http://doc.babylonjs.com/features/cameras
  72536. * @param name Defines the name of the camera in the scene
  72537. * @param position Defines the start position of the camera in the scene
  72538. * @param scene Defines the scene the camera belongs to
  72539. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  72540. */
  72541. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  72542. /**
  72543. * Gets the position in front of the camera at a given distance.
  72544. * @param distance The distance from the camera we want the position to be
  72545. * @returns the position
  72546. */
  72547. getFrontPosition(distance: number): Vector3;
  72548. /** @hidden */
  72549. _getLockedTargetPosition(): Nullable<Vector3>;
  72550. private _storedPosition;
  72551. private _storedRotation;
  72552. private _storedRotationQuaternion;
  72553. /**
  72554. * Store current camera state of the camera (fov, position, rotation, etc..)
  72555. * @returns the camera
  72556. */
  72557. storeState(): Camera;
  72558. /**
  72559. * Restored camera state. You must call storeState() first
  72560. * @returns whether it was successful or not
  72561. * @hidden
  72562. */
  72563. _restoreStateValues(): boolean;
  72564. /** @hidden */
  72565. _initCache(): void;
  72566. /** @hidden */
  72567. _updateCache(ignoreParentClass?: boolean): void;
  72568. /** @hidden */
  72569. _isSynchronizedViewMatrix(): boolean;
  72570. /** @hidden */
  72571. _computeLocalCameraSpeed(): number;
  72572. /**
  72573. * Defines the target the camera should look at.
  72574. * @param target Defines the new target as a Vector or a mesh
  72575. */
  72576. setTarget(target: Vector3): void;
  72577. /**
  72578. * Return the current target position of the camera. This value is expressed in local space.
  72579. * @returns the target position
  72580. */
  72581. getTarget(): Vector3;
  72582. /** @hidden */
  72583. _decideIfNeedsToMove(): boolean;
  72584. /** @hidden */
  72585. _updatePosition(): void;
  72586. /** @hidden */
  72587. _checkInputs(): void;
  72588. protected _updateCameraRotationMatrix(): void;
  72589. /**
  72590. * 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)
  72591. * @returns the current camera
  72592. */
  72593. private _rotateUpVectorWithCameraRotationMatrix;
  72594. private _cachedRotationZ;
  72595. private _cachedQuaternionRotationZ;
  72596. /** @hidden */
  72597. _getViewMatrix(): Matrix;
  72598. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  72599. /**
  72600. * @hidden
  72601. */
  72602. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  72603. /**
  72604. * @hidden
  72605. */
  72606. _updateRigCameras(): void;
  72607. private _getRigCamPositionAndTarget;
  72608. /**
  72609. * Gets the current object class name.
  72610. * @return the class name
  72611. */
  72612. getClassName(): string;
  72613. }
  72614. }
  72615. declare module BABYLON {
  72616. /**
  72617. * Gather the list of keyboard event types as constants.
  72618. */
  72619. export class KeyboardEventTypes {
  72620. /**
  72621. * The keydown event is fired when a key becomes active (pressed).
  72622. */
  72623. static readonly KEYDOWN: number;
  72624. /**
  72625. * The keyup event is fired when a key has been released.
  72626. */
  72627. static readonly KEYUP: number;
  72628. }
  72629. /**
  72630. * This class is used to store keyboard related info for the onKeyboardObservable event.
  72631. */
  72632. export class KeyboardInfo {
  72633. /**
  72634. * Defines the type of event (KeyboardEventTypes)
  72635. */
  72636. type: number;
  72637. /**
  72638. * Defines the related dom event
  72639. */
  72640. event: KeyboardEvent;
  72641. /**
  72642. * Instantiates a new keyboard info.
  72643. * This class is used to store keyboard related info for the onKeyboardObservable event.
  72644. * @param type Defines the type of event (KeyboardEventTypes)
  72645. * @param event Defines the related dom event
  72646. */
  72647. constructor(
  72648. /**
  72649. * Defines the type of event (KeyboardEventTypes)
  72650. */
  72651. type: number,
  72652. /**
  72653. * Defines the related dom event
  72654. */
  72655. event: KeyboardEvent);
  72656. }
  72657. /**
  72658. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  72659. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  72660. */
  72661. export class KeyboardInfoPre extends KeyboardInfo {
  72662. /**
  72663. * Defines the type of event (KeyboardEventTypes)
  72664. */
  72665. type: number;
  72666. /**
  72667. * Defines the related dom event
  72668. */
  72669. event: KeyboardEvent;
  72670. /**
  72671. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  72672. */
  72673. skipOnPointerObservable: boolean;
  72674. /**
  72675. * Instantiates a new keyboard pre info.
  72676. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  72677. * @param type Defines the type of event (KeyboardEventTypes)
  72678. * @param event Defines the related dom event
  72679. */
  72680. constructor(
  72681. /**
  72682. * Defines the type of event (KeyboardEventTypes)
  72683. */
  72684. type: number,
  72685. /**
  72686. * Defines the related dom event
  72687. */
  72688. event: KeyboardEvent);
  72689. }
  72690. }
  72691. declare module BABYLON {
  72692. /**
  72693. * Manage the keyboard inputs to control the movement of a free camera.
  72694. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  72695. */
  72696. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  72697. /**
  72698. * Defines the camera the input is attached to.
  72699. */
  72700. camera: FreeCamera;
  72701. /**
  72702. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  72703. */
  72704. keysUp: number[];
  72705. /**
  72706. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  72707. */
  72708. keysDown: number[];
  72709. /**
  72710. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  72711. */
  72712. keysLeft: number[];
  72713. /**
  72714. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  72715. */
  72716. keysRight: number[];
  72717. private _keys;
  72718. private _onCanvasBlurObserver;
  72719. private _onKeyboardObserver;
  72720. private _engine;
  72721. private _scene;
  72722. /**
  72723. * Attach the input controls to a specific dom element to get the input from.
  72724. * @param element Defines the element the controls should be listened from
  72725. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  72726. */
  72727. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  72728. /**
  72729. * Detach the current controls from the specified dom element.
  72730. * @param element Defines the element to stop listening the inputs from
  72731. */
  72732. detachControl(element: Nullable<HTMLElement>): void;
  72733. /**
  72734. * Update the current camera state depending on the inputs that have been used this frame.
  72735. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  72736. */
  72737. checkInputs(): void;
  72738. /**
  72739. * Gets the class name of the current intput.
  72740. * @returns the class name
  72741. */
  72742. getClassName(): string;
  72743. /** @hidden */
  72744. _onLostFocus(): void;
  72745. /**
  72746. * Get the friendly name associated with the input class.
  72747. * @returns the input friendly name
  72748. */
  72749. getSimpleName(): string;
  72750. }
  72751. }
  72752. declare module BABYLON {
  72753. /**
  72754. * Interface describing all the common properties and methods a shadow light needs to implement.
  72755. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  72756. * as well as binding the different shadow properties to the effects.
  72757. */
  72758. export interface IShadowLight extends Light {
  72759. /**
  72760. * The light id in the scene (used in scene.findLighById for instance)
  72761. */
  72762. id: string;
  72763. /**
  72764. * The position the shdow will be casted from.
  72765. */
  72766. position: Vector3;
  72767. /**
  72768. * In 2d mode (needCube being false), the direction used to cast the shadow.
  72769. */
  72770. direction: Vector3;
  72771. /**
  72772. * The transformed position. Position of the light in world space taking parenting in account.
  72773. */
  72774. transformedPosition: Vector3;
  72775. /**
  72776. * The transformed direction. Direction of the light in world space taking parenting in account.
  72777. */
  72778. transformedDirection: Vector3;
  72779. /**
  72780. * The friendly name of the light in the scene.
  72781. */
  72782. name: string;
  72783. /**
  72784. * Defines the shadow projection clipping minimum z value.
  72785. */
  72786. shadowMinZ: number;
  72787. /**
  72788. * Defines the shadow projection clipping maximum z value.
  72789. */
  72790. shadowMaxZ: number;
  72791. /**
  72792. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  72793. * @returns true if the information has been computed, false if it does not need to (no parenting)
  72794. */
  72795. computeTransformedInformation(): boolean;
  72796. /**
  72797. * Gets the scene the light belongs to.
  72798. * @returns The scene
  72799. */
  72800. getScene(): Scene;
  72801. /**
  72802. * Callback defining a custom Projection Matrix Builder.
  72803. * This can be used to override the default projection matrix computation.
  72804. */
  72805. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  72806. /**
  72807. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  72808. * @param matrix The materix to updated with the projection information
  72809. * @param viewMatrix The transform matrix of the light
  72810. * @param renderList The list of mesh to render in the map
  72811. * @returns The current light
  72812. */
  72813. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  72814. /**
  72815. * Gets the current depth scale used in ESM.
  72816. * @returns The scale
  72817. */
  72818. getDepthScale(): number;
  72819. /**
  72820. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  72821. * @returns true if a cube texture needs to be use
  72822. */
  72823. needCube(): boolean;
  72824. /**
  72825. * Detects if the projection matrix requires to be recomputed this frame.
  72826. * @returns true if it requires to be recomputed otherwise, false.
  72827. */
  72828. needProjectionMatrixCompute(): boolean;
  72829. /**
  72830. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  72831. */
  72832. forceProjectionMatrixCompute(): void;
  72833. /**
  72834. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  72835. * @param faceIndex The index of the face we are computed the direction to generate shadow
  72836. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  72837. */
  72838. getShadowDirection(faceIndex?: number): Vector3;
  72839. /**
  72840. * Gets the minZ used for shadow according to both the scene and the light.
  72841. * @param activeCamera The camera we are returning the min for
  72842. * @returns the depth min z
  72843. */
  72844. getDepthMinZ(activeCamera: Camera): number;
  72845. /**
  72846. * Gets the maxZ used for shadow according to both the scene and the light.
  72847. * @param activeCamera The camera we are returning the max for
  72848. * @returns the depth max z
  72849. */
  72850. getDepthMaxZ(activeCamera: Camera): number;
  72851. }
  72852. /**
  72853. * Base implementation IShadowLight
  72854. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  72855. */
  72856. export abstract class ShadowLight extends Light implements IShadowLight {
  72857. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  72858. protected _position: Vector3;
  72859. protected _setPosition(value: Vector3): void;
  72860. /**
  72861. * Sets the position the shadow will be casted from. Also use as the light position for both
  72862. * point and spot lights.
  72863. */
  72864. /**
  72865. * Sets the position the shadow will be casted from. Also use as the light position for both
  72866. * point and spot lights.
  72867. */
  72868. position: Vector3;
  72869. protected _direction: Vector3;
  72870. protected _setDirection(value: Vector3): void;
  72871. /**
  72872. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  72873. * Also use as the light direction on spot and directional lights.
  72874. */
  72875. /**
  72876. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  72877. * Also use as the light direction on spot and directional lights.
  72878. */
  72879. direction: Vector3;
  72880. private _shadowMinZ;
  72881. /**
  72882. * Gets the shadow projection clipping minimum z value.
  72883. */
  72884. /**
  72885. * Sets the shadow projection clipping minimum z value.
  72886. */
  72887. shadowMinZ: number;
  72888. private _shadowMaxZ;
  72889. /**
  72890. * Sets the shadow projection clipping maximum z value.
  72891. */
  72892. /**
  72893. * Gets the shadow projection clipping maximum z value.
  72894. */
  72895. shadowMaxZ: number;
  72896. /**
  72897. * Callback defining a custom Projection Matrix Builder.
  72898. * This can be used to override the default projection matrix computation.
  72899. */
  72900. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  72901. /**
  72902. * The transformed position. Position of the light in world space taking parenting in account.
  72903. */
  72904. transformedPosition: Vector3;
  72905. /**
  72906. * The transformed direction. Direction of the light in world space taking parenting in account.
  72907. */
  72908. transformedDirection: Vector3;
  72909. private _needProjectionMatrixCompute;
  72910. /**
  72911. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  72912. * @returns true if the information has been computed, false if it does not need to (no parenting)
  72913. */
  72914. computeTransformedInformation(): boolean;
  72915. /**
  72916. * Return the depth scale used for the shadow map.
  72917. * @returns the depth scale.
  72918. */
  72919. getDepthScale(): number;
  72920. /**
  72921. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  72922. * @param faceIndex The index of the face we are computed the direction to generate shadow
  72923. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  72924. */
  72925. getShadowDirection(faceIndex?: number): Vector3;
  72926. /**
  72927. * Returns the ShadowLight absolute position in the World.
  72928. * @returns the position vector in world space
  72929. */
  72930. getAbsolutePosition(): Vector3;
  72931. /**
  72932. * Sets the ShadowLight direction toward the passed target.
  72933. * @param target The point to target in local space
  72934. * @returns the updated ShadowLight direction
  72935. */
  72936. setDirectionToTarget(target: Vector3): Vector3;
  72937. /**
  72938. * Returns the light rotation in euler definition.
  72939. * @returns the x y z rotation in local space.
  72940. */
  72941. getRotation(): Vector3;
  72942. /**
  72943. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  72944. * @returns true if a cube texture needs to be use
  72945. */
  72946. needCube(): boolean;
  72947. /**
  72948. * Detects if the projection matrix requires to be recomputed this frame.
  72949. * @returns true if it requires to be recomputed otherwise, false.
  72950. */
  72951. needProjectionMatrixCompute(): boolean;
  72952. /**
  72953. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  72954. */
  72955. forceProjectionMatrixCompute(): void;
  72956. /** @hidden */
  72957. _initCache(): void;
  72958. /** @hidden */
  72959. _isSynchronized(): boolean;
  72960. /**
  72961. * Computes the world matrix of the node
  72962. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  72963. * @returns the world matrix
  72964. */
  72965. computeWorldMatrix(force?: boolean): Matrix;
  72966. /**
  72967. * Gets the minZ used for shadow according to both the scene and the light.
  72968. * @param activeCamera The camera we are returning the min for
  72969. * @returns the depth min z
  72970. */
  72971. getDepthMinZ(activeCamera: Camera): number;
  72972. /**
  72973. * Gets the maxZ used for shadow according to both the scene and the light.
  72974. * @param activeCamera The camera we are returning the max for
  72975. * @returns the depth max z
  72976. */
  72977. getDepthMaxZ(activeCamera: Camera): number;
  72978. /**
  72979. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  72980. * @param matrix The materix to updated with the projection information
  72981. * @param viewMatrix The transform matrix of the light
  72982. * @param renderList The list of mesh to render in the map
  72983. * @returns The current light
  72984. */
  72985. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  72986. }
  72987. }
  72988. declare module BABYLON {
  72989. /**
  72990. * "Static Class" containing the most commonly used helper while dealing with material for
  72991. * rendering purpose.
  72992. *
  72993. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  72994. *
  72995. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  72996. */
  72997. export class MaterialHelper {
  72998. /**
  72999. * Bind the current view position to an effect.
  73000. * @param effect The effect to be bound
  73001. * @param scene The scene the eyes position is used from
  73002. */
  73003. static BindEyePosition(effect: Effect, scene: Scene): void;
  73004. /**
  73005. * Helps preparing the defines values about the UVs in used in the effect.
  73006. * UVs are shared as much as we can accross channels in the shaders.
  73007. * @param texture The texture we are preparing the UVs for
  73008. * @param defines The defines to update
  73009. * @param key The channel key "diffuse", "specular"... used in the shader
  73010. */
  73011. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  73012. /**
  73013. * Binds a texture matrix value to its corrsponding uniform
  73014. * @param texture The texture to bind the matrix for
  73015. * @param uniformBuffer The uniform buffer receivin the data
  73016. * @param key The channel key "diffuse", "specular"... used in the shader
  73017. */
  73018. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  73019. /**
  73020. * Gets the current status of the fog (should it be enabled?)
  73021. * @param mesh defines the mesh to evaluate for fog support
  73022. * @param scene defines the hosting scene
  73023. * @returns true if fog must be enabled
  73024. */
  73025. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  73026. /**
  73027. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  73028. * @param mesh defines the current mesh
  73029. * @param scene defines the current scene
  73030. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  73031. * @param pointsCloud defines if point cloud rendering has to be turned on
  73032. * @param fogEnabled defines if fog has to be turned on
  73033. * @param alphaTest defines if alpha testing has to be turned on
  73034. * @param defines defines the current list of defines
  73035. */
  73036. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  73037. /**
  73038. * Helper used to prepare the list of defines associated with frame values for shader compilation
  73039. * @param scene defines the current scene
  73040. * @param engine defines the current engine
  73041. * @param defines specifies the list of active defines
  73042. * @param useInstances defines if instances have to be turned on
  73043. * @param useClipPlane defines if clip plane have to be turned on
  73044. */
  73045. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  73046. /**
  73047. * Prepares the defines for bones
  73048. * @param mesh The mesh containing the geometry data we will draw
  73049. * @param defines The defines to update
  73050. */
  73051. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  73052. /**
  73053. * Prepares the defines for morph targets
  73054. * @param mesh The mesh containing the geometry data we will draw
  73055. * @param defines The defines to update
  73056. */
  73057. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  73058. /**
  73059. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  73060. * @param mesh The mesh containing the geometry data we will draw
  73061. * @param defines The defines to update
  73062. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  73063. * @param useBones Precise whether bones should be used or not (override mesh info)
  73064. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  73065. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  73066. * @returns false if defines are considered not dirty and have not been checked
  73067. */
  73068. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  73069. /**
  73070. * Prepares the defines related to multiview
  73071. * @param scene The scene we are intending to draw
  73072. * @param defines The defines to update
  73073. */
  73074. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  73075. /**
  73076. * Prepares the defines related to the light information passed in parameter
  73077. * @param scene The scene we are intending to draw
  73078. * @param mesh The mesh the effect is compiling for
  73079. * @param light The light the effect is compiling for
  73080. * @param lightIndex The index of the light
  73081. * @param defines The defines to update
  73082. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  73083. * @param state Defines the current state regarding what is needed (normals, etc...)
  73084. */
  73085. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  73086. needNormals: boolean;
  73087. needRebuild: boolean;
  73088. shadowEnabled: boolean;
  73089. specularEnabled: boolean;
  73090. lightmapMode: boolean;
  73091. }): void;
  73092. /**
  73093. * Prepares the defines related to the light information passed in parameter
  73094. * @param scene The scene we are intending to draw
  73095. * @param mesh The mesh the effect is compiling for
  73096. * @param defines The defines to update
  73097. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  73098. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  73099. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  73100. * @returns true if normals will be required for the rest of the effect
  73101. */
  73102. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  73103. /**
  73104. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  73105. * @param lightIndex defines the light index
  73106. * @param uniformsList The uniform list
  73107. * @param samplersList The sampler list
  73108. * @param projectedLightTexture defines if projected texture must be used
  73109. * @param uniformBuffersList defines an optional list of uniform buffers
  73110. */
  73111. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  73112. /**
  73113. * Prepares the uniforms and samplers list to be used in the effect
  73114. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  73115. * @param samplersList The sampler list
  73116. * @param defines The defines helping in the list generation
  73117. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  73118. */
  73119. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | EffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  73120. /**
  73121. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  73122. * @param defines The defines to update while falling back
  73123. * @param fallbacks The authorized effect fallbacks
  73124. * @param maxSimultaneousLights The maximum number of lights allowed
  73125. * @param rank the current rank of the Effect
  73126. * @returns The newly affected rank
  73127. */
  73128. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  73129. private static _TmpMorphInfluencers;
  73130. /**
  73131. * Prepares the list of attributes required for morph targets according to the effect defines.
  73132. * @param attribs The current list of supported attribs
  73133. * @param mesh The mesh to prepare the morph targets attributes for
  73134. * @param influencers The number of influencers
  73135. */
  73136. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  73137. /**
  73138. * Prepares the list of attributes required for morph targets according to the effect defines.
  73139. * @param attribs The current list of supported attribs
  73140. * @param mesh The mesh to prepare the morph targets attributes for
  73141. * @param defines The current Defines of the effect
  73142. */
  73143. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  73144. /**
  73145. * Prepares the list of attributes required for bones according to the effect defines.
  73146. * @param attribs The current list of supported attribs
  73147. * @param mesh The mesh to prepare the bones attributes for
  73148. * @param defines The current Defines of the effect
  73149. * @param fallbacks The current efffect fallback strategy
  73150. */
  73151. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  73152. /**
  73153. * Check and prepare the list of attributes required for instances according to the effect defines.
  73154. * @param attribs The current list of supported attribs
  73155. * @param defines The current MaterialDefines of the effect
  73156. */
  73157. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  73158. /**
  73159. * Add the list of attributes required for instances to the attribs array.
  73160. * @param attribs The current list of supported attribs
  73161. */
  73162. static PushAttributesForInstances(attribs: string[]): void;
  73163. /**
  73164. * Binds the light shadow information to the effect for the given mesh.
  73165. * @param light The light containing the generator
  73166. * @param scene The scene the lights belongs to
  73167. * @param mesh The mesh we are binding the information to render
  73168. * @param lightIndex The light index in the effect used to render the mesh
  73169. * @param effect The effect we are binding the data to
  73170. */
  73171. static BindLightShadow(light: Light, mesh: AbstractMesh, lightIndex: string, effect: Effect): void;
  73172. /**
  73173. * Binds the light information to the effect.
  73174. * @param light The light containing the generator
  73175. * @param effect The effect we are binding the data to
  73176. * @param lightIndex The light index in the effect used to render
  73177. */
  73178. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  73179. /**
  73180. * Binds the lights information from the scene to the effect for the given mesh.
  73181. * @param light Light to bind
  73182. * @param lightIndex Light index
  73183. * @param scene The scene where the light belongs to
  73184. * @param mesh The mesh we are binding the information to render
  73185. * @param effect The effect we are binding the data to
  73186. * @param useSpecular Defines if specular is supported
  73187. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  73188. */
  73189. static BindLight(light: Light, lightIndex: number, scene: Scene, mesh: AbstractMesh, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean): void;
  73190. /**
  73191. * Binds the lights information from the scene to the effect for the given mesh.
  73192. * @param scene The scene the lights belongs to
  73193. * @param mesh The mesh we are binding the information to render
  73194. * @param effect The effect we are binding the data to
  73195. * @param defines The generated defines for the effect
  73196. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  73197. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  73198. */
  73199. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean): void;
  73200. private static _tempFogColor;
  73201. /**
  73202. * Binds the fog information from the scene to the effect for the given mesh.
  73203. * @param scene The scene the lights belongs to
  73204. * @param mesh The mesh we are binding the information to render
  73205. * @param effect The effect we are binding the data to
  73206. * @param linearSpace Defines if the fog effect is applied in linear space
  73207. */
  73208. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  73209. /**
  73210. * Binds the bones information from the mesh to the effect.
  73211. * @param mesh The mesh we are binding the information to render
  73212. * @param effect The effect we are binding the data to
  73213. */
  73214. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  73215. /**
  73216. * Binds the morph targets information from the mesh to the effect.
  73217. * @param abstractMesh The mesh we are binding the information to render
  73218. * @param effect The effect we are binding the data to
  73219. */
  73220. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  73221. /**
  73222. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  73223. * @param defines The generated defines used in the effect
  73224. * @param effect The effect we are binding the data to
  73225. * @param scene The scene we are willing to render with logarithmic scale for
  73226. */
  73227. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  73228. /**
  73229. * Binds the clip plane information from the scene to the effect.
  73230. * @param scene The scene the clip plane information are extracted from
  73231. * @param effect The effect we are binding the data to
  73232. */
  73233. static BindClipPlane(effect: Effect, scene: Scene): void;
  73234. }
  73235. }
  73236. declare module BABYLON {
  73237. /** @hidden */
  73238. export var packingFunctions: {
  73239. name: string;
  73240. shader: string;
  73241. };
  73242. }
  73243. declare module BABYLON {
  73244. /** @hidden */
  73245. export var shadowMapPixelShader: {
  73246. name: string;
  73247. shader: string;
  73248. };
  73249. }
  73250. declare module BABYLON {
  73251. /** @hidden */
  73252. export var bonesDeclaration: {
  73253. name: string;
  73254. shader: string;
  73255. };
  73256. }
  73257. declare module BABYLON {
  73258. /** @hidden */
  73259. export var morphTargetsVertexGlobalDeclaration: {
  73260. name: string;
  73261. shader: string;
  73262. };
  73263. }
  73264. declare module BABYLON {
  73265. /** @hidden */
  73266. export var morphTargetsVertexDeclaration: {
  73267. name: string;
  73268. shader: string;
  73269. };
  73270. }
  73271. declare module BABYLON {
  73272. /** @hidden */
  73273. export var instancesDeclaration: {
  73274. name: string;
  73275. shader: string;
  73276. };
  73277. }
  73278. declare module BABYLON {
  73279. /** @hidden */
  73280. export var helperFunctions: {
  73281. name: string;
  73282. shader: string;
  73283. };
  73284. }
  73285. declare module BABYLON {
  73286. /** @hidden */
  73287. export var morphTargetsVertex: {
  73288. name: string;
  73289. shader: string;
  73290. };
  73291. }
  73292. declare module BABYLON {
  73293. /** @hidden */
  73294. export var instancesVertex: {
  73295. name: string;
  73296. shader: string;
  73297. };
  73298. }
  73299. declare module BABYLON {
  73300. /** @hidden */
  73301. export var bonesVertex: {
  73302. name: string;
  73303. shader: string;
  73304. };
  73305. }
  73306. declare module BABYLON {
  73307. /** @hidden */
  73308. export var shadowMapVertexShader: {
  73309. name: string;
  73310. shader: string;
  73311. };
  73312. }
  73313. declare module BABYLON {
  73314. /** @hidden */
  73315. export var depthBoxBlurPixelShader: {
  73316. name: string;
  73317. shader: string;
  73318. };
  73319. }
  73320. declare module BABYLON {
  73321. /**
  73322. * Defines the options associated with the creation of a custom shader for a shadow generator.
  73323. */
  73324. export interface ICustomShaderOptions {
  73325. /**
  73326. * Gets or sets the custom shader name to use
  73327. */
  73328. shaderName: string;
  73329. /**
  73330. * The list of attribute names used in the shader
  73331. */
  73332. attributes?: string[];
  73333. /**
  73334. * The list of unifrom names used in the shader
  73335. */
  73336. uniforms?: string[];
  73337. /**
  73338. * The list of sampler names used in the shader
  73339. */
  73340. samplers?: string[];
  73341. /**
  73342. * The list of defines used in the shader
  73343. */
  73344. defines?: string[];
  73345. }
  73346. /**
  73347. * Interface to implement to create a shadow generator compatible with BJS.
  73348. */
  73349. export interface IShadowGenerator {
  73350. /**
  73351. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  73352. * @returns The render target texture if present otherwise, null
  73353. */
  73354. getShadowMap(): Nullable<RenderTargetTexture>;
  73355. /**
  73356. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  73357. * @returns The render target texture if the shadow map is present otherwise, null
  73358. */
  73359. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  73360. /**
  73361. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  73362. * @param subMesh The submesh we want to render in the shadow map
  73363. * @param useInstances Defines wether will draw in the map using instances
  73364. * @returns true if ready otherwise, false
  73365. */
  73366. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73367. /**
  73368. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  73369. * @param defines Defines of the material we want to update
  73370. * @param lightIndex Index of the light in the enabled light list of the material
  73371. */
  73372. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  73373. /**
  73374. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  73375. * defined in the generator but impacting the effect).
  73376. * It implies the unifroms available on the materials are the standard BJS ones.
  73377. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  73378. * @param effect The effect we are binfing the information for
  73379. */
  73380. bindShadowLight(lightIndex: string, effect: Effect): void;
  73381. /**
  73382. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  73383. * (eq to shadow prjection matrix * light transform matrix)
  73384. * @returns The transform matrix used to create the shadow map
  73385. */
  73386. getTransformMatrix(): Matrix;
  73387. /**
  73388. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  73389. * Cube and 2D textures for instance.
  73390. */
  73391. recreateShadowMap(): void;
  73392. /**
  73393. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  73394. * @param onCompiled Callback triggered at the and of the effects compilation
  73395. * @param options Sets of optional options forcing the compilation with different modes
  73396. */
  73397. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  73398. useInstances: boolean;
  73399. }>): void;
  73400. /**
  73401. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  73402. * @param options Sets of optional options forcing the compilation with different modes
  73403. * @returns A promise that resolves when the compilation completes
  73404. */
  73405. forceCompilationAsync(options?: Partial<{
  73406. useInstances: boolean;
  73407. }>): Promise<void>;
  73408. /**
  73409. * Serializes the shadow generator setup to a json object.
  73410. * @returns The serialized JSON object
  73411. */
  73412. serialize(): any;
  73413. /**
  73414. * Disposes the Shadow map and related Textures and effects.
  73415. */
  73416. dispose(): void;
  73417. }
  73418. /**
  73419. * Default implementation IShadowGenerator.
  73420. * This is the main object responsible of generating shadows in the framework.
  73421. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  73422. */
  73423. export class ShadowGenerator implements IShadowGenerator {
  73424. /**
  73425. * Shadow generator mode None: no filtering applied.
  73426. */
  73427. static readonly FILTER_NONE: number;
  73428. /**
  73429. * Shadow generator mode ESM: Exponential Shadow Mapping.
  73430. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  73431. */
  73432. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  73433. /**
  73434. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  73435. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  73436. */
  73437. static readonly FILTER_POISSONSAMPLING: number;
  73438. /**
  73439. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  73440. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  73441. */
  73442. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  73443. /**
  73444. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  73445. * edge artifacts on steep falloff.
  73446. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  73447. */
  73448. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  73449. /**
  73450. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  73451. * edge artifacts on steep falloff.
  73452. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  73453. */
  73454. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  73455. /**
  73456. * Shadow generator mode PCF: Percentage Closer Filtering
  73457. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  73458. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  73459. */
  73460. static readonly FILTER_PCF: number;
  73461. /**
  73462. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  73463. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  73464. * Contact Hardening
  73465. */
  73466. static readonly FILTER_PCSS: number;
  73467. /**
  73468. * Reserved for PCF and PCSS
  73469. * Highest Quality.
  73470. *
  73471. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  73472. *
  73473. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  73474. */
  73475. static readonly QUALITY_HIGH: number;
  73476. /**
  73477. * Reserved for PCF and PCSS
  73478. * Good tradeoff for quality/perf cross devices
  73479. *
  73480. * Execute PCF on a 3*3 kernel.
  73481. *
  73482. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  73483. */
  73484. static readonly QUALITY_MEDIUM: number;
  73485. /**
  73486. * Reserved for PCF and PCSS
  73487. * The lowest quality but the fastest.
  73488. *
  73489. * Execute PCF on a 1*1 kernel.
  73490. *
  73491. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  73492. */
  73493. static readonly QUALITY_LOW: number;
  73494. /** Gets or sets the custom shader name to use */
  73495. customShaderOptions: ICustomShaderOptions;
  73496. /**
  73497. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  73498. */
  73499. onBeforeShadowMapRenderObservable: Observable<Effect>;
  73500. /**
  73501. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  73502. */
  73503. onAfterShadowMapRenderObservable: Observable<Effect>;
  73504. /**
  73505. * Observable triggered before a mesh is rendered in the shadow map.
  73506. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  73507. */
  73508. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  73509. /**
  73510. * Observable triggered after a mesh is rendered in the shadow map.
  73511. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  73512. */
  73513. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  73514. private _bias;
  73515. /**
  73516. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  73517. */
  73518. /**
  73519. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  73520. */
  73521. bias: number;
  73522. private _normalBias;
  73523. /**
  73524. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  73525. */
  73526. /**
  73527. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  73528. */
  73529. normalBias: number;
  73530. private _blurBoxOffset;
  73531. /**
  73532. * Gets the blur box offset: offset applied during the blur pass.
  73533. * Only useful if useKernelBlur = false
  73534. */
  73535. /**
  73536. * Sets the blur box offset: offset applied during the blur pass.
  73537. * Only useful if useKernelBlur = false
  73538. */
  73539. blurBoxOffset: number;
  73540. private _blurScale;
  73541. /**
  73542. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  73543. * 2 means half of the size.
  73544. */
  73545. /**
  73546. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  73547. * 2 means half of the size.
  73548. */
  73549. blurScale: number;
  73550. private _blurKernel;
  73551. /**
  73552. * Gets the blur kernel: kernel size of the blur pass.
  73553. * Only useful if useKernelBlur = true
  73554. */
  73555. /**
  73556. * Sets the blur kernel: kernel size of the blur pass.
  73557. * Only useful if useKernelBlur = true
  73558. */
  73559. blurKernel: number;
  73560. private _useKernelBlur;
  73561. /**
  73562. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  73563. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  73564. */
  73565. /**
  73566. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  73567. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  73568. */
  73569. useKernelBlur: boolean;
  73570. private _depthScale;
  73571. /**
  73572. * Gets the depth scale used in ESM mode.
  73573. */
  73574. /**
  73575. * Sets the depth scale used in ESM mode.
  73576. * This can override the scale stored on the light.
  73577. */
  73578. depthScale: number;
  73579. private _filter;
  73580. /**
  73581. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  73582. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  73583. */
  73584. /**
  73585. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  73586. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  73587. */
  73588. filter: number;
  73589. /**
  73590. * Gets if the current filter is set to Poisson Sampling.
  73591. */
  73592. /**
  73593. * Sets the current filter to Poisson Sampling.
  73594. */
  73595. usePoissonSampling: boolean;
  73596. /**
  73597. * Gets if the current filter is set to ESM.
  73598. */
  73599. /**
  73600. * Sets the current filter is to ESM.
  73601. */
  73602. useExponentialShadowMap: boolean;
  73603. /**
  73604. * Gets if the current filter is set to filtered ESM.
  73605. */
  73606. /**
  73607. * Gets if the current filter is set to filtered ESM.
  73608. */
  73609. useBlurExponentialShadowMap: boolean;
  73610. /**
  73611. * Gets if the current filter is set to "close ESM" (using the inverse of the
  73612. * exponential to prevent steep falloff artifacts).
  73613. */
  73614. /**
  73615. * Sets the current filter to "close ESM" (using the inverse of the
  73616. * exponential to prevent steep falloff artifacts).
  73617. */
  73618. useCloseExponentialShadowMap: boolean;
  73619. /**
  73620. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  73621. * exponential to prevent steep falloff artifacts).
  73622. */
  73623. /**
  73624. * Sets the current filter to filtered "close ESM" (using the inverse of the
  73625. * exponential to prevent steep falloff artifacts).
  73626. */
  73627. useBlurCloseExponentialShadowMap: boolean;
  73628. /**
  73629. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  73630. */
  73631. /**
  73632. * Sets the current filter to "PCF" (percentage closer filtering).
  73633. */
  73634. usePercentageCloserFiltering: boolean;
  73635. private _filteringQuality;
  73636. /**
  73637. * Gets the PCF or PCSS Quality.
  73638. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  73639. */
  73640. /**
  73641. * Sets the PCF or PCSS Quality.
  73642. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  73643. */
  73644. filteringQuality: number;
  73645. /**
  73646. * Gets if the current filter is set to "PCSS" (contact hardening).
  73647. */
  73648. /**
  73649. * Sets the current filter to "PCSS" (contact hardening).
  73650. */
  73651. useContactHardeningShadow: boolean;
  73652. private _contactHardeningLightSizeUVRatio;
  73653. /**
  73654. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  73655. * Using a ratio helps keeping shape stability independently of the map size.
  73656. *
  73657. * It does not account for the light projection as it was having too much
  73658. * instability during the light setup or during light position changes.
  73659. *
  73660. * Only valid if useContactHardeningShadow is true.
  73661. */
  73662. /**
  73663. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  73664. * Using a ratio helps keeping shape stability independently of the map size.
  73665. *
  73666. * It does not account for the light projection as it was having too much
  73667. * instability during the light setup or during light position changes.
  73668. *
  73669. * Only valid if useContactHardeningShadow is true.
  73670. */
  73671. contactHardeningLightSizeUVRatio: number;
  73672. private _darkness;
  73673. /** Gets or sets the actual darkness of a shadow */
  73674. darkness: number;
  73675. /**
  73676. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  73677. * 0 means strongest and 1 would means no shadow.
  73678. * @returns the darkness.
  73679. */
  73680. getDarkness(): number;
  73681. /**
  73682. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  73683. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  73684. * @returns the shadow generator allowing fluent coding.
  73685. */
  73686. setDarkness(darkness: number): ShadowGenerator;
  73687. private _transparencyShadow;
  73688. /** Gets or sets the ability to have transparent shadow */
  73689. transparencyShadow: boolean;
  73690. /**
  73691. * Sets the ability to have transparent shadow (boolean).
  73692. * @param transparent True if transparent else False
  73693. * @returns the shadow generator allowing fluent coding
  73694. */
  73695. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  73696. private _shadowMap;
  73697. private _shadowMap2;
  73698. /**
  73699. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  73700. * @returns The render target texture if present otherwise, null
  73701. */
  73702. getShadowMap(): Nullable<RenderTargetTexture>;
  73703. /**
  73704. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  73705. * @returns The render target texture if the shadow map is present otherwise, null
  73706. */
  73707. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  73708. /**
  73709. * Gets the class name of that object
  73710. * @returns "ShadowGenerator"
  73711. */
  73712. getClassName(): string;
  73713. /**
  73714. * Helper function to add a mesh and its descendants to the list of shadow casters.
  73715. * @param mesh Mesh to add
  73716. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  73717. * @returns the Shadow Generator itself
  73718. */
  73719. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  73720. /**
  73721. * Helper function to remove a mesh and its descendants from the list of shadow casters
  73722. * @param mesh Mesh to remove
  73723. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  73724. * @returns the Shadow Generator itself
  73725. */
  73726. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  73727. /**
  73728. * Controls the extent to which the shadows fade out at the edge of the frustum
  73729. * Used only by directionals and spots
  73730. */
  73731. frustumEdgeFalloff: number;
  73732. private _light;
  73733. /**
  73734. * Returns the associated light object.
  73735. * @returns the light generating the shadow
  73736. */
  73737. getLight(): IShadowLight;
  73738. /**
  73739. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  73740. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  73741. * It might on the other hand introduce peter panning.
  73742. */
  73743. forceBackFacesOnly: boolean;
  73744. private _scene;
  73745. private _lightDirection;
  73746. private _effect;
  73747. private _viewMatrix;
  73748. private _projectionMatrix;
  73749. private _transformMatrix;
  73750. private _cachedPosition;
  73751. private _cachedDirection;
  73752. private _cachedDefines;
  73753. private _currentRenderID;
  73754. private _boxBlurPostprocess;
  73755. private _kernelBlurXPostprocess;
  73756. private _kernelBlurYPostprocess;
  73757. private _blurPostProcesses;
  73758. private _mapSize;
  73759. private _currentFaceIndex;
  73760. private _currentFaceIndexCache;
  73761. private _textureType;
  73762. private _defaultTextureMatrix;
  73763. /** @hidden */
  73764. static _SceneComponentInitialization: (scene: Scene) => void;
  73765. /**
  73766. * Creates a ShadowGenerator object.
  73767. * A ShadowGenerator is the required tool to use the shadows.
  73768. * Each light casting shadows needs to use its own ShadowGenerator.
  73769. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  73770. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  73771. * @param light The light object generating the shadows.
  73772. * @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.
  73773. */
  73774. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  73775. private _initializeGenerator;
  73776. private _initializeShadowMap;
  73777. private _initializeBlurRTTAndPostProcesses;
  73778. private _renderForShadowMap;
  73779. private _renderSubMeshForShadowMap;
  73780. private _applyFilterValues;
  73781. /**
  73782. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  73783. * @param onCompiled Callback triggered at the and of the effects compilation
  73784. * @param options Sets of optional options forcing the compilation with different modes
  73785. */
  73786. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  73787. useInstances: boolean;
  73788. }>): void;
  73789. /**
  73790. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  73791. * @param options Sets of optional options forcing the compilation with different modes
  73792. * @returns A promise that resolves when the compilation completes
  73793. */
  73794. forceCompilationAsync(options?: Partial<{
  73795. useInstances: boolean;
  73796. }>): Promise<void>;
  73797. /**
  73798. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  73799. * @param subMesh The submesh we want to render in the shadow map
  73800. * @param useInstances Defines wether will draw in the map using instances
  73801. * @returns true if ready otherwise, false
  73802. */
  73803. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73804. /**
  73805. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  73806. * @param defines Defines of the material we want to update
  73807. * @param lightIndex Index of the light in the enabled light list of the material
  73808. */
  73809. prepareDefines(defines: any, lightIndex: number): void;
  73810. /**
  73811. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  73812. * defined in the generator but impacting the effect).
  73813. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  73814. * @param effect The effect we are binfing the information for
  73815. */
  73816. bindShadowLight(lightIndex: string, effect: Effect): void;
  73817. /**
  73818. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  73819. * (eq to shadow prjection matrix * light transform matrix)
  73820. * @returns The transform matrix used to create the shadow map
  73821. */
  73822. getTransformMatrix(): Matrix;
  73823. /**
  73824. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  73825. * Cube and 2D textures for instance.
  73826. */
  73827. recreateShadowMap(): void;
  73828. private _disposeBlurPostProcesses;
  73829. private _disposeRTTandPostProcesses;
  73830. /**
  73831. * Disposes the ShadowGenerator.
  73832. * Returns nothing.
  73833. */
  73834. dispose(): void;
  73835. /**
  73836. * Serializes the shadow generator setup to a json object.
  73837. * @returns The serialized JSON object
  73838. */
  73839. serialize(): any;
  73840. /**
  73841. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  73842. * @param parsedShadowGenerator The JSON object to parse
  73843. * @param scene The scene to create the shadow map for
  73844. * @returns The parsed shadow generator
  73845. */
  73846. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  73847. }
  73848. }
  73849. declare module BABYLON {
  73850. /**
  73851. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  73852. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  73853. * 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.
  73854. */
  73855. export abstract class Light extends Node {
  73856. /**
  73857. * Falloff Default: light is falling off following the material specification:
  73858. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  73859. */
  73860. static readonly FALLOFF_DEFAULT: number;
  73861. /**
  73862. * Falloff Physical: light is falling off following the inverse squared distance law.
  73863. */
  73864. static readonly FALLOFF_PHYSICAL: number;
  73865. /**
  73866. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  73867. * to enhance interoperability with other engines.
  73868. */
  73869. static readonly FALLOFF_GLTF: number;
  73870. /**
  73871. * Falloff Standard: light is falling off like in the standard material
  73872. * to enhance interoperability with other materials.
  73873. */
  73874. static readonly FALLOFF_STANDARD: number;
  73875. /**
  73876. * If every light affecting the material is in this lightmapMode,
  73877. * material.lightmapTexture adds or multiplies
  73878. * (depends on material.useLightmapAsShadowmap)
  73879. * after every other light calculations.
  73880. */
  73881. static readonly LIGHTMAP_DEFAULT: number;
  73882. /**
  73883. * material.lightmapTexture as only diffuse lighting from this light
  73884. * adds only specular lighting from this light
  73885. * adds dynamic shadows
  73886. */
  73887. static readonly LIGHTMAP_SPECULAR: number;
  73888. /**
  73889. * material.lightmapTexture as only lighting
  73890. * no light calculation from this light
  73891. * only adds dynamic shadows from this light
  73892. */
  73893. static readonly LIGHTMAP_SHADOWSONLY: number;
  73894. /**
  73895. * Each light type uses the default quantity according to its type:
  73896. * point/spot lights use luminous intensity
  73897. * directional lights use illuminance
  73898. */
  73899. static readonly INTENSITYMODE_AUTOMATIC: number;
  73900. /**
  73901. * lumen (lm)
  73902. */
  73903. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  73904. /**
  73905. * candela (lm/sr)
  73906. */
  73907. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  73908. /**
  73909. * lux (lm/m^2)
  73910. */
  73911. static readonly INTENSITYMODE_ILLUMINANCE: number;
  73912. /**
  73913. * nit (cd/m^2)
  73914. */
  73915. static readonly INTENSITYMODE_LUMINANCE: number;
  73916. /**
  73917. * Light type const id of the point light.
  73918. */
  73919. static readonly LIGHTTYPEID_POINTLIGHT: number;
  73920. /**
  73921. * Light type const id of the directional light.
  73922. */
  73923. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  73924. /**
  73925. * Light type const id of the spot light.
  73926. */
  73927. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  73928. /**
  73929. * Light type const id of the hemispheric light.
  73930. */
  73931. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  73932. /**
  73933. * Diffuse gives the basic color to an object.
  73934. */
  73935. diffuse: Color3;
  73936. /**
  73937. * Specular produces a highlight color on an object.
  73938. * Note: This is note affecting PBR materials.
  73939. */
  73940. specular: Color3;
  73941. /**
  73942. * Defines the falloff type for this light. This lets overrriding how punctual light are
  73943. * falling off base on range or angle.
  73944. * This can be set to any values in Light.FALLOFF_x.
  73945. *
  73946. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  73947. * other types of materials.
  73948. */
  73949. falloffType: number;
  73950. /**
  73951. * Strength of the light.
  73952. * Note: By default it is define in the framework own unit.
  73953. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  73954. */
  73955. intensity: number;
  73956. private _range;
  73957. protected _inverseSquaredRange: number;
  73958. /**
  73959. * Defines how far from the source the light is impacting in scene units.
  73960. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  73961. */
  73962. /**
  73963. * Defines how far from the source the light is impacting in scene units.
  73964. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  73965. */
  73966. range: number;
  73967. /**
  73968. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  73969. * of light.
  73970. */
  73971. private _photometricScale;
  73972. private _intensityMode;
  73973. /**
  73974. * Gets the photometric scale used to interpret the intensity.
  73975. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  73976. */
  73977. /**
  73978. * Sets the photometric scale used to interpret the intensity.
  73979. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  73980. */
  73981. intensityMode: number;
  73982. private _radius;
  73983. /**
  73984. * Gets the light radius used by PBR Materials to simulate soft area lights.
  73985. */
  73986. /**
  73987. * sets the light radius used by PBR Materials to simulate soft area lights.
  73988. */
  73989. radius: number;
  73990. private _renderPriority;
  73991. /**
  73992. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  73993. * exceeding the number allowed of the materials.
  73994. */
  73995. renderPriority: number;
  73996. private _shadowEnabled;
  73997. /**
  73998. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  73999. * the current shadow generator.
  74000. */
  74001. /**
  74002. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  74003. * the current shadow generator.
  74004. */
  74005. shadowEnabled: boolean;
  74006. private _includedOnlyMeshes;
  74007. /**
  74008. * Gets the only meshes impacted by this light.
  74009. */
  74010. /**
  74011. * Sets the only meshes impacted by this light.
  74012. */
  74013. includedOnlyMeshes: AbstractMesh[];
  74014. private _excludedMeshes;
  74015. /**
  74016. * Gets the meshes not impacted by this light.
  74017. */
  74018. /**
  74019. * Sets the meshes not impacted by this light.
  74020. */
  74021. excludedMeshes: AbstractMesh[];
  74022. private _excludeWithLayerMask;
  74023. /**
  74024. * Gets the layer id use to find what meshes are not impacted by the light.
  74025. * Inactive if 0
  74026. */
  74027. /**
  74028. * Sets the layer id use to find what meshes are not impacted by the light.
  74029. * Inactive if 0
  74030. */
  74031. excludeWithLayerMask: number;
  74032. private _includeOnlyWithLayerMask;
  74033. /**
  74034. * Gets the layer id use to find what meshes are impacted by the light.
  74035. * Inactive if 0
  74036. */
  74037. /**
  74038. * Sets the layer id use to find what meshes are impacted by the light.
  74039. * Inactive if 0
  74040. */
  74041. includeOnlyWithLayerMask: number;
  74042. private _lightmapMode;
  74043. /**
  74044. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  74045. */
  74046. /**
  74047. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  74048. */
  74049. lightmapMode: number;
  74050. /**
  74051. * Shadow generator associted to the light.
  74052. * @hidden Internal use only.
  74053. */
  74054. _shadowGenerator: Nullable<IShadowGenerator>;
  74055. /**
  74056. * @hidden Internal use only.
  74057. */
  74058. _excludedMeshesIds: string[];
  74059. /**
  74060. * @hidden Internal use only.
  74061. */
  74062. _includedOnlyMeshesIds: string[];
  74063. /**
  74064. * The current light unifom buffer.
  74065. * @hidden Internal use only.
  74066. */
  74067. _uniformBuffer: UniformBuffer;
  74068. /**
  74069. * Creates a Light object in the scene.
  74070. * Documentation : https://doc.babylonjs.com/babylon101/lights
  74071. * @param name The firendly name of the light
  74072. * @param scene The scene the light belongs too
  74073. */
  74074. constructor(name: string, scene: Scene);
  74075. protected abstract _buildUniformLayout(): void;
  74076. /**
  74077. * Sets the passed Effect "effect" with the Light information.
  74078. * @param effect The effect to update
  74079. * @param lightIndex The index of the light in the effect to update
  74080. * @returns The light
  74081. */
  74082. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  74083. /**
  74084. * Returns the string "Light".
  74085. * @returns the class name
  74086. */
  74087. getClassName(): string;
  74088. /** @hidden */
  74089. readonly _isLight: boolean;
  74090. /**
  74091. * Converts the light information to a readable string for debug purpose.
  74092. * @param fullDetails Supports for multiple levels of logging within scene loading
  74093. * @returns the human readable light info
  74094. */
  74095. toString(fullDetails?: boolean): string;
  74096. /** @hidden */
  74097. protected _syncParentEnabledState(): void;
  74098. /**
  74099. * Set the enabled state of this node.
  74100. * @param value - the new enabled state
  74101. */
  74102. setEnabled(value: boolean): void;
  74103. /**
  74104. * Returns the Light associated shadow generator if any.
  74105. * @return the associated shadow generator.
  74106. */
  74107. getShadowGenerator(): Nullable<IShadowGenerator>;
  74108. /**
  74109. * Returns a Vector3, the absolute light position in the World.
  74110. * @returns the world space position of the light
  74111. */
  74112. getAbsolutePosition(): Vector3;
  74113. /**
  74114. * Specifies if the light will affect the passed mesh.
  74115. * @param mesh The mesh to test against the light
  74116. * @return true the mesh is affected otherwise, false.
  74117. */
  74118. canAffectMesh(mesh: AbstractMesh): boolean;
  74119. /**
  74120. * Sort function to order lights for rendering.
  74121. * @param a First Light object to compare to second.
  74122. * @param b Second Light object to compare first.
  74123. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  74124. */
  74125. static CompareLightsPriority(a: Light, b: Light): number;
  74126. /**
  74127. * Releases resources associated with this node.
  74128. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  74129. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  74130. */
  74131. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  74132. /**
  74133. * Returns the light type ID (integer).
  74134. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  74135. */
  74136. getTypeID(): number;
  74137. /**
  74138. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  74139. * @returns the scaled intensity in intensity mode unit
  74140. */
  74141. getScaledIntensity(): number;
  74142. /**
  74143. * Returns a new Light object, named "name", from the current one.
  74144. * @param name The name of the cloned light
  74145. * @returns the new created light
  74146. */
  74147. clone(name: string): Nullable<Light>;
  74148. /**
  74149. * Serializes the current light into a Serialization object.
  74150. * @returns the serialized object.
  74151. */
  74152. serialize(): any;
  74153. /**
  74154. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  74155. * This new light is named "name" and added to the passed scene.
  74156. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  74157. * @param name The friendly name of the light
  74158. * @param scene The scene the new light will belong to
  74159. * @returns the constructor function
  74160. */
  74161. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  74162. /**
  74163. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  74164. * @param parsedLight The JSON representation of the light
  74165. * @param scene The scene to create the parsed light in
  74166. * @returns the created light after parsing
  74167. */
  74168. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  74169. private _hookArrayForExcluded;
  74170. private _hookArrayForIncludedOnly;
  74171. private _resyncMeshes;
  74172. /**
  74173. * Forces the meshes to update their light related information in their rendering used effects
  74174. * @hidden Internal Use Only
  74175. */
  74176. _markMeshesAsLightDirty(): void;
  74177. /**
  74178. * Recomputes the cached photometric scale if needed.
  74179. */
  74180. private _computePhotometricScale;
  74181. /**
  74182. * Returns the Photometric Scale according to the light type and intensity mode.
  74183. */
  74184. private _getPhotometricScale;
  74185. /**
  74186. * Reorder the light in the scene according to their defined priority.
  74187. * @hidden Internal Use Only
  74188. */
  74189. _reorderLightsInScene(): void;
  74190. /**
  74191. * Prepares the list of defines specific to the light type.
  74192. * @param defines the list of defines
  74193. * @param lightIndex defines the index of the light for the effect
  74194. */
  74195. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  74196. }
  74197. }
  74198. declare module BABYLON {
  74199. /**
  74200. * Interface used to define Action
  74201. */
  74202. export interface IAction {
  74203. /**
  74204. * Trigger for the action
  74205. */
  74206. trigger: number;
  74207. /** Options of the trigger */
  74208. triggerOptions: any;
  74209. /**
  74210. * Gets the trigger parameters
  74211. * @returns the trigger parameters
  74212. */
  74213. getTriggerParameter(): any;
  74214. /**
  74215. * Internal only - executes current action event
  74216. * @hidden
  74217. */
  74218. _executeCurrent(evt?: ActionEvent): void;
  74219. /**
  74220. * Serialize placeholder for child classes
  74221. * @param parent of child
  74222. * @returns the serialized object
  74223. */
  74224. serialize(parent: any): any;
  74225. /**
  74226. * Internal only
  74227. * @hidden
  74228. */
  74229. _prepare(): void;
  74230. /**
  74231. * Internal only - manager for action
  74232. * @hidden
  74233. */
  74234. _actionManager: AbstractActionManager;
  74235. /**
  74236. * Adds action to chain of actions, may be a DoNothingAction
  74237. * @param action defines the next action to execute
  74238. * @returns The action passed in
  74239. * @see https://www.babylonjs-playground.com/#1T30HR#0
  74240. */
  74241. then(action: IAction): IAction;
  74242. }
  74243. /**
  74244. * The action to be carried out following a trigger
  74245. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  74246. */
  74247. export class Action implements IAction {
  74248. /** the trigger, with or without parameters, for the action */
  74249. triggerOptions: any;
  74250. /**
  74251. * Trigger for the action
  74252. */
  74253. trigger: number;
  74254. /**
  74255. * Internal only - manager for action
  74256. * @hidden
  74257. */
  74258. _actionManager: ActionManager;
  74259. private _nextActiveAction;
  74260. private _child;
  74261. private _condition?;
  74262. private _triggerParameter;
  74263. /**
  74264. * An event triggered prior to action being executed.
  74265. */
  74266. onBeforeExecuteObservable: Observable<Action>;
  74267. /**
  74268. * Creates a new Action
  74269. * @param triggerOptions the trigger, with or without parameters, for the action
  74270. * @param condition an optional determinant of action
  74271. */
  74272. constructor(
  74273. /** the trigger, with or without parameters, for the action */
  74274. triggerOptions: any, condition?: Condition);
  74275. /**
  74276. * Internal only
  74277. * @hidden
  74278. */
  74279. _prepare(): void;
  74280. /**
  74281. * Gets the trigger parameters
  74282. * @returns the trigger parameters
  74283. */
  74284. getTriggerParameter(): any;
  74285. /**
  74286. * Internal only - executes current action event
  74287. * @hidden
  74288. */
  74289. _executeCurrent(evt?: ActionEvent): void;
  74290. /**
  74291. * Execute placeholder for child classes
  74292. * @param evt optional action event
  74293. */
  74294. execute(evt?: ActionEvent): void;
  74295. /**
  74296. * Skips to next active action
  74297. */
  74298. skipToNextActiveAction(): void;
  74299. /**
  74300. * Adds action to chain of actions, may be a DoNothingAction
  74301. * @param action defines the next action to execute
  74302. * @returns The action passed in
  74303. * @see https://www.babylonjs-playground.com/#1T30HR#0
  74304. */
  74305. then(action: Action): Action;
  74306. /**
  74307. * Internal only
  74308. * @hidden
  74309. */
  74310. _getProperty(propertyPath: string): string;
  74311. /**
  74312. * Internal only
  74313. * @hidden
  74314. */
  74315. _getEffectiveTarget(target: any, propertyPath: string): any;
  74316. /**
  74317. * Serialize placeholder for child classes
  74318. * @param parent of child
  74319. * @returns the serialized object
  74320. */
  74321. serialize(parent: any): any;
  74322. /**
  74323. * Internal only called by serialize
  74324. * @hidden
  74325. */
  74326. protected _serialize(serializedAction: any, parent?: any): any;
  74327. /**
  74328. * Internal only
  74329. * @hidden
  74330. */
  74331. static _SerializeValueAsString: (value: any) => string;
  74332. /**
  74333. * Internal only
  74334. * @hidden
  74335. */
  74336. static _GetTargetProperty: (target: Node | Scene) => {
  74337. name: string;
  74338. targetType: string;
  74339. value: string;
  74340. };
  74341. }
  74342. }
  74343. declare module BABYLON {
  74344. /**
  74345. * A Condition applied to an Action
  74346. */
  74347. export class Condition {
  74348. /**
  74349. * Internal only - manager for action
  74350. * @hidden
  74351. */
  74352. _actionManager: ActionManager;
  74353. /**
  74354. * Internal only
  74355. * @hidden
  74356. */
  74357. _evaluationId: number;
  74358. /**
  74359. * Internal only
  74360. * @hidden
  74361. */
  74362. _currentResult: boolean;
  74363. /**
  74364. * Creates a new Condition
  74365. * @param actionManager the manager of the action the condition is applied to
  74366. */
  74367. constructor(actionManager: ActionManager);
  74368. /**
  74369. * Check if the current condition is valid
  74370. * @returns a boolean
  74371. */
  74372. isValid(): boolean;
  74373. /**
  74374. * Internal only
  74375. * @hidden
  74376. */
  74377. _getProperty(propertyPath: string): string;
  74378. /**
  74379. * Internal only
  74380. * @hidden
  74381. */
  74382. _getEffectiveTarget(target: any, propertyPath: string): any;
  74383. /**
  74384. * Serialize placeholder for child classes
  74385. * @returns the serialized object
  74386. */
  74387. serialize(): any;
  74388. /**
  74389. * Internal only
  74390. * @hidden
  74391. */
  74392. protected _serialize(serializedCondition: any): any;
  74393. }
  74394. /**
  74395. * Defines specific conditional operators as extensions of Condition
  74396. */
  74397. export class ValueCondition extends Condition {
  74398. /** path to specify the property of the target the conditional operator uses */
  74399. propertyPath: string;
  74400. /** the value compared by the conditional operator against the current value of the property */
  74401. value: any;
  74402. /** the conditional operator, default ValueCondition.IsEqual */
  74403. operator: number;
  74404. /**
  74405. * Internal only
  74406. * @hidden
  74407. */
  74408. private static _IsEqual;
  74409. /**
  74410. * Internal only
  74411. * @hidden
  74412. */
  74413. private static _IsDifferent;
  74414. /**
  74415. * Internal only
  74416. * @hidden
  74417. */
  74418. private static _IsGreater;
  74419. /**
  74420. * Internal only
  74421. * @hidden
  74422. */
  74423. private static _IsLesser;
  74424. /**
  74425. * returns the number for IsEqual
  74426. */
  74427. static readonly IsEqual: number;
  74428. /**
  74429. * Returns the number for IsDifferent
  74430. */
  74431. static readonly IsDifferent: number;
  74432. /**
  74433. * Returns the number for IsGreater
  74434. */
  74435. static readonly IsGreater: number;
  74436. /**
  74437. * Returns the number for IsLesser
  74438. */
  74439. static readonly IsLesser: number;
  74440. /**
  74441. * Internal only The action manager for the condition
  74442. * @hidden
  74443. */
  74444. _actionManager: ActionManager;
  74445. /**
  74446. * Internal only
  74447. * @hidden
  74448. */
  74449. private _target;
  74450. /**
  74451. * Internal only
  74452. * @hidden
  74453. */
  74454. private _effectiveTarget;
  74455. /**
  74456. * Internal only
  74457. * @hidden
  74458. */
  74459. private _property;
  74460. /**
  74461. * Creates a new ValueCondition
  74462. * @param actionManager manager for the action the condition applies to
  74463. * @param target for the action
  74464. * @param propertyPath path to specify the property of the target the conditional operator uses
  74465. * @param value the value compared by the conditional operator against the current value of the property
  74466. * @param operator the conditional operator, default ValueCondition.IsEqual
  74467. */
  74468. constructor(actionManager: ActionManager, target: any,
  74469. /** path to specify the property of the target the conditional operator uses */
  74470. propertyPath: string,
  74471. /** the value compared by the conditional operator against the current value of the property */
  74472. value: any,
  74473. /** the conditional operator, default ValueCondition.IsEqual */
  74474. operator?: number);
  74475. /**
  74476. * Compares the given value with the property value for the specified conditional operator
  74477. * @returns the result of the comparison
  74478. */
  74479. isValid(): boolean;
  74480. /**
  74481. * Serialize the ValueCondition into a JSON compatible object
  74482. * @returns serialization object
  74483. */
  74484. serialize(): any;
  74485. /**
  74486. * Gets the name of the conditional operator for the ValueCondition
  74487. * @param operator the conditional operator
  74488. * @returns the name
  74489. */
  74490. static GetOperatorName(operator: number): string;
  74491. }
  74492. /**
  74493. * Defines a predicate condition as an extension of Condition
  74494. */
  74495. export class PredicateCondition extends Condition {
  74496. /** defines the predicate function used to validate the condition */
  74497. predicate: () => boolean;
  74498. /**
  74499. * Internal only - manager for action
  74500. * @hidden
  74501. */
  74502. _actionManager: ActionManager;
  74503. /**
  74504. * Creates a new PredicateCondition
  74505. * @param actionManager manager for the action the condition applies to
  74506. * @param predicate defines the predicate function used to validate the condition
  74507. */
  74508. constructor(actionManager: ActionManager,
  74509. /** defines the predicate function used to validate the condition */
  74510. predicate: () => boolean);
  74511. /**
  74512. * @returns the validity of the predicate condition
  74513. */
  74514. isValid(): boolean;
  74515. }
  74516. /**
  74517. * Defines a state condition as an extension of Condition
  74518. */
  74519. export class StateCondition extends Condition {
  74520. /** Value to compare with target state */
  74521. value: string;
  74522. /**
  74523. * Internal only - manager for action
  74524. * @hidden
  74525. */
  74526. _actionManager: ActionManager;
  74527. /**
  74528. * Internal only
  74529. * @hidden
  74530. */
  74531. private _target;
  74532. /**
  74533. * Creates a new StateCondition
  74534. * @param actionManager manager for the action the condition applies to
  74535. * @param target of the condition
  74536. * @param value to compare with target state
  74537. */
  74538. constructor(actionManager: ActionManager, target: any,
  74539. /** Value to compare with target state */
  74540. value: string);
  74541. /**
  74542. * Gets a boolean indicating if the current condition is met
  74543. * @returns the validity of the state
  74544. */
  74545. isValid(): boolean;
  74546. /**
  74547. * Serialize the StateCondition into a JSON compatible object
  74548. * @returns serialization object
  74549. */
  74550. serialize(): any;
  74551. }
  74552. }
  74553. declare module BABYLON {
  74554. /**
  74555. * This defines an action responsible to toggle a boolean once triggered.
  74556. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74557. */
  74558. export class SwitchBooleanAction extends Action {
  74559. /**
  74560. * The path to the boolean property in the target object
  74561. */
  74562. propertyPath: string;
  74563. private _target;
  74564. private _effectiveTarget;
  74565. private _property;
  74566. /**
  74567. * Instantiate the action
  74568. * @param triggerOptions defines the trigger options
  74569. * @param target defines the object containing the boolean
  74570. * @param propertyPath defines the path to the boolean property in the target object
  74571. * @param condition defines the trigger related conditions
  74572. */
  74573. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  74574. /** @hidden */
  74575. _prepare(): void;
  74576. /**
  74577. * Execute the action toggle the boolean value.
  74578. */
  74579. execute(): void;
  74580. /**
  74581. * Serializes the actions and its related information.
  74582. * @param parent defines the object to serialize in
  74583. * @returns the serialized object
  74584. */
  74585. serialize(parent: any): any;
  74586. }
  74587. /**
  74588. * This defines an action responsible to set a the state field of the target
  74589. * to a desired value once triggered.
  74590. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74591. */
  74592. export class SetStateAction extends Action {
  74593. /**
  74594. * The value to store in the state field.
  74595. */
  74596. value: string;
  74597. private _target;
  74598. /**
  74599. * Instantiate the action
  74600. * @param triggerOptions defines the trigger options
  74601. * @param target defines the object containing the state property
  74602. * @param value defines the value to store in the state field
  74603. * @param condition defines the trigger related conditions
  74604. */
  74605. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  74606. /**
  74607. * Execute the action and store the value on the target state property.
  74608. */
  74609. execute(): void;
  74610. /**
  74611. * Serializes the actions and its related information.
  74612. * @param parent defines the object to serialize in
  74613. * @returns the serialized object
  74614. */
  74615. serialize(parent: any): any;
  74616. }
  74617. /**
  74618. * This defines an action responsible to set a property of the target
  74619. * to a desired value once triggered.
  74620. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74621. */
  74622. export class SetValueAction extends Action {
  74623. /**
  74624. * The path of the property to set in the target.
  74625. */
  74626. propertyPath: string;
  74627. /**
  74628. * The value to set in the property
  74629. */
  74630. value: any;
  74631. private _target;
  74632. private _effectiveTarget;
  74633. private _property;
  74634. /**
  74635. * Instantiate the action
  74636. * @param triggerOptions defines the trigger options
  74637. * @param target defines the object containing the property
  74638. * @param propertyPath defines the path of the property to set in the target
  74639. * @param value defines the value to set in the property
  74640. * @param condition defines the trigger related conditions
  74641. */
  74642. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  74643. /** @hidden */
  74644. _prepare(): void;
  74645. /**
  74646. * Execute the action and set the targetted property to the desired value.
  74647. */
  74648. execute(): void;
  74649. /**
  74650. * Serializes the actions and its related information.
  74651. * @param parent defines the object to serialize in
  74652. * @returns the serialized object
  74653. */
  74654. serialize(parent: any): any;
  74655. }
  74656. /**
  74657. * This defines an action responsible to increment the target value
  74658. * to a desired value once triggered.
  74659. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74660. */
  74661. export class IncrementValueAction extends Action {
  74662. /**
  74663. * The path of the property to increment in the target.
  74664. */
  74665. propertyPath: string;
  74666. /**
  74667. * The value we should increment the property by.
  74668. */
  74669. value: any;
  74670. private _target;
  74671. private _effectiveTarget;
  74672. private _property;
  74673. /**
  74674. * Instantiate the action
  74675. * @param triggerOptions defines the trigger options
  74676. * @param target defines the object containing the property
  74677. * @param propertyPath defines the path of the property to increment in the target
  74678. * @param value defines the value value we should increment the property by
  74679. * @param condition defines the trigger related conditions
  74680. */
  74681. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  74682. /** @hidden */
  74683. _prepare(): void;
  74684. /**
  74685. * Execute the action and increment the target of the value amount.
  74686. */
  74687. execute(): void;
  74688. /**
  74689. * Serializes the actions and its related information.
  74690. * @param parent defines the object to serialize in
  74691. * @returns the serialized object
  74692. */
  74693. serialize(parent: any): any;
  74694. }
  74695. /**
  74696. * This defines an action responsible to start an animation once triggered.
  74697. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74698. */
  74699. export class PlayAnimationAction extends Action {
  74700. /**
  74701. * Where the animation should start (animation frame)
  74702. */
  74703. from: number;
  74704. /**
  74705. * Where the animation should stop (animation frame)
  74706. */
  74707. to: number;
  74708. /**
  74709. * Define if the animation should loop or stop after the first play.
  74710. */
  74711. loop?: boolean;
  74712. private _target;
  74713. /**
  74714. * Instantiate the action
  74715. * @param triggerOptions defines the trigger options
  74716. * @param target defines the target animation or animation name
  74717. * @param from defines from where the animation should start (animation frame)
  74718. * @param end defines where the animation should stop (animation frame)
  74719. * @param loop defines if the animation should loop or stop after the first play
  74720. * @param condition defines the trigger related conditions
  74721. */
  74722. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  74723. /** @hidden */
  74724. _prepare(): void;
  74725. /**
  74726. * Execute the action and play the animation.
  74727. */
  74728. execute(): void;
  74729. /**
  74730. * Serializes the actions and its related information.
  74731. * @param parent defines the object to serialize in
  74732. * @returns the serialized object
  74733. */
  74734. serialize(parent: any): any;
  74735. }
  74736. /**
  74737. * This defines an action responsible to stop an animation once triggered.
  74738. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74739. */
  74740. export class StopAnimationAction extends Action {
  74741. private _target;
  74742. /**
  74743. * Instantiate the action
  74744. * @param triggerOptions defines the trigger options
  74745. * @param target defines the target animation or animation name
  74746. * @param condition defines the trigger related conditions
  74747. */
  74748. constructor(triggerOptions: any, target: any, condition?: Condition);
  74749. /** @hidden */
  74750. _prepare(): void;
  74751. /**
  74752. * Execute the action and stop the animation.
  74753. */
  74754. execute(): void;
  74755. /**
  74756. * Serializes the actions and its related information.
  74757. * @param parent defines the object to serialize in
  74758. * @returns the serialized object
  74759. */
  74760. serialize(parent: any): any;
  74761. }
  74762. /**
  74763. * This defines an action responsible that does nothing once triggered.
  74764. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74765. */
  74766. export class DoNothingAction extends Action {
  74767. /**
  74768. * Instantiate the action
  74769. * @param triggerOptions defines the trigger options
  74770. * @param condition defines the trigger related conditions
  74771. */
  74772. constructor(triggerOptions?: any, condition?: Condition);
  74773. /**
  74774. * Execute the action and do nothing.
  74775. */
  74776. execute(): void;
  74777. /**
  74778. * Serializes the actions and its related information.
  74779. * @param parent defines the object to serialize in
  74780. * @returns the serialized object
  74781. */
  74782. serialize(parent: any): any;
  74783. }
  74784. /**
  74785. * This defines an action responsible to trigger several actions once triggered.
  74786. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74787. */
  74788. export class CombineAction extends Action {
  74789. /**
  74790. * The list of aggregated animations to run.
  74791. */
  74792. children: Action[];
  74793. /**
  74794. * Instantiate the action
  74795. * @param triggerOptions defines the trigger options
  74796. * @param children defines the list of aggregated animations to run
  74797. * @param condition defines the trigger related conditions
  74798. */
  74799. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  74800. /** @hidden */
  74801. _prepare(): void;
  74802. /**
  74803. * Execute the action and executes all the aggregated actions.
  74804. */
  74805. execute(evt: ActionEvent): void;
  74806. /**
  74807. * Serializes the actions and its related information.
  74808. * @param parent defines the object to serialize in
  74809. * @returns the serialized object
  74810. */
  74811. serialize(parent: any): any;
  74812. }
  74813. /**
  74814. * This defines an action responsible to run code (external event) once triggered.
  74815. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74816. */
  74817. export class ExecuteCodeAction extends Action {
  74818. /**
  74819. * The callback function to run.
  74820. */
  74821. func: (evt: ActionEvent) => void;
  74822. /**
  74823. * Instantiate the action
  74824. * @param triggerOptions defines the trigger options
  74825. * @param func defines the callback function to run
  74826. * @param condition defines the trigger related conditions
  74827. */
  74828. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  74829. /**
  74830. * Execute the action and run the attached code.
  74831. */
  74832. execute(evt: ActionEvent): void;
  74833. }
  74834. /**
  74835. * This defines an action responsible to set the parent property of the target once triggered.
  74836. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74837. */
  74838. export class SetParentAction extends Action {
  74839. private _parent;
  74840. private _target;
  74841. /**
  74842. * Instantiate the action
  74843. * @param triggerOptions defines the trigger options
  74844. * @param target defines the target containing the parent property
  74845. * @param parent defines from where the animation should start (animation frame)
  74846. * @param condition defines the trigger related conditions
  74847. */
  74848. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  74849. /** @hidden */
  74850. _prepare(): void;
  74851. /**
  74852. * Execute the action and set the parent property.
  74853. */
  74854. execute(): void;
  74855. /**
  74856. * Serializes the actions and its related information.
  74857. * @param parent defines the object to serialize in
  74858. * @returns the serialized object
  74859. */
  74860. serialize(parent: any): any;
  74861. }
  74862. }
  74863. declare module BABYLON {
  74864. /**
  74865. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  74866. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  74867. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  74868. */
  74869. export class ActionManager extends AbstractActionManager {
  74870. /**
  74871. * Nothing
  74872. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74873. */
  74874. static readonly NothingTrigger: number;
  74875. /**
  74876. * On pick
  74877. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74878. */
  74879. static readonly OnPickTrigger: number;
  74880. /**
  74881. * On left pick
  74882. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74883. */
  74884. static readonly OnLeftPickTrigger: number;
  74885. /**
  74886. * On right pick
  74887. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74888. */
  74889. static readonly OnRightPickTrigger: number;
  74890. /**
  74891. * On center pick
  74892. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74893. */
  74894. static readonly OnCenterPickTrigger: number;
  74895. /**
  74896. * On pick down
  74897. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74898. */
  74899. static readonly OnPickDownTrigger: number;
  74900. /**
  74901. * On double pick
  74902. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74903. */
  74904. static readonly OnDoublePickTrigger: number;
  74905. /**
  74906. * On pick up
  74907. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74908. */
  74909. static readonly OnPickUpTrigger: number;
  74910. /**
  74911. * On pick out.
  74912. * This trigger will only be raised if you also declared a OnPickDown
  74913. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74914. */
  74915. static readonly OnPickOutTrigger: number;
  74916. /**
  74917. * On long press
  74918. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74919. */
  74920. static readonly OnLongPressTrigger: number;
  74921. /**
  74922. * On pointer over
  74923. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74924. */
  74925. static readonly OnPointerOverTrigger: number;
  74926. /**
  74927. * On pointer out
  74928. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74929. */
  74930. static readonly OnPointerOutTrigger: number;
  74931. /**
  74932. * On every frame
  74933. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74934. */
  74935. static readonly OnEveryFrameTrigger: number;
  74936. /**
  74937. * On intersection enter
  74938. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74939. */
  74940. static readonly OnIntersectionEnterTrigger: number;
  74941. /**
  74942. * On intersection exit
  74943. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74944. */
  74945. static readonly OnIntersectionExitTrigger: number;
  74946. /**
  74947. * On key down
  74948. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74949. */
  74950. static readonly OnKeyDownTrigger: number;
  74951. /**
  74952. * On key up
  74953. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  74954. */
  74955. static readonly OnKeyUpTrigger: number;
  74956. private _scene;
  74957. /**
  74958. * Creates a new action manager
  74959. * @param scene defines the hosting scene
  74960. */
  74961. constructor(scene: Scene);
  74962. /**
  74963. * Releases all associated resources
  74964. */
  74965. dispose(): void;
  74966. /**
  74967. * Gets hosting scene
  74968. * @returns the hosting scene
  74969. */
  74970. getScene(): Scene;
  74971. /**
  74972. * Does this action manager handles actions of any of the given triggers
  74973. * @param triggers defines the triggers to be tested
  74974. * @return a boolean indicating whether one (or more) of the triggers is handled
  74975. */
  74976. hasSpecificTriggers(triggers: number[]): boolean;
  74977. /**
  74978. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  74979. * speed.
  74980. * @param triggerA defines the trigger to be tested
  74981. * @param triggerB defines the trigger to be tested
  74982. * @return a boolean indicating whether one (or more) of the triggers is handled
  74983. */
  74984. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  74985. /**
  74986. * Does this action manager handles actions of a given trigger
  74987. * @param trigger defines the trigger to be tested
  74988. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  74989. * @return whether the trigger is handled
  74990. */
  74991. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  74992. /**
  74993. * Does this action manager has pointer triggers
  74994. */
  74995. readonly hasPointerTriggers: boolean;
  74996. /**
  74997. * Does this action manager has pick triggers
  74998. */
  74999. readonly hasPickTriggers: boolean;
  75000. /**
  75001. * Registers an action to this action manager
  75002. * @param action defines the action to be registered
  75003. * @return the action amended (prepared) after registration
  75004. */
  75005. registerAction(action: IAction): Nullable<IAction>;
  75006. /**
  75007. * Unregisters an action to this action manager
  75008. * @param action defines the action to be unregistered
  75009. * @return a boolean indicating whether the action has been unregistered
  75010. */
  75011. unregisterAction(action: IAction): Boolean;
  75012. /**
  75013. * Process a specific trigger
  75014. * @param trigger defines the trigger to process
  75015. * @param evt defines the event details to be processed
  75016. */
  75017. processTrigger(trigger: number, evt?: IActionEvent): void;
  75018. /** @hidden */
  75019. _getEffectiveTarget(target: any, propertyPath: string): any;
  75020. /** @hidden */
  75021. _getProperty(propertyPath: string): string;
  75022. /**
  75023. * Serialize this manager to a JSON object
  75024. * @param name defines the property name to store this manager
  75025. * @returns a JSON representation of this manager
  75026. */
  75027. serialize(name: string): any;
  75028. /**
  75029. * Creates a new ActionManager from a JSON data
  75030. * @param parsedActions defines the JSON data to read from
  75031. * @param object defines the hosting mesh
  75032. * @param scene defines the hosting scene
  75033. */
  75034. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  75035. /**
  75036. * Get a trigger name by index
  75037. * @param trigger defines the trigger index
  75038. * @returns a trigger name
  75039. */
  75040. static GetTriggerName(trigger: number): string;
  75041. }
  75042. }
  75043. declare module BABYLON {
  75044. /**
  75045. * Class representing a ray with position and direction
  75046. */
  75047. export class Ray {
  75048. /** origin point */
  75049. origin: Vector3;
  75050. /** direction */
  75051. direction: Vector3;
  75052. /** length of the ray */
  75053. length: number;
  75054. private static readonly TmpVector3;
  75055. private _tmpRay;
  75056. /**
  75057. * Creates a new ray
  75058. * @param origin origin point
  75059. * @param direction direction
  75060. * @param length length of the ray
  75061. */
  75062. constructor(
  75063. /** origin point */
  75064. origin: Vector3,
  75065. /** direction */
  75066. direction: Vector3,
  75067. /** length of the ray */
  75068. length?: number);
  75069. /**
  75070. * Checks if the ray intersects a box
  75071. * @param minimum bound of the box
  75072. * @param maximum bound of the box
  75073. * @param intersectionTreshold extra extend to be added to the box in all direction
  75074. * @returns if the box was hit
  75075. */
  75076. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  75077. /**
  75078. * Checks if the ray intersects a box
  75079. * @param box the bounding box to check
  75080. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  75081. * @returns if the box was hit
  75082. */
  75083. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  75084. /**
  75085. * If the ray hits a sphere
  75086. * @param sphere the bounding sphere to check
  75087. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  75088. * @returns true if it hits the sphere
  75089. */
  75090. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  75091. /**
  75092. * If the ray hits a triange
  75093. * @param vertex0 triangle vertex
  75094. * @param vertex1 triangle vertex
  75095. * @param vertex2 triangle vertex
  75096. * @returns intersection information if hit
  75097. */
  75098. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  75099. /**
  75100. * Checks if ray intersects a plane
  75101. * @param plane the plane to check
  75102. * @returns the distance away it was hit
  75103. */
  75104. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  75105. /**
  75106. * Calculate the intercept of a ray on a given axis
  75107. * @param axis to check 'x' | 'y' | 'z'
  75108. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  75109. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  75110. */
  75111. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  75112. /**
  75113. * Checks if ray intersects a mesh
  75114. * @param mesh the mesh to check
  75115. * @param fastCheck if only the bounding box should checked
  75116. * @returns picking info of the intersecton
  75117. */
  75118. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  75119. /**
  75120. * Checks if ray intersects a mesh
  75121. * @param meshes the meshes to check
  75122. * @param fastCheck if only the bounding box should checked
  75123. * @param results array to store result in
  75124. * @returns Array of picking infos
  75125. */
  75126. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  75127. private _comparePickingInfo;
  75128. private static smallnum;
  75129. private static rayl;
  75130. /**
  75131. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  75132. * @param sega the first point of the segment to test the intersection against
  75133. * @param segb the second point of the segment to test the intersection against
  75134. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  75135. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  75136. */
  75137. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  75138. /**
  75139. * Update the ray from viewport position
  75140. * @param x position
  75141. * @param y y position
  75142. * @param viewportWidth viewport width
  75143. * @param viewportHeight viewport height
  75144. * @param world world matrix
  75145. * @param view view matrix
  75146. * @param projection projection matrix
  75147. * @returns this ray updated
  75148. */
  75149. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  75150. /**
  75151. * Creates a ray with origin and direction of 0,0,0
  75152. * @returns the new ray
  75153. */
  75154. static Zero(): Ray;
  75155. /**
  75156. * Creates a new ray from screen space and viewport
  75157. * @param x position
  75158. * @param y y position
  75159. * @param viewportWidth viewport width
  75160. * @param viewportHeight viewport height
  75161. * @param world world matrix
  75162. * @param view view matrix
  75163. * @param projection projection matrix
  75164. * @returns new ray
  75165. */
  75166. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  75167. /**
  75168. * 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
  75169. * transformed to the given world matrix.
  75170. * @param origin The origin point
  75171. * @param end The end point
  75172. * @param world a matrix to transform the ray to. Default is the identity matrix.
  75173. * @returns the new ray
  75174. */
  75175. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  75176. /**
  75177. * Transforms a ray by a matrix
  75178. * @param ray ray to transform
  75179. * @param matrix matrix to apply
  75180. * @returns the resulting new ray
  75181. */
  75182. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  75183. /**
  75184. * Transforms a ray by a matrix
  75185. * @param ray ray to transform
  75186. * @param matrix matrix to apply
  75187. * @param result ray to store result in
  75188. */
  75189. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  75190. /**
  75191. * Unproject a ray from screen space to object space
  75192. * @param sourceX defines the screen space x coordinate to use
  75193. * @param sourceY defines the screen space y coordinate to use
  75194. * @param viewportWidth defines the current width of the viewport
  75195. * @param viewportHeight defines the current height of the viewport
  75196. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  75197. * @param view defines the view matrix to use
  75198. * @param projection defines the projection matrix to use
  75199. */
  75200. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  75201. }
  75202. /**
  75203. * Type used to define predicate used to select faces when a mesh intersection is detected
  75204. */
  75205. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  75206. interface Scene {
  75207. /** @hidden */
  75208. _tempPickingRay: Nullable<Ray>;
  75209. /** @hidden */
  75210. _cachedRayForTransform: Ray;
  75211. /** @hidden */
  75212. _pickWithRayInverseMatrix: Matrix;
  75213. /** @hidden */
  75214. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  75215. /** @hidden */
  75216. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  75217. }
  75218. }
  75219. declare module BABYLON {
  75220. /**
  75221. * Groups all the scene component constants in one place to ease maintenance.
  75222. * @hidden
  75223. */
  75224. export class SceneComponentConstants {
  75225. static readonly NAME_EFFECTLAYER: string;
  75226. static readonly NAME_LAYER: string;
  75227. static readonly NAME_LENSFLARESYSTEM: string;
  75228. static readonly NAME_BOUNDINGBOXRENDERER: string;
  75229. static readonly NAME_PARTICLESYSTEM: string;
  75230. static readonly NAME_GAMEPAD: string;
  75231. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  75232. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  75233. static readonly NAME_DEPTHRENDERER: string;
  75234. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  75235. static readonly NAME_SPRITE: string;
  75236. static readonly NAME_OUTLINERENDERER: string;
  75237. static readonly NAME_PROCEDURALTEXTURE: string;
  75238. static readonly NAME_SHADOWGENERATOR: string;
  75239. static readonly NAME_OCTREE: string;
  75240. static readonly NAME_PHYSICSENGINE: string;
  75241. static readonly NAME_AUDIO: string;
  75242. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  75243. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  75244. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  75245. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  75246. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  75247. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  75248. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  75249. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  75250. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  75251. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  75252. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  75253. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  75254. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  75255. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  75256. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  75257. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  75258. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  75259. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  75260. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  75261. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  75262. static readonly STEP_AFTERRENDER_AUDIO: number;
  75263. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  75264. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  75265. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  75266. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  75267. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  75268. static readonly STEP_POINTERMOVE_SPRITE: number;
  75269. static readonly STEP_POINTERDOWN_SPRITE: number;
  75270. static readonly STEP_POINTERUP_SPRITE: number;
  75271. }
  75272. /**
  75273. * This represents a scene component.
  75274. *
  75275. * This is used to decouple the dependency the scene is having on the different workloads like
  75276. * layers, post processes...
  75277. */
  75278. export interface ISceneComponent {
  75279. /**
  75280. * The name of the component. Each component must have a unique name.
  75281. */
  75282. name: string;
  75283. /**
  75284. * The scene the component belongs to.
  75285. */
  75286. scene: Scene;
  75287. /**
  75288. * Register the component to one instance of a scene.
  75289. */
  75290. register(): void;
  75291. /**
  75292. * Rebuilds the elements related to this component in case of
  75293. * context lost for instance.
  75294. */
  75295. rebuild(): void;
  75296. /**
  75297. * Disposes the component and the associated ressources.
  75298. */
  75299. dispose(): void;
  75300. }
  75301. /**
  75302. * This represents a SERIALIZABLE scene component.
  75303. *
  75304. * This extends Scene Component to add Serialization methods on top.
  75305. */
  75306. export interface ISceneSerializableComponent extends ISceneComponent {
  75307. /**
  75308. * Adds all the elements from the container to the scene
  75309. * @param container the container holding the elements
  75310. */
  75311. addFromContainer(container: AbstractScene): void;
  75312. /**
  75313. * Removes all the elements in the container from the scene
  75314. * @param container contains the elements to remove
  75315. * @param dispose if the removed element should be disposed (default: false)
  75316. */
  75317. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75318. /**
  75319. * Serializes the component data to the specified json object
  75320. * @param serializationObject The object to serialize to
  75321. */
  75322. serialize(serializationObject: any): void;
  75323. }
  75324. /**
  75325. * Strong typing of a Mesh related stage step action
  75326. */
  75327. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  75328. /**
  75329. * Strong typing of a Evaluate Sub Mesh related stage step action
  75330. */
  75331. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  75332. /**
  75333. * Strong typing of a Active Mesh related stage step action
  75334. */
  75335. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  75336. /**
  75337. * Strong typing of a Camera related stage step action
  75338. */
  75339. export type CameraStageAction = (camera: Camera) => void;
  75340. /**
  75341. * Strong typing of a Camera Frame buffer related stage step action
  75342. */
  75343. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  75344. /**
  75345. * Strong typing of a Render Target related stage step action
  75346. */
  75347. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  75348. /**
  75349. * Strong typing of a RenderingGroup related stage step action
  75350. */
  75351. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  75352. /**
  75353. * Strong typing of a Mesh Render related stage step action
  75354. */
  75355. export type RenderingMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  75356. /**
  75357. * Strong typing of a simple stage step action
  75358. */
  75359. export type SimpleStageAction = () => void;
  75360. /**
  75361. * Strong typing of a render target action.
  75362. */
  75363. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  75364. /**
  75365. * Strong typing of a pointer move action.
  75366. */
  75367. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  75368. /**
  75369. * Strong typing of a pointer up/down action.
  75370. */
  75371. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  75372. /**
  75373. * Repressentation of a stage in the scene (Basically a list of ordered steps)
  75374. * @hidden
  75375. */
  75376. export class Stage<T extends Function> extends Array<{
  75377. index: number;
  75378. component: ISceneComponent;
  75379. action: T;
  75380. }> {
  75381. /**
  75382. * Hide ctor from the rest of the world.
  75383. * @param items The items to add.
  75384. */
  75385. private constructor();
  75386. /**
  75387. * Creates a new Stage.
  75388. * @returns A new instance of a Stage
  75389. */
  75390. static Create<T extends Function>(): Stage<T>;
  75391. /**
  75392. * Registers a step in an ordered way in the targeted stage.
  75393. * @param index Defines the position to register the step in
  75394. * @param component Defines the component attached to the step
  75395. * @param action Defines the action to launch during the step
  75396. */
  75397. registerStep(index: number, component: ISceneComponent, action: T): void;
  75398. /**
  75399. * Clears all the steps from the stage.
  75400. */
  75401. clear(): void;
  75402. }
  75403. }
  75404. declare module BABYLON {
  75405. interface Scene {
  75406. /** @hidden */
  75407. _pointerOverSprite: Nullable<Sprite>;
  75408. /** @hidden */
  75409. _pickedDownSprite: Nullable<Sprite>;
  75410. /** @hidden */
  75411. _tempSpritePickingRay: Nullable<Ray>;
  75412. /**
  75413. * All of the sprite managers added to this scene
  75414. * @see http://doc.babylonjs.com/babylon101/sprites
  75415. */
  75416. spriteManagers: Array<ISpriteManager>;
  75417. /**
  75418. * An event triggered when sprites rendering is about to start
  75419. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  75420. */
  75421. onBeforeSpritesRenderingObservable: Observable<Scene>;
  75422. /**
  75423. * An event triggered when sprites rendering is done
  75424. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  75425. */
  75426. onAfterSpritesRenderingObservable: Observable<Scene>;
  75427. /** @hidden */
  75428. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  75429. /** Launch a ray to try to pick a sprite in the scene
  75430. * @param x position on screen
  75431. * @param y position on screen
  75432. * @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
  75433. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  75434. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  75435. * @returns a PickingInfo
  75436. */
  75437. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  75438. /** Use the given ray to pick a sprite in the scene
  75439. * @param ray The ray (in world space) to use to pick meshes
  75440. * @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
  75441. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  75442. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  75443. * @returns a PickingInfo
  75444. */
  75445. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  75446. /**
  75447. * Force the sprite under the pointer
  75448. * @param sprite defines the sprite to use
  75449. */
  75450. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  75451. /**
  75452. * Gets the sprite under the pointer
  75453. * @returns a Sprite or null if no sprite is under the pointer
  75454. */
  75455. getPointerOverSprite(): Nullable<Sprite>;
  75456. }
  75457. /**
  75458. * Defines the sprite scene component responsible to manage sprites
  75459. * in a given scene.
  75460. */
  75461. export class SpriteSceneComponent implements ISceneComponent {
  75462. /**
  75463. * The component name helpfull to identify the component in the list of scene components.
  75464. */
  75465. readonly name: string;
  75466. /**
  75467. * The scene the component belongs to.
  75468. */
  75469. scene: Scene;
  75470. /** @hidden */
  75471. private _spritePredicate;
  75472. /**
  75473. * Creates a new instance of the component for the given scene
  75474. * @param scene Defines the scene to register the component in
  75475. */
  75476. constructor(scene: Scene);
  75477. /**
  75478. * Registers the component in a given scene
  75479. */
  75480. register(): void;
  75481. /**
  75482. * Rebuilds the elements related to this component in case of
  75483. * context lost for instance.
  75484. */
  75485. rebuild(): void;
  75486. /**
  75487. * Disposes the component and the associated ressources.
  75488. */
  75489. dispose(): void;
  75490. private _pickSpriteButKeepRay;
  75491. private _pointerMove;
  75492. private _pointerDown;
  75493. private _pointerUp;
  75494. }
  75495. }
  75496. declare module BABYLON {
  75497. /** @hidden */
  75498. export var fogFragmentDeclaration: {
  75499. name: string;
  75500. shader: string;
  75501. };
  75502. }
  75503. declare module BABYLON {
  75504. /** @hidden */
  75505. export var fogFragment: {
  75506. name: string;
  75507. shader: string;
  75508. };
  75509. }
  75510. declare module BABYLON {
  75511. /** @hidden */
  75512. export var spritesPixelShader: {
  75513. name: string;
  75514. shader: string;
  75515. };
  75516. }
  75517. declare module BABYLON {
  75518. /** @hidden */
  75519. export var fogVertexDeclaration: {
  75520. name: string;
  75521. shader: string;
  75522. };
  75523. }
  75524. declare module BABYLON {
  75525. /** @hidden */
  75526. export var spritesVertexShader: {
  75527. name: string;
  75528. shader: string;
  75529. };
  75530. }
  75531. declare module BABYLON {
  75532. /**
  75533. * Defines the minimum interface to fullfil in order to be a sprite manager.
  75534. */
  75535. export interface ISpriteManager extends IDisposable {
  75536. /**
  75537. * Restricts the camera to viewing objects with the same layerMask.
  75538. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  75539. */
  75540. layerMask: number;
  75541. /**
  75542. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  75543. */
  75544. isPickable: boolean;
  75545. /**
  75546. * Specifies the rendering group id for this mesh (0 by default)
  75547. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  75548. */
  75549. renderingGroupId: number;
  75550. /**
  75551. * Defines the list of sprites managed by the manager.
  75552. */
  75553. sprites: Array<Sprite>;
  75554. /**
  75555. * Tests the intersection of a sprite with a specific ray.
  75556. * @param ray The ray we are sending to test the collision
  75557. * @param camera The camera space we are sending rays in
  75558. * @param predicate A predicate allowing excluding sprites from the list of object to test
  75559. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  75560. * @returns picking info or null.
  75561. */
  75562. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  75563. /**
  75564. * Renders the list of sprites on screen.
  75565. */
  75566. render(): void;
  75567. }
  75568. /**
  75569. * Class used to manage multiple sprites on the same spritesheet
  75570. * @see http://doc.babylonjs.com/babylon101/sprites
  75571. */
  75572. export class SpriteManager implements ISpriteManager {
  75573. /** defines the manager's name */
  75574. name: string;
  75575. /** Gets the list of sprites */
  75576. sprites: Sprite[];
  75577. /** Gets or sets the rendering group id (0 by default) */
  75578. renderingGroupId: number;
  75579. /** Gets or sets camera layer mask */
  75580. layerMask: number;
  75581. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  75582. fogEnabled: boolean;
  75583. /** Gets or sets a boolean indicating if the sprites are pickable */
  75584. isPickable: boolean;
  75585. /** Defines the default width of a cell in the spritesheet */
  75586. cellWidth: number;
  75587. /** Defines the default height of a cell in the spritesheet */
  75588. cellHeight: number;
  75589. /**
  75590. * An event triggered when the manager is disposed.
  75591. */
  75592. onDisposeObservable: Observable<SpriteManager>;
  75593. private _onDisposeObserver;
  75594. /**
  75595. * Callback called when the manager is disposed
  75596. */
  75597. onDispose: () => void;
  75598. private _capacity;
  75599. private _spriteTexture;
  75600. private _epsilon;
  75601. private _scene;
  75602. private _vertexData;
  75603. private _buffer;
  75604. private _vertexBuffers;
  75605. private _indexBuffer;
  75606. private _effectBase;
  75607. private _effectFog;
  75608. /**
  75609. * Gets or sets the spritesheet texture
  75610. */
  75611. texture: Texture;
  75612. /**
  75613. * Creates a new sprite manager
  75614. * @param name defines the manager's name
  75615. * @param imgUrl defines the sprite sheet url
  75616. * @param capacity defines the maximum allowed number of sprites
  75617. * @param cellSize defines the size of a sprite cell
  75618. * @param scene defines the hosting scene
  75619. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  75620. * @param samplingMode defines the smapling mode to use with spritesheet
  75621. */
  75622. constructor(
  75623. /** defines the manager's name */
  75624. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number);
  75625. private _appendSpriteVertex;
  75626. /**
  75627. * Intersects the sprites with a ray
  75628. * @param ray defines the ray to intersect with
  75629. * @param camera defines the current active camera
  75630. * @param predicate defines a predicate used to select candidate sprites
  75631. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  75632. * @returns null if no hit or a PickingInfo
  75633. */
  75634. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  75635. /**
  75636. * Render all child sprites
  75637. */
  75638. render(): void;
  75639. /**
  75640. * Release associated resources
  75641. */
  75642. dispose(): void;
  75643. }
  75644. }
  75645. declare module BABYLON {
  75646. /**
  75647. * Class used to represent a sprite
  75648. * @see http://doc.babylonjs.com/babylon101/sprites
  75649. */
  75650. export class Sprite {
  75651. /** defines the name */
  75652. name: string;
  75653. /** Gets or sets the current world position */
  75654. position: Vector3;
  75655. /** Gets or sets the main color */
  75656. color: Color4;
  75657. /** Gets or sets the width */
  75658. width: number;
  75659. /** Gets or sets the height */
  75660. height: number;
  75661. /** Gets or sets rotation angle */
  75662. angle: number;
  75663. /** Gets or sets the cell index in the sprite sheet */
  75664. cellIndex: number;
  75665. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  75666. invertU: number;
  75667. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  75668. invertV: number;
  75669. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  75670. disposeWhenFinishedAnimating: boolean;
  75671. /** Gets the list of attached animations */
  75672. animations: Animation[];
  75673. /** Gets or sets a boolean indicating if the sprite can be picked */
  75674. isPickable: boolean;
  75675. /**
  75676. * Gets or sets the associated action manager
  75677. */
  75678. actionManager: Nullable<ActionManager>;
  75679. private _animationStarted;
  75680. private _loopAnimation;
  75681. private _fromIndex;
  75682. private _toIndex;
  75683. private _delay;
  75684. private _direction;
  75685. private _manager;
  75686. private _time;
  75687. private _onAnimationEnd;
  75688. /**
  75689. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  75690. */
  75691. isVisible: boolean;
  75692. /**
  75693. * Gets or sets the sprite size
  75694. */
  75695. size: number;
  75696. /**
  75697. * Creates a new Sprite
  75698. * @param name defines the name
  75699. * @param manager defines the manager
  75700. */
  75701. constructor(
  75702. /** defines the name */
  75703. name: string, manager: ISpriteManager);
  75704. /**
  75705. * Starts an animation
  75706. * @param from defines the initial key
  75707. * @param to defines the end key
  75708. * @param loop defines if the animation must loop
  75709. * @param delay defines the start delay (in ms)
  75710. * @param onAnimationEnd defines a callback to call when animation ends
  75711. */
  75712. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  75713. /** Stops current animation (if any) */
  75714. stopAnimation(): void;
  75715. /** @hidden */
  75716. _animate(deltaTime: number): void;
  75717. /** Release associated resources */
  75718. dispose(): void;
  75719. }
  75720. }
  75721. declare module BABYLON {
  75722. /**
  75723. * Information about the result of picking within a scene
  75724. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  75725. */
  75726. export class PickingInfo {
  75727. /** @hidden */
  75728. _pickingUnavailable: boolean;
  75729. /**
  75730. * If the pick collided with an object
  75731. */
  75732. hit: boolean;
  75733. /**
  75734. * Distance away where the pick collided
  75735. */
  75736. distance: number;
  75737. /**
  75738. * The location of pick collision
  75739. */
  75740. pickedPoint: Nullable<Vector3>;
  75741. /**
  75742. * The mesh corresponding the the pick collision
  75743. */
  75744. pickedMesh: Nullable<AbstractMesh>;
  75745. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  75746. bu: number;
  75747. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  75748. bv: number;
  75749. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  75750. faceId: number;
  75751. /** Id of the the submesh that was picked */
  75752. subMeshId: number;
  75753. /** If a sprite was picked, this will be the sprite the pick collided with */
  75754. pickedSprite: Nullable<Sprite>;
  75755. /**
  75756. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  75757. */
  75758. originMesh: Nullable<AbstractMesh>;
  75759. /**
  75760. * The ray that was used to perform the picking.
  75761. */
  75762. ray: Nullable<Ray>;
  75763. /**
  75764. * Gets the normal correspodning to the face the pick collided with
  75765. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  75766. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  75767. * @returns The normal correspodning to the face the pick collided with
  75768. */
  75769. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  75770. /**
  75771. * Gets the texture coordinates of where the pick occured
  75772. * @returns the vector containing the coordnates of the texture
  75773. */
  75774. getTextureCoordinates(): Nullable<Vector2>;
  75775. }
  75776. }
  75777. declare module BABYLON {
  75778. /**
  75779. * Gather the list of pointer event types as constants.
  75780. */
  75781. export class PointerEventTypes {
  75782. /**
  75783. * 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.
  75784. */
  75785. static readonly POINTERDOWN: number;
  75786. /**
  75787. * The pointerup event is fired when a pointer is no longer active.
  75788. */
  75789. static readonly POINTERUP: number;
  75790. /**
  75791. * The pointermove event is fired when a pointer changes coordinates.
  75792. */
  75793. static readonly POINTERMOVE: number;
  75794. /**
  75795. * The pointerwheel event is fired when a mouse wheel has been rotated.
  75796. */
  75797. static readonly POINTERWHEEL: number;
  75798. /**
  75799. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  75800. */
  75801. static readonly POINTERPICK: number;
  75802. /**
  75803. * The pointertap event is fired when a the object has been touched and released without drag.
  75804. */
  75805. static readonly POINTERTAP: number;
  75806. /**
  75807. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  75808. */
  75809. static readonly POINTERDOUBLETAP: number;
  75810. }
  75811. /**
  75812. * Base class of pointer info types.
  75813. */
  75814. export class PointerInfoBase {
  75815. /**
  75816. * Defines the type of event (PointerEventTypes)
  75817. */
  75818. type: number;
  75819. /**
  75820. * Defines the related dom event
  75821. */
  75822. event: PointerEvent | MouseWheelEvent;
  75823. /**
  75824. * Instantiates the base class of pointers info.
  75825. * @param type Defines the type of event (PointerEventTypes)
  75826. * @param event Defines the related dom event
  75827. */
  75828. constructor(
  75829. /**
  75830. * Defines the type of event (PointerEventTypes)
  75831. */
  75832. type: number,
  75833. /**
  75834. * Defines the related dom event
  75835. */
  75836. event: PointerEvent | MouseWheelEvent);
  75837. }
  75838. /**
  75839. * This class is used to store pointer related info for the onPrePointerObservable event.
  75840. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  75841. */
  75842. export class PointerInfoPre extends PointerInfoBase {
  75843. /**
  75844. * Ray from a pointer if availible (eg. 6dof controller)
  75845. */
  75846. ray: Nullable<Ray>;
  75847. /**
  75848. * Defines the local position of the pointer on the canvas.
  75849. */
  75850. localPosition: Vector2;
  75851. /**
  75852. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  75853. */
  75854. skipOnPointerObservable: boolean;
  75855. /**
  75856. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  75857. * @param type Defines the type of event (PointerEventTypes)
  75858. * @param event Defines the related dom event
  75859. * @param localX Defines the local x coordinates of the pointer when the event occured
  75860. * @param localY Defines the local y coordinates of the pointer when the event occured
  75861. */
  75862. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  75863. }
  75864. /**
  75865. * This type contains all the data related to a pointer event in Babylon.js.
  75866. * 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.
  75867. */
  75868. export class PointerInfo extends PointerInfoBase {
  75869. /**
  75870. * Defines the picking info associated to the info (if any)\
  75871. */
  75872. pickInfo: Nullable<PickingInfo>;
  75873. /**
  75874. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  75875. * @param type Defines the type of event (PointerEventTypes)
  75876. * @param event Defines the related dom event
  75877. * @param pickInfo Defines the picking info associated to the info (if any)\
  75878. */
  75879. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  75880. /**
  75881. * Defines the picking info associated to the info (if any)\
  75882. */
  75883. pickInfo: Nullable<PickingInfo>);
  75884. }
  75885. /**
  75886. * Data relating to a touch event on the screen.
  75887. */
  75888. export interface PointerTouch {
  75889. /**
  75890. * X coordinate of touch.
  75891. */
  75892. x: number;
  75893. /**
  75894. * Y coordinate of touch.
  75895. */
  75896. y: number;
  75897. /**
  75898. * Id of touch. Unique for each finger.
  75899. */
  75900. pointerId: number;
  75901. /**
  75902. * Event type passed from DOM.
  75903. */
  75904. type: any;
  75905. }
  75906. }
  75907. declare module BABYLON {
  75908. /**
  75909. * Manage the mouse inputs to control the movement of a free camera.
  75910. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  75911. */
  75912. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  75913. /**
  75914. * Define if touch is enabled in the mouse input
  75915. */
  75916. touchEnabled: boolean;
  75917. /**
  75918. * Defines the camera the input is attached to.
  75919. */
  75920. camera: FreeCamera;
  75921. /**
  75922. * Defines the buttons associated with the input to handle camera move.
  75923. */
  75924. buttons: number[];
  75925. /**
  75926. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  75927. */
  75928. angularSensibility: number;
  75929. private _pointerInput;
  75930. private _onMouseMove;
  75931. private _observer;
  75932. private previousPosition;
  75933. /**
  75934. * Observable for when a pointer move event occurs containing the move offset
  75935. */
  75936. onPointerMovedObservable: Observable<{
  75937. offsetX: number;
  75938. offsetY: number;
  75939. }>;
  75940. /**
  75941. * @hidden
  75942. * If the camera should be rotated automatically based on pointer movement
  75943. */
  75944. _allowCameraRotation: boolean;
  75945. /**
  75946. * Manage the mouse inputs to control the movement of a free camera.
  75947. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  75948. * @param touchEnabled Defines if touch is enabled or not
  75949. */
  75950. constructor(
  75951. /**
  75952. * Define if touch is enabled in the mouse input
  75953. */
  75954. touchEnabled?: boolean);
  75955. /**
  75956. * Attach the input controls to a specific dom element to get the input from.
  75957. * @param element Defines the element the controls should be listened from
  75958. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  75959. */
  75960. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  75961. /**
  75962. * Called on JS contextmenu event.
  75963. * Override this method to provide functionality.
  75964. */
  75965. protected onContextMenu(evt: PointerEvent): void;
  75966. /**
  75967. * Detach the current controls from the specified dom element.
  75968. * @param element Defines the element to stop listening the inputs from
  75969. */
  75970. detachControl(element: Nullable<HTMLElement>): void;
  75971. /**
  75972. * Gets the class name of the current intput.
  75973. * @returns the class name
  75974. */
  75975. getClassName(): string;
  75976. /**
  75977. * Get the friendly name associated with the input class.
  75978. * @returns the input friendly name
  75979. */
  75980. getSimpleName(): string;
  75981. }
  75982. }
  75983. declare module BABYLON {
  75984. /**
  75985. * Manage the touch inputs to control the movement of a free camera.
  75986. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  75987. */
  75988. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  75989. /**
  75990. * Defines the camera the input is attached to.
  75991. */
  75992. camera: FreeCamera;
  75993. /**
  75994. * Defines the touch sensibility for rotation.
  75995. * The higher the faster.
  75996. */
  75997. touchAngularSensibility: number;
  75998. /**
  75999. * Defines the touch sensibility for move.
  76000. * The higher the faster.
  76001. */
  76002. touchMoveSensibility: number;
  76003. private _offsetX;
  76004. private _offsetY;
  76005. private _pointerPressed;
  76006. private _pointerInput;
  76007. private _observer;
  76008. private _onLostFocus;
  76009. /**
  76010. * Attach the input controls to a specific dom element to get the input from.
  76011. * @param element Defines the element the controls should be listened from
  76012. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  76013. */
  76014. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  76015. /**
  76016. * Detach the current controls from the specified dom element.
  76017. * @param element Defines the element to stop listening the inputs from
  76018. */
  76019. detachControl(element: Nullable<HTMLElement>): void;
  76020. /**
  76021. * Update the current camera state depending on the inputs that have been used this frame.
  76022. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  76023. */
  76024. checkInputs(): void;
  76025. /**
  76026. * Gets the class name of the current intput.
  76027. * @returns the class name
  76028. */
  76029. getClassName(): string;
  76030. /**
  76031. * Get the friendly name associated with the input class.
  76032. * @returns the input friendly name
  76033. */
  76034. getSimpleName(): string;
  76035. }
  76036. }
  76037. declare module BABYLON {
  76038. /**
  76039. * Default Inputs manager for the FreeCamera.
  76040. * It groups all the default supported inputs for ease of use.
  76041. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  76042. */
  76043. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  76044. /**
  76045. * @hidden
  76046. */
  76047. _mouseInput: Nullable<FreeCameraMouseInput>;
  76048. /**
  76049. * Instantiates a new FreeCameraInputsManager.
  76050. * @param camera Defines the camera the inputs belong to
  76051. */
  76052. constructor(camera: FreeCamera);
  76053. /**
  76054. * Add keyboard input support to the input manager.
  76055. * @returns the current input manager
  76056. */
  76057. addKeyboard(): FreeCameraInputsManager;
  76058. /**
  76059. * Add mouse input support to the input manager.
  76060. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  76061. * @returns the current input manager
  76062. */
  76063. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  76064. /**
  76065. * Removes the mouse input support from the manager
  76066. * @returns the current input manager
  76067. */
  76068. removeMouse(): FreeCameraInputsManager;
  76069. /**
  76070. * Add touch input support to the input manager.
  76071. * @returns the current input manager
  76072. */
  76073. addTouch(): FreeCameraInputsManager;
  76074. /**
  76075. * Remove all attached input methods from a camera
  76076. */
  76077. clear(): void;
  76078. }
  76079. }
  76080. declare module BABYLON {
  76081. /**
  76082. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  76083. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  76084. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  76085. */
  76086. export class FreeCamera extends TargetCamera {
  76087. /**
  76088. * Define the collision ellipsoid of the camera.
  76089. * This is helpful to simulate a camera body like the player body around the camera
  76090. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  76091. */
  76092. ellipsoid: Vector3;
  76093. /**
  76094. * Define an offset for the position of the ellipsoid around the camera.
  76095. * This can be helpful to determine the center of the body near the gravity center of the body
  76096. * instead of its head.
  76097. */
  76098. ellipsoidOffset: Vector3;
  76099. /**
  76100. * Enable or disable collisions of the camera with the rest of the scene objects.
  76101. */
  76102. checkCollisions: boolean;
  76103. /**
  76104. * Enable or disable gravity on the camera.
  76105. */
  76106. applyGravity: boolean;
  76107. /**
  76108. * Define the input manager associated to the camera.
  76109. */
  76110. inputs: FreeCameraInputsManager;
  76111. /**
  76112. * Gets the input sensibility for a mouse input. (default is 2000.0)
  76113. * Higher values reduce sensitivity.
  76114. */
  76115. /**
  76116. * Sets the input sensibility for a mouse input. (default is 2000.0)
  76117. * Higher values reduce sensitivity.
  76118. */
  76119. angularSensibility: number;
  76120. /**
  76121. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  76122. */
  76123. keysUp: number[];
  76124. /**
  76125. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  76126. */
  76127. keysDown: number[];
  76128. /**
  76129. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  76130. */
  76131. keysLeft: number[];
  76132. /**
  76133. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  76134. */
  76135. keysRight: number[];
  76136. /**
  76137. * Event raised when the camera collide with a mesh in the scene.
  76138. */
  76139. onCollide: (collidedMesh: AbstractMesh) => void;
  76140. private _collider;
  76141. private _needMoveForGravity;
  76142. private _oldPosition;
  76143. private _diffPosition;
  76144. private _newPosition;
  76145. /** @hidden */
  76146. _localDirection: Vector3;
  76147. /** @hidden */
  76148. _transformedDirection: Vector3;
  76149. /**
  76150. * Instantiates a Free Camera.
  76151. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  76152. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  76153. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  76154. * @param name Define the name of the camera in the scene
  76155. * @param position Define the start position of the camera in the scene
  76156. * @param scene Define the scene the camera belongs to
  76157. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  76158. */
  76159. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  76160. /**
  76161. * Attached controls to the current camera.
  76162. * @param element Defines the element the controls should be listened from
  76163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  76164. */
  76165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  76166. /**
  76167. * Detach the current controls from the camera.
  76168. * The camera will stop reacting to inputs.
  76169. * @param element Defines the element to stop listening the inputs from
  76170. */
  76171. detachControl(element: HTMLElement): void;
  76172. private _collisionMask;
  76173. /**
  76174. * Define a collision mask to limit the list of object the camera can collide with
  76175. */
  76176. collisionMask: number;
  76177. /** @hidden */
  76178. _collideWithWorld(displacement: Vector3): void;
  76179. private _onCollisionPositionChange;
  76180. /** @hidden */
  76181. _checkInputs(): void;
  76182. /** @hidden */
  76183. _decideIfNeedsToMove(): boolean;
  76184. /** @hidden */
  76185. _updatePosition(): void;
  76186. /**
  76187. * Destroy the camera and release the current resources hold by it.
  76188. */
  76189. dispose(): void;
  76190. /**
  76191. * Gets the current object class name.
  76192. * @return the class name
  76193. */
  76194. getClassName(): string;
  76195. }
  76196. }
  76197. declare module BABYLON {
  76198. /**
  76199. * Represents a gamepad control stick position
  76200. */
  76201. export class StickValues {
  76202. /**
  76203. * The x component of the control stick
  76204. */
  76205. x: number;
  76206. /**
  76207. * The y component of the control stick
  76208. */
  76209. y: number;
  76210. /**
  76211. * Initializes the gamepad x and y control stick values
  76212. * @param x The x component of the gamepad control stick value
  76213. * @param y The y component of the gamepad control stick value
  76214. */
  76215. constructor(
  76216. /**
  76217. * The x component of the control stick
  76218. */
  76219. x: number,
  76220. /**
  76221. * The y component of the control stick
  76222. */
  76223. y: number);
  76224. }
  76225. /**
  76226. * An interface which manages callbacks for gamepad button changes
  76227. */
  76228. export interface GamepadButtonChanges {
  76229. /**
  76230. * Called when a gamepad has been changed
  76231. */
  76232. changed: boolean;
  76233. /**
  76234. * Called when a gamepad press event has been triggered
  76235. */
  76236. pressChanged: boolean;
  76237. /**
  76238. * Called when a touch event has been triggered
  76239. */
  76240. touchChanged: boolean;
  76241. /**
  76242. * Called when a value has changed
  76243. */
  76244. valueChanged: boolean;
  76245. }
  76246. /**
  76247. * Represents a gamepad
  76248. */
  76249. export class Gamepad {
  76250. /**
  76251. * The id of the gamepad
  76252. */
  76253. id: string;
  76254. /**
  76255. * The index of the gamepad
  76256. */
  76257. index: number;
  76258. /**
  76259. * The browser gamepad
  76260. */
  76261. browserGamepad: any;
  76262. /**
  76263. * Specifies what type of gamepad this represents
  76264. */
  76265. type: number;
  76266. private _leftStick;
  76267. private _rightStick;
  76268. /** @hidden */
  76269. _isConnected: boolean;
  76270. private _leftStickAxisX;
  76271. private _leftStickAxisY;
  76272. private _rightStickAxisX;
  76273. private _rightStickAxisY;
  76274. /**
  76275. * Triggered when the left control stick has been changed
  76276. */
  76277. private _onleftstickchanged;
  76278. /**
  76279. * Triggered when the right control stick has been changed
  76280. */
  76281. private _onrightstickchanged;
  76282. /**
  76283. * Represents a gamepad controller
  76284. */
  76285. static GAMEPAD: number;
  76286. /**
  76287. * Represents a generic controller
  76288. */
  76289. static GENERIC: number;
  76290. /**
  76291. * Represents an XBox controller
  76292. */
  76293. static XBOX: number;
  76294. /**
  76295. * Represents a pose-enabled controller
  76296. */
  76297. static POSE_ENABLED: number;
  76298. /**
  76299. * Represents an Dual Shock controller
  76300. */
  76301. static DUALSHOCK: number;
  76302. /**
  76303. * Specifies whether the left control stick should be Y-inverted
  76304. */
  76305. protected _invertLeftStickY: boolean;
  76306. /**
  76307. * Specifies if the gamepad has been connected
  76308. */
  76309. readonly isConnected: boolean;
  76310. /**
  76311. * Initializes the gamepad
  76312. * @param id The id of the gamepad
  76313. * @param index The index of the gamepad
  76314. * @param browserGamepad The browser gamepad
  76315. * @param leftStickX The x component of the left joystick
  76316. * @param leftStickY The y component of the left joystick
  76317. * @param rightStickX The x component of the right joystick
  76318. * @param rightStickY The y component of the right joystick
  76319. */
  76320. constructor(
  76321. /**
  76322. * The id of the gamepad
  76323. */
  76324. id: string,
  76325. /**
  76326. * The index of the gamepad
  76327. */
  76328. index: number,
  76329. /**
  76330. * The browser gamepad
  76331. */
  76332. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  76333. /**
  76334. * Callback triggered when the left joystick has changed
  76335. * @param callback
  76336. */
  76337. onleftstickchanged(callback: (values: StickValues) => void): void;
  76338. /**
  76339. * Callback triggered when the right joystick has changed
  76340. * @param callback
  76341. */
  76342. onrightstickchanged(callback: (values: StickValues) => void): void;
  76343. /**
  76344. * Gets the left joystick
  76345. */
  76346. /**
  76347. * Sets the left joystick values
  76348. */
  76349. leftStick: StickValues;
  76350. /**
  76351. * Gets the right joystick
  76352. */
  76353. /**
  76354. * Sets the right joystick value
  76355. */
  76356. rightStick: StickValues;
  76357. /**
  76358. * Updates the gamepad joystick positions
  76359. */
  76360. update(): void;
  76361. /**
  76362. * Disposes the gamepad
  76363. */
  76364. dispose(): void;
  76365. }
  76366. /**
  76367. * Represents a generic gamepad
  76368. */
  76369. export class GenericPad extends Gamepad {
  76370. private _buttons;
  76371. private _onbuttondown;
  76372. private _onbuttonup;
  76373. /**
  76374. * Observable triggered when a button has been pressed
  76375. */
  76376. onButtonDownObservable: Observable<number>;
  76377. /**
  76378. * Observable triggered when a button has been released
  76379. */
  76380. onButtonUpObservable: Observable<number>;
  76381. /**
  76382. * Callback triggered when a button has been pressed
  76383. * @param callback Called when a button has been pressed
  76384. */
  76385. onbuttondown(callback: (buttonPressed: number) => void): void;
  76386. /**
  76387. * Callback triggered when a button has been released
  76388. * @param callback Called when a button has been released
  76389. */
  76390. onbuttonup(callback: (buttonReleased: number) => void): void;
  76391. /**
  76392. * Initializes the generic gamepad
  76393. * @param id The id of the generic gamepad
  76394. * @param index The index of the generic gamepad
  76395. * @param browserGamepad The browser gamepad
  76396. */
  76397. constructor(id: string, index: number, browserGamepad: any);
  76398. private _setButtonValue;
  76399. /**
  76400. * Updates the generic gamepad
  76401. */
  76402. update(): void;
  76403. /**
  76404. * Disposes the generic gamepad
  76405. */
  76406. dispose(): void;
  76407. }
  76408. }
  76409. declare module BABYLON {
  76410. interface Engine {
  76411. /**
  76412. * Creates a raw texture
  76413. * @param data defines the data to store in the texture
  76414. * @param width defines the width of the texture
  76415. * @param height defines the height of the texture
  76416. * @param format defines the format of the data
  76417. * @param generateMipMaps defines if the engine should generate the mip levels
  76418. * @param invertY defines if data must be stored with Y axis inverted
  76419. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  76420. * @param compression defines the compression used (null by default)
  76421. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  76422. * @returns the raw texture inside an InternalTexture
  76423. */
  76424. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  76425. /**
  76426. * Update a raw texture
  76427. * @param texture defines the texture to update
  76428. * @param data defines the data to store in the texture
  76429. * @param format defines the format of the data
  76430. * @param invertY defines if data must be stored with Y axis inverted
  76431. */
  76432. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  76433. /**
  76434. * Update a raw texture
  76435. * @param texture defines the texture to update
  76436. * @param data defines the data to store in the texture
  76437. * @param format defines the format of the data
  76438. * @param invertY defines if data must be stored with Y axis inverted
  76439. * @param compression defines the compression used (null by default)
  76440. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  76441. */
  76442. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  76443. /**
  76444. * Creates a new raw cube texture
  76445. * @param data defines the array of data to use to create each face
  76446. * @param size defines the size of the textures
  76447. * @param format defines the format of the data
  76448. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  76449. * @param generateMipMaps defines if the engine should generate the mip levels
  76450. * @param invertY defines if data must be stored with Y axis inverted
  76451. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  76452. * @param compression defines the compression used (null by default)
  76453. * @returns the cube texture as an InternalTexture
  76454. */
  76455. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  76456. /**
  76457. * Update a raw cube texture
  76458. * @param texture defines the texture to udpdate
  76459. * @param data defines the data to store
  76460. * @param format defines the data format
  76461. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  76462. * @param invertY defines if data must be stored with Y axis inverted
  76463. */
  76464. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  76465. /**
  76466. * Update a raw cube texture
  76467. * @param texture defines the texture to udpdate
  76468. * @param data defines the data to store
  76469. * @param format defines the data format
  76470. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  76471. * @param invertY defines if data must be stored with Y axis inverted
  76472. * @param compression defines the compression used (null by default)
  76473. */
  76474. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  76475. /**
  76476. * Update a raw cube texture
  76477. * @param texture defines the texture to udpdate
  76478. * @param data defines the data to store
  76479. * @param format defines the data format
  76480. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  76481. * @param invertY defines if data must be stored with Y axis inverted
  76482. * @param compression defines the compression used (null by default)
  76483. * @param level defines which level of the texture to update
  76484. */
  76485. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  76486. /**
  76487. * Creates a new raw cube texture from a specified url
  76488. * @param url defines the url where the data is located
  76489. * @param scene defines the current scene
  76490. * @param size defines the size of the textures
  76491. * @param format defines the format of the data
  76492. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  76493. * @param noMipmap defines if the engine should avoid generating the mip levels
  76494. * @param callback defines a callback used to extract texture data from loaded data
  76495. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  76496. * @param onLoad defines a callback called when texture is loaded
  76497. * @param onError defines a callback called if there is an error
  76498. * @returns the cube texture as an InternalTexture
  76499. */
  76500. 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;
  76501. /**
  76502. * Creates a new raw cube texture from a specified url
  76503. * @param url defines the url where the data is located
  76504. * @param scene defines the current scene
  76505. * @param size defines the size of the textures
  76506. * @param format defines the format of the data
  76507. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  76508. * @param noMipmap defines if the engine should avoid generating the mip levels
  76509. * @param callback defines a callback used to extract texture data from loaded data
  76510. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  76511. * @param onLoad defines a callback called when texture is loaded
  76512. * @param onError defines a callback called if there is an error
  76513. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  76514. * @param invertY defines if data must be stored with Y axis inverted
  76515. * @returns the cube texture as an InternalTexture
  76516. */
  76517. 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;
  76518. /**
  76519. * Creates a new raw 3D texture
  76520. * @param data defines the data used to create the texture
  76521. * @param width defines the width of the texture
  76522. * @param height defines the height of the texture
  76523. * @param depth defines the depth of the texture
  76524. * @param format defines the format of the texture
  76525. * @param generateMipMaps defines if the engine must generate mip levels
  76526. * @param invertY defines if data must be stored with Y axis inverted
  76527. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  76528. * @param compression defines the compressed used (can be null)
  76529. * @param textureType defines the compressed used (can be null)
  76530. * @returns a new raw 3D texture (stored in an InternalTexture)
  76531. */
  76532. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  76533. /**
  76534. * Update a raw 3D texture
  76535. * @param texture defines the texture to update
  76536. * @param data defines the data to store
  76537. * @param format defines the data format
  76538. * @param invertY defines if data must be stored with Y axis inverted
  76539. */
  76540. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  76541. /**
  76542. * Update a raw 3D texture
  76543. * @param texture defines the texture to update
  76544. * @param data defines the data to store
  76545. * @param format defines the data format
  76546. * @param invertY defines if data must be stored with Y axis inverted
  76547. * @param compression defines the used compression (can be null)
  76548. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  76549. */
  76550. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  76551. }
  76552. }
  76553. declare module BABYLON {
  76554. /**
  76555. * Raw texture can help creating a texture directly from an array of data.
  76556. * This can be super useful if you either get the data from an uncompressed source or
  76557. * if you wish to create your texture pixel by pixel.
  76558. */
  76559. export class RawTexture extends Texture {
  76560. /**
  76561. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  76562. */
  76563. format: number;
  76564. private _engine;
  76565. /**
  76566. * Instantiates a new RawTexture.
  76567. * Raw texture can help creating a texture directly from an array of data.
  76568. * This can be super useful if you either get the data from an uncompressed source or
  76569. * if you wish to create your texture pixel by pixel.
  76570. * @param data define the array of data to use to create the texture
  76571. * @param width define the width of the texture
  76572. * @param height define the height of the texture
  76573. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  76574. * @param scene define the scene the texture belongs to
  76575. * @param generateMipMaps define whether mip maps should be generated or not
  76576. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76577. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76578. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  76579. */
  76580. constructor(data: ArrayBufferView, width: number, height: number,
  76581. /**
  76582. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  76583. */
  76584. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  76585. /**
  76586. * Updates the texture underlying data.
  76587. * @param data Define the new data of the texture
  76588. */
  76589. update(data: ArrayBufferView): void;
  76590. /**
  76591. * Creates a luminance texture from some data.
  76592. * @param data Define the texture data
  76593. * @param width Define the width of the texture
  76594. * @param height Define the height of the texture
  76595. * @param scene Define the scene the texture belongs to
  76596. * @param generateMipMaps Define whether or not to create mip maps for the texture
  76597. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76598. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76599. * @returns the luminance texture
  76600. */
  76601. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  76602. /**
  76603. * Creates a luminance alpha texture from some data.
  76604. * @param data Define the texture data
  76605. * @param width Define the width of the texture
  76606. * @param height Define the height of the texture
  76607. * @param scene Define the scene the texture belongs to
  76608. * @param generateMipMaps Define whether or not to create mip maps for the texture
  76609. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76610. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76611. * @returns the luminance alpha texture
  76612. */
  76613. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  76614. /**
  76615. * Creates an alpha texture from some data.
  76616. * @param data Define the texture data
  76617. * @param width Define the width of the texture
  76618. * @param height Define the height of the texture
  76619. * @param scene Define the scene the texture belongs to
  76620. * @param generateMipMaps Define whether or not to create mip maps for the texture
  76621. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76622. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76623. * @returns the alpha texture
  76624. */
  76625. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  76626. /**
  76627. * Creates a RGB texture from some data.
  76628. * @param data Define the texture data
  76629. * @param width Define the width of the texture
  76630. * @param height Define the height of the texture
  76631. * @param scene Define the scene the texture belongs to
  76632. * @param generateMipMaps Define whether or not to create mip maps for the texture
  76633. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76634. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76635. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  76636. * @returns the RGB alpha texture
  76637. */
  76638. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  76639. /**
  76640. * Creates a RGBA texture from some data.
  76641. * @param data Define the texture data
  76642. * @param width Define the width of the texture
  76643. * @param height Define the height of the texture
  76644. * @param scene Define the scene the texture belongs to
  76645. * @param generateMipMaps Define whether or not to create mip maps for the texture
  76646. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76647. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76648. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  76649. * @returns the RGBA texture
  76650. */
  76651. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  76652. /**
  76653. * Creates a R texture from some data.
  76654. * @param data Define the texture data
  76655. * @param width Define the width of the texture
  76656. * @param height Define the height of the texture
  76657. * @param scene Define the scene the texture belongs to
  76658. * @param generateMipMaps Define whether or not to create mip maps for the texture
  76659. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  76660. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  76661. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  76662. * @returns the R texture
  76663. */
  76664. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  76665. }
  76666. }
  76667. declare module BABYLON {
  76668. /**
  76669. * Interface for the size containing width and height
  76670. */
  76671. export interface ISize {
  76672. /**
  76673. * Width
  76674. */
  76675. width: number;
  76676. /**
  76677. * Heighht
  76678. */
  76679. height: number;
  76680. }
  76681. /**
  76682. * Size containing widht and height
  76683. */
  76684. export class Size implements ISize {
  76685. /**
  76686. * Width
  76687. */
  76688. width: number;
  76689. /**
  76690. * Height
  76691. */
  76692. height: number;
  76693. /**
  76694. * Creates a Size object from the given width and height (floats).
  76695. * @param width width of the new size
  76696. * @param height height of the new size
  76697. */
  76698. constructor(width: number, height: number);
  76699. /**
  76700. * Returns a string with the Size width and height
  76701. * @returns a string with the Size width and height
  76702. */
  76703. toString(): string;
  76704. /**
  76705. * "Size"
  76706. * @returns the string "Size"
  76707. */
  76708. getClassName(): string;
  76709. /**
  76710. * Returns the Size hash code.
  76711. * @returns a hash code for a unique width and height
  76712. */
  76713. getHashCode(): number;
  76714. /**
  76715. * Updates the current size from the given one.
  76716. * @param src the given size
  76717. */
  76718. copyFrom(src: Size): void;
  76719. /**
  76720. * Updates in place the current Size from the given floats.
  76721. * @param width width of the new size
  76722. * @param height height of the new size
  76723. * @returns the updated Size.
  76724. */
  76725. copyFromFloats(width: number, height: number): Size;
  76726. /**
  76727. * Updates in place the current Size from the given floats.
  76728. * @param width width to set
  76729. * @param height height to set
  76730. * @returns the updated Size.
  76731. */
  76732. set(width: number, height: number): Size;
  76733. /**
  76734. * Multiplies the width and height by numbers
  76735. * @param w factor to multiple the width by
  76736. * @param h factor to multiple the height by
  76737. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  76738. */
  76739. multiplyByFloats(w: number, h: number): Size;
  76740. /**
  76741. * Clones the size
  76742. * @returns a new Size copied from the given one.
  76743. */
  76744. clone(): Size;
  76745. /**
  76746. * True if the current Size and the given one width and height are strictly equal.
  76747. * @param other the other size to compare against
  76748. * @returns True if the current Size and the given one width and height are strictly equal.
  76749. */
  76750. equals(other: Size): boolean;
  76751. /**
  76752. * The surface of the Size : width * height (float).
  76753. */
  76754. readonly surface: number;
  76755. /**
  76756. * Create a new size of zero
  76757. * @returns a new Size set to (0.0, 0.0)
  76758. */
  76759. static Zero(): Size;
  76760. /**
  76761. * Sums the width and height of two sizes
  76762. * @param otherSize size to add to this size
  76763. * @returns a new Size set as the addition result of the current Size and the given one.
  76764. */
  76765. add(otherSize: Size): Size;
  76766. /**
  76767. * Subtracts the width and height of two
  76768. * @param otherSize size to subtract to this size
  76769. * @returns a new Size set as the subtraction result of the given one from the current Size.
  76770. */
  76771. subtract(otherSize: Size): Size;
  76772. /**
  76773. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  76774. * @param start starting size to lerp between
  76775. * @param end end size to lerp between
  76776. * @param amount amount to lerp between the start and end values
  76777. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  76778. */
  76779. static Lerp(start: Size, end: Size, amount: number): Size;
  76780. }
  76781. }
  76782. declare module BABYLON {
  76783. /**
  76784. * Defines a runtime animation
  76785. */
  76786. export class RuntimeAnimation {
  76787. private _events;
  76788. /**
  76789. * The current frame of the runtime animation
  76790. */
  76791. private _currentFrame;
  76792. /**
  76793. * The animation used by the runtime animation
  76794. */
  76795. private _animation;
  76796. /**
  76797. * The target of the runtime animation
  76798. */
  76799. private _target;
  76800. /**
  76801. * The initiating animatable
  76802. */
  76803. private _host;
  76804. /**
  76805. * The original value of the runtime animation
  76806. */
  76807. private _originalValue;
  76808. /**
  76809. * The original blend value of the runtime animation
  76810. */
  76811. private _originalBlendValue;
  76812. /**
  76813. * The offsets cache of the runtime animation
  76814. */
  76815. private _offsetsCache;
  76816. /**
  76817. * The high limits cache of the runtime animation
  76818. */
  76819. private _highLimitsCache;
  76820. /**
  76821. * Specifies if the runtime animation has been stopped
  76822. */
  76823. private _stopped;
  76824. /**
  76825. * The blending factor of the runtime animation
  76826. */
  76827. private _blendingFactor;
  76828. /**
  76829. * The BabylonJS scene
  76830. */
  76831. private _scene;
  76832. /**
  76833. * The current value of the runtime animation
  76834. */
  76835. private _currentValue;
  76836. /** @hidden */
  76837. _animationState: _IAnimationState;
  76838. /**
  76839. * The active target of the runtime animation
  76840. */
  76841. private _activeTargets;
  76842. private _currentActiveTarget;
  76843. private _directTarget;
  76844. /**
  76845. * The target path of the runtime animation
  76846. */
  76847. private _targetPath;
  76848. /**
  76849. * The weight of the runtime animation
  76850. */
  76851. private _weight;
  76852. /**
  76853. * The ratio offset of the runtime animation
  76854. */
  76855. private _ratioOffset;
  76856. /**
  76857. * The previous delay of the runtime animation
  76858. */
  76859. private _previousDelay;
  76860. /**
  76861. * The previous ratio of the runtime animation
  76862. */
  76863. private _previousRatio;
  76864. private _enableBlending;
  76865. private _keys;
  76866. private _minFrame;
  76867. private _maxFrame;
  76868. private _minValue;
  76869. private _maxValue;
  76870. private _targetIsArray;
  76871. /**
  76872. * Gets the current frame of the runtime animation
  76873. */
  76874. readonly currentFrame: number;
  76875. /**
  76876. * Gets the weight of the runtime animation
  76877. */
  76878. readonly weight: number;
  76879. /**
  76880. * Gets the current value of the runtime animation
  76881. */
  76882. readonly currentValue: any;
  76883. /**
  76884. * Gets the target path of the runtime animation
  76885. */
  76886. readonly targetPath: string;
  76887. /**
  76888. * Gets the actual target of the runtime animation
  76889. */
  76890. readonly target: any;
  76891. /** @hidden */
  76892. _onLoop: () => void;
  76893. /**
  76894. * Create a new RuntimeAnimation object
  76895. * @param target defines the target of the animation
  76896. * @param animation defines the source animation object
  76897. * @param scene defines the hosting scene
  76898. * @param host defines the initiating Animatable
  76899. */
  76900. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  76901. private _preparePath;
  76902. /**
  76903. * Gets the animation from the runtime animation
  76904. */
  76905. readonly animation: Animation;
  76906. /**
  76907. * Resets the runtime animation to the beginning
  76908. * @param restoreOriginal defines whether to restore the target property to the original value
  76909. */
  76910. reset(restoreOriginal?: boolean): void;
  76911. /**
  76912. * Specifies if the runtime animation is stopped
  76913. * @returns Boolean specifying if the runtime animation is stopped
  76914. */
  76915. isStopped(): boolean;
  76916. /**
  76917. * Disposes of the runtime animation
  76918. */
  76919. dispose(): void;
  76920. /**
  76921. * Apply the interpolated value to the target
  76922. * @param currentValue defines the value computed by the animation
  76923. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  76924. */
  76925. setValue(currentValue: any, weight: number): void;
  76926. private _getOriginalValues;
  76927. private _setValue;
  76928. /**
  76929. * Gets the loop pmode of the runtime animation
  76930. * @returns Loop Mode
  76931. */
  76932. private _getCorrectLoopMode;
  76933. /**
  76934. * Move the current animation to a given frame
  76935. * @param frame defines the frame to move to
  76936. */
  76937. goToFrame(frame: number): void;
  76938. /**
  76939. * @hidden Internal use only
  76940. */
  76941. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  76942. /**
  76943. * Execute the current animation
  76944. * @param delay defines the delay to add to the current frame
  76945. * @param from defines the lower bound of the animation range
  76946. * @param to defines the upper bound of the animation range
  76947. * @param loop defines if the current animation must loop
  76948. * @param speedRatio defines the current speed ratio
  76949. * @param weight defines the weight of the animation (default is -1 so no weight)
  76950. * @param onLoop optional callback called when animation loops
  76951. * @returns a boolean indicating if the animation is running
  76952. */
  76953. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  76954. }
  76955. }
  76956. declare module BABYLON {
  76957. /**
  76958. * Class used to store an actual running animation
  76959. */
  76960. export class Animatable {
  76961. /** defines the target object */
  76962. target: any;
  76963. /** defines the starting frame number (default is 0) */
  76964. fromFrame: number;
  76965. /** defines the ending frame number (default is 100) */
  76966. toFrame: number;
  76967. /** defines if the animation must loop (default is false) */
  76968. loopAnimation: boolean;
  76969. /** defines a callback to call when animation ends if it is not looping */
  76970. onAnimationEnd?: (() => void) | null | undefined;
  76971. /** defines a callback to call when animation loops */
  76972. onAnimationLoop?: (() => void) | null | undefined;
  76973. private _localDelayOffset;
  76974. private _pausedDelay;
  76975. private _runtimeAnimations;
  76976. private _paused;
  76977. private _scene;
  76978. private _speedRatio;
  76979. private _weight;
  76980. private _syncRoot;
  76981. /**
  76982. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  76983. * This will only apply for non looping animation (default is true)
  76984. */
  76985. disposeOnEnd: boolean;
  76986. /**
  76987. * Gets a boolean indicating if the animation has started
  76988. */
  76989. animationStarted: boolean;
  76990. /**
  76991. * Observer raised when the animation ends
  76992. */
  76993. onAnimationEndObservable: Observable<Animatable>;
  76994. /**
  76995. * Observer raised when the animation loops
  76996. */
  76997. onAnimationLoopObservable: Observable<Animatable>;
  76998. /**
  76999. * Gets the root Animatable used to synchronize and normalize animations
  77000. */
  77001. readonly syncRoot: Nullable<Animatable>;
  77002. /**
  77003. * Gets the current frame of the first RuntimeAnimation
  77004. * Used to synchronize Animatables
  77005. */
  77006. readonly masterFrame: number;
  77007. /**
  77008. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  77009. */
  77010. weight: number;
  77011. /**
  77012. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  77013. */
  77014. speedRatio: number;
  77015. /**
  77016. * Creates a new Animatable
  77017. * @param scene defines the hosting scene
  77018. * @param target defines the target object
  77019. * @param fromFrame defines the starting frame number (default is 0)
  77020. * @param toFrame defines the ending frame number (default is 100)
  77021. * @param loopAnimation defines if the animation must loop (default is false)
  77022. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  77023. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  77024. * @param animations defines a group of animation to add to the new Animatable
  77025. * @param onAnimationLoop defines a callback to call when animation loops
  77026. */
  77027. constructor(scene: Scene,
  77028. /** defines the target object */
  77029. target: any,
  77030. /** defines the starting frame number (default is 0) */
  77031. fromFrame?: number,
  77032. /** defines the ending frame number (default is 100) */
  77033. toFrame?: number,
  77034. /** defines if the animation must loop (default is false) */
  77035. loopAnimation?: boolean, speedRatio?: number,
  77036. /** defines a callback to call when animation ends if it is not looping */
  77037. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  77038. /** defines a callback to call when animation loops */
  77039. onAnimationLoop?: (() => void) | null | undefined);
  77040. /**
  77041. * Synchronize and normalize current Animatable with a source Animatable
  77042. * This is useful when using animation weights and when animations are not of the same length
  77043. * @param root defines the root Animatable to synchronize with
  77044. * @returns the current Animatable
  77045. */
  77046. syncWith(root: Animatable): Animatable;
  77047. /**
  77048. * Gets the list of runtime animations
  77049. * @returns an array of RuntimeAnimation
  77050. */
  77051. getAnimations(): RuntimeAnimation[];
  77052. /**
  77053. * Adds more animations to the current animatable
  77054. * @param target defines the target of the animations
  77055. * @param animations defines the new animations to add
  77056. */
  77057. appendAnimations(target: any, animations: Animation[]): void;
  77058. /**
  77059. * Gets the source animation for a specific property
  77060. * @param property defines the propertyu to look for
  77061. * @returns null or the source animation for the given property
  77062. */
  77063. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  77064. /**
  77065. * Gets the runtime animation for a specific property
  77066. * @param property defines the propertyu to look for
  77067. * @returns null or the runtime animation for the given property
  77068. */
  77069. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  77070. /**
  77071. * Resets the animatable to its original state
  77072. */
  77073. reset(): void;
  77074. /**
  77075. * Allows the animatable to blend with current running animations
  77076. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  77077. * @param blendingSpeed defines the blending speed to use
  77078. */
  77079. enableBlending(blendingSpeed: number): void;
  77080. /**
  77081. * Disable animation blending
  77082. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  77083. */
  77084. disableBlending(): void;
  77085. /**
  77086. * Jump directly to a given frame
  77087. * @param frame defines the frame to jump to
  77088. */
  77089. goToFrame(frame: number): void;
  77090. /**
  77091. * Pause the animation
  77092. */
  77093. pause(): void;
  77094. /**
  77095. * Restart the animation
  77096. */
  77097. restart(): void;
  77098. private _raiseOnAnimationEnd;
  77099. /**
  77100. * Stop and delete the current animation
  77101. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  77102. * @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)
  77103. */
  77104. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  77105. /**
  77106. * Wait asynchronously for the animation to end
  77107. * @returns a promise which will be fullfilled when the animation ends
  77108. */
  77109. waitAsync(): Promise<Animatable>;
  77110. /** @hidden */
  77111. _animate(delay: number): boolean;
  77112. }
  77113. interface Scene {
  77114. /** @hidden */
  77115. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  77116. /** @hidden */
  77117. _processLateAnimationBindingsForMatrices(holder: {
  77118. totalWeight: number;
  77119. animations: RuntimeAnimation[];
  77120. originalValue: Matrix;
  77121. }): any;
  77122. /** @hidden */
  77123. _processLateAnimationBindingsForQuaternions(holder: {
  77124. totalWeight: number;
  77125. animations: RuntimeAnimation[];
  77126. originalValue: Quaternion;
  77127. }, refQuaternion: Quaternion): Quaternion;
  77128. /** @hidden */
  77129. _processLateAnimationBindings(): void;
  77130. /**
  77131. * Will start the animation sequence of a given target
  77132. * @param target defines the target
  77133. * @param from defines from which frame should animation start
  77134. * @param to defines until which frame should animation run.
  77135. * @param weight defines the weight to apply to the animation (1.0 by default)
  77136. * @param loop defines if the animation loops
  77137. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  77138. * @param onAnimationEnd defines the function to be executed when the animation ends
  77139. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  77140. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  77141. * @param onAnimationLoop defines the callback to call when an animation loops
  77142. * @returns the animatable object created for this animation
  77143. */
  77144. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  77145. /**
  77146. * Will start the animation sequence of a given target
  77147. * @param target defines the target
  77148. * @param from defines from which frame should animation start
  77149. * @param to defines until which frame should animation run.
  77150. * @param loop defines if the animation loops
  77151. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  77152. * @param onAnimationEnd defines the function to be executed when the animation ends
  77153. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  77154. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  77155. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  77156. * @param onAnimationLoop defines the callback to call when an animation loops
  77157. * @returns the animatable object created for this animation
  77158. */
  77159. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  77160. /**
  77161. * Will start the animation sequence of a given target and its hierarchy
  77162. * @param target defines the target
  77163. * @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.
  77164. * @param from defines from which frame should animation start
  77165. * @param to defines until which frame should animation run.
  77166. * @param loop defines if the animation loops
  77167. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  77168. * @param onAnimationEnd defines the function to be executed when the animation ends
  77169. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  77170. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  77171. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  77172. * @param onAnimationLoop defines the callback to call when an animation loops
  77173. * @returns the list of created animatables
  77174. */
  77175. 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[];
  77176. /**
  77177. * Begin a new animation on a given node
  77178. * @param target defines the target where the animation will take place
  77179. * @param animations defines the list of animations to start
  77180. * @param from defines the initial value
  77181. * @param to defines the final value
  77182. * @param loop defines if you want animation to loop (off by default)
  77183. * @param speedRatio defines the speed ratio to apply to all animations
  77184. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  77185. * @param onAnimationLoop defines the callback to call when an animation loops
  77186. * @returns the list of created animatables
  77187. */
  77188. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  77189. /**
  77190. * Begin a new animation on a given node and its hierarchy
  77191. * @param target defines the root node where the animation will take place
  77192. * @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.
  77193. * @param animations defines the list of animations to start
  77194. * @param from defines the initial value
  77195. * @param to defines the final value
  77196. * @param loop defines if you want animation to loop (off by default)
  77197. * @param speedRatio defines the speed ratio to apply to all animations
  77198. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  77199. * @param onAnimationLoop defines the callback to call when an animation loops
  77200. * @returns the list of animatables created for all nodes
  77201. */
  77202. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  77203. /**
  77204. * Gets the animatable associated with a specific target
  77205. * @param target defines the target of the animatable
  77206. * @returns the required animatable if found
  77207. */
  77208. getAnimatableByTarget(target: any): Nullable<Animatable>;
  77209. /**
  77210. * Gets all animatables associated with a given target
  77211. * @param target defines the target to look animatables for
  77212. * @returns an array of Animatables
  77213. */
  77214. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  77215. /**
  77216. * Stops and removes all animations that have been applied to the scene
  77217. */
  77218. stopAllAnimations(): void;
  77219. }
  77220. interface Bone {
  77221. /**
  77222. * Copy an animation range from another bone
  77223. * @param source defines the source bone
  77224. * @param rangeName defines the range name to copy
  77225. * @param frameOffset defines the frame offset
  77226. * @param rescaleAsRequired defines if rescaling must be applied if required
  77227. * @param skelDimensionsRatio defines the scaling ratio
  77228. * @returns true if operation was successful
  77229. */
  77230. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  77231. }
  77232. }
  77233. declare module BABYLON {
  77234. /**
  77235. * Class used to override all child animations of a given target
  77236. */
  77237. export class AnimationPropertiesOverride {
  77238. /**
  77239. * Gets or sets a value indicating if animation blending must be used
  77240. */
  77241. enableBlending: boolean;
  77242. /**
  77243. * Gets or sets the blending speed to use when enableBlending is true
  77244. */
  77245. blendingSpeed: number;
  77246. /**
  77247. * Gets or sets the default loop mode to use
  77248. */
  77249. loopMode: number;
  77250. }
  77251. }
  77252. declare module BABYLON {
  77253. /**
  77254. * Class used to handle skinning animations
  77255. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  77256. */
  77257. export class Skeleton implements IAnimatable {
  77258. /** defines the skeleton name */
  77259. name: string;
  77260. /** defines the skeleton Id */
  77261. id: string;
  77262. /**
  77263. * Defines the list of child bones
  77264. */
  77265. bones: Bone[];
  77266. /**
  77267. * Defines an estimate of the dimension of the skeleton at rest
  77268. */
  77269. dimensionsAtRest: Vector3;
  77270. /**
  77271. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  77272. */
  77273. needInitialSkinMatrix: boolean;
  77274. /**
  77275. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  77276. */
  77277. overrideMesh: Nullable<AbstractMesh>;
  77278. /**
  77279. * Gets the list of animations attached to this skeleton
  77280. */
  77281. animations: Array<Animation>;
  77282. private _scene;
  77283. private _isDirty;
  77284. private _transformMatrices;
  77285. private _transformMatrixTexture;
  77286. private _meshesWithPoseMatrix;
  77287. private _animatables;
  77288. private _identity;
  77289. private _synchronizedWithMesh;
  77290. private _ranges;
  77291. private _lastAbsoluteTransformsUpdateId;
  77292. private _canUseTextureForBones;
  77293. private _uniqueId;
  77294. /** @hidden */
  77295. _numBonesWithLinkedTransformNode: number;
  77296. /** @hidden */
  77297. _hasWaitingData: Nullable<boolean>;
  77298. /**
  77299. * Specifies if the skeleton should be serialized
  77300. */
  77301. doNotSerialize: boolean;
  77302. private _useTextureToStoreBoneMatrices;
  77303. /**
  77304. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  77305. * Please note that this option is not available if the hardware does not support it
  77306. */
  77307. useTextureToStoreBoneMatrices: boolean;
  77308. private _animationPropertiesOverride;
  77309. /**
  77310. * Gets or sets the animation properties override
  77311. */
  77312. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  77313. /**
  77314. * List of inspectable custom properties (used by the Inspector)
  77315. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  77316. */
  77317. inspectableCustomProperties: IInspectable[];
  77318. /**
  77319. * An observable triggered before computing the skeleton's matrices
  77320. */
  77321. onBeforeComputeObservable: Observable<Skeleton>;
  77322. /**
  77323. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  77324. */
  77325. readonly isUsingTextureForMatrices: boolean;
  77326. /**
  77327. * Gets the unique ID of this skeleton
  77328. */
  77329. readonly uniqueId: number;
  77330. /**
  77331. * Creates a new skeleton
  77332. * @param name defines the skeleton name
  77333. * @param id defines the skeleton Id
  77334. * @param scene defines the hosting scene
  77335. */
  77336. constructor(
  77337. /** defines the skeleton name */
  77338. name: string,
  77339. /** defines the skeleton Id */
  77340. id: string, scene: Scene);
  77341. /**
  77342. * Gets the current object class name.
  77343. * @return the class name
  77344. */
  77345. getClassName(): string;
  77346. /**
  77347. * Returns an array containing the root bones
  77348. * @returns an array containing the root bones
  77349. */
  77350. getChildren(): Array<Bone>;
  77351. /**
  77352. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  77353. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  77354. * @returns a Float32Array containing matrices data
  77355. */
  77356. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  77357. /**
  77358. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  77359. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  77360. * @returns a raw texture containing the data
  77361. */
  77362. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  77363. /**
  77364. * Gets the current hosting scene
  77365. * @returns a scene object
  77366. */
  77367. getScene(): Scene;
  77368. /**
  77369. * Gets a string representing the current skeleton data
  77370. * @param fullDetails defines a boolean indicating if we want a verbose version
  77371. * @returns a string representing the current skeleton data
  77372. */
  77373. toString(fullDetails?: boolean): string;
  77374. /**
  77375. * Get bone's index searching by name
  77376. * @param name defines bone's name to search for
  77377. * @return the indice of the bone. Returns -1 if not found
  77378. */
  77379. getBoneIndexByName(name: string): number;
  77380. /**
  77381. * Creater a new animation range
  77382. * @param name defines the name of the range
  77383. * @param from defines the start key
  77384. * @param to defines the end key
  77385. */
  77386. createAnimationRange(name: string, from: number, to: number): void;
  77387. /**
  77388. * Delete a specific animation range
  77389. * @param name defines the name of the range
  77390. * @param deleteFrames defines if frames must be removed as well
  77391. */
  77392. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  77393. /**
  77394. * Gets a specific animation range
  77395. * @param name defines the name of the range to look for
  77396. * @returns the requested animation range or null if not found
  77397. */
  77398. getAnimationRange(name: string): Nullable<AnimationRange>;
  77399. /**
  77400. * Gets the list of all animation ranges defined on this skeleton
  77401. * @returns an array
  77402. */
  77403. getAnimationRanges(): Nullable<AnimationRange>[];
  77404. /**
  77405. * Copy animation range from a source skeleton.
  77406. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  77407. * @param source defines the source skeleton
  77408. * @param name defines the name of the range to copy
  77409. * @param rescaleAsRequired defines if rescaling must be applied if required
  77410. * @returns true if operation was successful
  77411. */
  77412. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  77413. /**
  77414. * Forces the skeleton to go to rest pose
  77415. */
  77416. returnToRest(): void;
  77417. private _getHighestAnimationFrame;
  77418. /**
  77419. * Begin a specific animation range
  77420. * @param name defines the name of the range to start
  77421. * @param loop defines if looping must be turned on (false by default)
  77422. * @param speedRatio defines the speed ratio to apply (1 by default)
  77423. * @param onAnimationEnd defines a callback which will be called when animation will end
  77424. * @returns a new animatable
  77425. */
  77426. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  77427. /** @hidden */
  77428. _markAsDirty(): void;
  77429. /** @hidden */
  77430. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  77431. /** @hidden */
  77432. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  77433. private _computeTransformMatrices;
  77434. /**
  77435. * Build all resources required to render a skeleton
  77436. */
  77437. prepare(): void;
  77438. /**
  77439. * Gets the list of animatables currently running for this skeleton
  77440. * @returns an array of animatables
  77441. */
  77442. getAnimatables(): IAnimatable[];
  77443. /**
  77444. * Clone the current skeleton
  77445. * @param name defines the name of the new skeleton
  77446. * @param id defines the id of the new skeleton
  77447. * @returns the new skeleton
  77448. */
  77449. clone(name: string, id: string): Skeleton;
  77450. /**
  77451. * Enable animation blending for this skeleton
  77452. * @param blendingSpeed defines the blending speed to apply
  77453. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  77454. */
  77455. enableBlending(blendingSpeed?: number): void;
  77456. /**
  77457. * Releases all resources associated with the current skeleton
  77458. */
  77459. dispose(): void;
  77460. /**
  77461. * Serialize the skeleton in a JSON object
  77462. * @returns a JSON object
  77463. */
  77464. serialize(): any;
  77465. /**
  77466. * Creates a new skeleton from serialized data
  77467. * @param parsedSkeleton defines the serialized data
  77468. * @param scene defines the hosting scene
  77469. * @returns a new skeleton
  77470. */
  77471. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  77472. /**
  77473. * Compute all node absolute transforms
  77474. * @param forceUpdate defines if computation must be done even if cache is up to date
  77475. */
  77476. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  77477. /**
  77478. * Gets the root pose matrix
  77479. * @returns a matrix
  77480. */
  77481. getPoseMatrix(): Nullable<Matrix>;
  77482. /**
  77483. * Sorts bones per internal index
  77484. */
  77485. sortBones(): void;
  77486. private _sortBones;
  77487. }
  77488. }
  77489. declare module BABYLON {
  77490. /**
  77491. * Class used to store bone information
  77492. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  77493. */
  77494. export class Bone extends Node {
  77495. /**
  77496. * defines the bone name
  77497. */
  77498. name: string;
  77499. private static _tmpVecs;
  77500. private static _tmpQuat;
  77501. private static _tmpMats;
  77502. /**
  77503. * Gets the list of child bones
  77504. */
  77505. children: Bone[];
  77506. /** Gets the animations associated with this bone */
  77507. animations: Animation[];
  77508. /**
  77509. * Gets or sets bone length
  77510. */
  77511. length: number;
  77512. /**
  77513. * @hidden Internal only
  77514. * Set this value to map this bone to a different index in the transform matrices
  77515. * Set this value to -1 to exclude the bone from the transform matrices
  77516. */
  77517. _index: Nullable<number>;
  77518. private _skeleton;
  77519. private _localMatrix;
  77520. private _restPose;
  77521. private _baseMatrix;
  77522. private _absoluteTransform;
  77523. private _invertedAbsoluteTransform;
  77524. private _parent;
  77525. private _scalingDeterminant;
  77526. private _worldTransform;
  77527. private _localScaling;
  77528. private _localRotation;
  77529. private _localPosition;
  77530. private _needToDecompose;
  77531. private _needToCompose;
  77532. /** @hidden */
  77533. _linkedTransformNode: Nullable<TransformNode>;
  77534. /** @hidden */
  77535. _waitingTransformNodeId: Nullable<string>;
  77536. /** @hidden */
  77537. /** @hidden */
  77538. _matrix: Matrix;
  77539. /**
  77540. * Create a new bone
  77541. * @param name defines the bone name
  77542. * @param skeleton defines the parent skeleton
  77543. * @param parentBone defines the parent (can be null if the bone is the root)
  77544. * @param localMatrix defines the local matrix
  77545. * @param restPose defines the rest pose matrix
  77546. * @param baseMatrix defines the base matrix
  77547. * @param index defines index of the bone in the hiearchy
  77548. */
  77549. constructor(
  77550. /**
  77551. * defines the bone name
  77552. */
  77553. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  77554. /**
  77555. * Gets the current object class name.
  77556. * @return the class name
  77557. */
  77558. getClassName(): string;
  77559. /**
  77560. * Gets the parent skeleton
  77561. * @returns a skeleton
  77562. */
  77563. getSkeleton(): Skeleton;
  77564. /**
  77565. * Gets parent bone
  77566. * @returns a bone or null if the bone is the root of the bone hierarchy
  77567. */
  77568. getParent(): Nullable<Bone>;
  77569. /**
  77570. * Returns an array containing the root bones
  77571. * @returns an array containing the root bones
  77572. */
  77573. getChildren(): Array<Bone>;
  77574. /**
  77575. * Sets the parent bone
  77576. * @param parent defines the parent (can be null if the bone is the root)
  77577. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  77578. */
  77579. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  77580. /**
  77581. * Gets the local matrix
  77582. * @returns a matrix
  77583. */
  77584. getLocalMatrix(): Matrix;
  77585. /**
  77586. * Gets the base matrix (initial matrix which remains unchanged)
  77587. * @returns a matrix
  77588. */
  77589. getBaseMatrix(): Matrix;
  77590. /**
  77591. * Gets the rest pose matrix
  77592. * @returns a matrix
  77593. */
  77594. getRestPose(): Matrix;
  77595. /**
  77596. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  77597. */
  77598. getWorldMatrix(): Matrix;
  77599. /**
  77600. * Sets the local matrix to rest pose matrix
  77601. */
  77602. returnToRest(): void;
  77603. /**
  77604. * Gets the inverse of the absolute transform matrix.
  77605. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  77606. * @returns a matrix
  77607. */
  77608. getInvertedAbsoluteTransform(): Matrix;
  77609. /**
  77610. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  77611. * @returns a matrix
  77612. */
  77613. getAbsoluteTransform(): Matrix;
  77614. /**
  77615. * Links with the given transform node.
  77616. * The local matrix of this bone is copied from the transform node every frame.
  77617. * @param transformNode defines the transform node to link to
  77618. */
  77619. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  77620. /**
  77621. * Gets the node used to drive the bone's transformation
  77622. * @returns a transform node or null
  77623. */
  77624. getTransformNode(): Nullable<TransformNode>;
  77625. /** Gets or sets current position (in local space) */
  77626. position: Vector3;
  77627. /** Gets or sets current rotation (in local space) */
  77628. rotation: Vector3;
  77629. /** Gets or sets current rotation quaternion (in local space) */
  77630. rotationQuaternion: Quaternion;
  77631. /** Gets or sets current scaling (in local space) */
  77632. scaling: Vector3;
  77633. /**
  77634. * Gets the animation properties override
  77635. */
  77636. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  77637. private _decompose;
  77638. private _compose;
  77639. /**
  77640. * Update the base and local matrices
  77641. * @param matrix defines the new base or local matrix
  77642. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  77643. * @param updateLocalMatrix defines if the local matrix should be updated
  77644. */
  77645. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  77646. /** @hidden */
  77647. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  77648. /**
  77649. * Flag the bone as dirty (Forcing it to update everything)
  77650. */
  77651. markAsDirty(): void;
  77652. /** @hidden */
  77653. _markAsDirtyAndCompose(): void;
  77654. private _markAsDirtyAndDecompose;
  77655. /**
  77656. * Translate the bone in local or world space
  77657. * @param vec The amount to translate the bone
  77658. * @param space The space that the translation is in
  77659. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77660. */
  77661. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  77662. /**
  77663. * Set the postion of the bone in local or world space
  77664. * @param position The position to set the bone
  77665. * @param space The space that the position is in
  77666. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77667. */
  77668. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  77669. /**
  77670. * Set the absolute position of the bone (world space)
  77671. * @param position The position to set the bone
  77672. * @param mesh The mesh that this bone is attached to
  77673. */
  77674. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  77675. /**
  77676. * Scale the bone on the x, y and z axes (in local space)
  77677. * @param x The amount to scale the bone on the x axis
  77678. * @param y The amount to scale the bone on the y axis
  77679. * @param z The amount to scale the bone on the z axis
  77680. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  77681. */
  77682. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  77683. /**
  77684. * Set the bone scaling in local space
  77685. * @param scale defines the scaling vector
  77686. */
  77687. setScale(scale: Vector3): void;
  77688. /**
  77689. * Gets the current scaling in local space
  77690. * @returns the current scaling vector
  77691. */
  77692. getScale(): Vector3;
  77693. /**
  77694. * Gets the current scaling in local space and stores it in a target vector
  77695. * @param result defines the target vector
  77696. */
  77697. getScaleToRef(result: Vector3): void;
  77698. /**
  77699. * Set the yaw, pitch, and roll of the bone in local or world space
  77700. * @param yaw The rotation of the bone on the y axis
  77701. * @param pitch The rotation of the bone on the x axis
  77702. * @param roll The rotation of the bone on the z axis
  77703. * @param space The space that the axes of rotation are in
  77704. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77705. */
  77706. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  77707. /**
  77708. * Add a rotation to the bone on an axis in local or world space
  77709. * @param axis The axis to rotate the bone on
  77710. * @param amount The amount to rotate the bone
  77711. * @param space The space that the axis is in
  77712. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77713. */
  77714. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  77715. /**
  77716. * Set the rotation of the bone to a particular axis angle in local or world space
  77717. * @param axis The axis to rotate the bone on
  77718. * @param angle The angle that the bone should be rotated to
  77719. * @param space The space that the axis is in
  77720. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77721. */
  77722. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  77723. /**
  77724. * Set the euler rotation of the bone in local of world space
  77725. * @param rotation The euler rotation that the bone should be set to
  77726. * @param space The space that the rotation is in
  77727. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77728. */
  77729. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  77730. /**
  77731. * Set the quaternion rotation of the bone in local of world space
  77732. * @param quat The quaternion rotation that the bone should be set to
  77733. * @param space The space that the rotation is in
  77734. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77735. */
  77736. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  77737. /**
  77738. * Set the rotation matrix of the bone in local of world space
  77739. * @param rotMat The rotation matrix that the bone should be set to
  77740. * @param space The space that the rotation is in
  77741. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77742. */
  77743. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  77744. private _rotateWithMatrix;
  77745. private _getNegativeRotationToRef;
  77746. /**
  77747. * Get the position of the bone in local or world space
  77748. * @param space The space that the returned position is in
  77749. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77750. * @returns The position of the bone
  77751. */
  77752. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  77753. /**
  77754. * Copy the position of the bone to a vector3 in local or world space
  77755. * @param space The space that the returned position is in
  77756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77757. * @param result The vector3 to copy the position to
  77758. */
  77759. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  77760. /**
  77761. * Get the absolute position of the bone (world space)
  77762. * @param mesh The mesh that this bone is attached to
  77763. * @returns The absolute position of the bone
  77764. */
  77765. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  77766. /**
  77767. * Copy the absolute position of the bone (world space) to the result param
  77768. * @param mesh The mesh that this bone is attached to
  77769. * @param result The vector3 to copy the absolute position to
  77770. */
  77771. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  77772. /**
  77773. * Compute the absolute transforms of this bone and its children
  77774. */
  77775. computeAbsoluteTransforms(): void;
  77776. /**
  77777. * Get the world direction from an axis that is in the local space of the bone
  77778. * @param localAxis The local direction that is used to compute the world direction
  77779. * @param mesh The mesh that this bone is attached to
  77780. * @returns The world direction
  77781. */
  77782. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  77783. /**
  77784. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  77785. * @param localAxis The local direction that is used to compute the world direction
  77786. * @param mesh The mesh that this bone is attached to
  77787. * @param result The vector3 that the world direction will be copied to
  77788. */
  77789. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  77790. /**
  77791. * Get the euler rotation of the bone in local or world space
  77792. * @param space The space that the rotation should be in
  77793. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77794. * @returns The euler rotation
  77795. */
  77796. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  77797. /**
  77798. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  77799. * @param space The space that the rotation should be in
  77800. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77801. * @param result The vector3 that the rotation should be copied to
  77802. */
  77803. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  77804. /**
  77805. * Get the quaternion rotation of the bone in either local or world space
  77806. * @param space The space that the rotation should be in
  77807. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77808. * @returns The quaternion rotation
  77809. */
  77810. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  77811. /**
  77812. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  77813. * @param space The space that the rotation should be in
  77814. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77815. * @param result The quaternion that the rotation should be copied to
  77816. */
  77817. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  77818. /**
  77819. * Get the rotation matrix of the bone in local or world space
  77820. * @param space The space that the rotation should be in
  77821. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77822. * @returns The rotation matrix
  77823. */
  77824. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  77825. /**
  77826. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  77827. * @param space The space that the rotation should be in
  77828. * @param mesh The mesh that this bone is attached to. This is only used in world space
  77829. * @param result The quaternion that the rotation should be copied to
  77830. */
  77831. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  77832. /**
  77833. * Get the world position of a point that is in the local space of the bone
  77834. * @param position The local position
  77835. * @param mesh The mesh that this bone is attached to
  77836. * @returns The world position
  77837. */
  77838. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  77839. /**
  77840. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  77841. * @param position The local position
  77842. * @param mesh The mesh that this bone is attached to
  77843. * @param result The vector3 that the world position should be copied to
  77844. */
  77845. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  77846. /**
  77847. * Get the local position of a point that is in world space
  77848. * @param position The world position
  77849. * @param mesh The mesh that this bone is attached to
  77850. * @returns The local position
  77851. */
  77852. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  77853. /**
  77854. * Get the local position of a point that is in world space and copy it to the result param
  77855. * @param position The world position
  77856. * @param mesh The mesh that this bone is attached to
  77857. * @param result The vector3 that the local position should be copied to
  77858. */
  77859. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  77860. }
  77861. }
  77862. declare module BABYLON {
  77863. /**
  77864. * 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.
  77865. * @see https://doc.babylonjs.com/how_to/transformnode
  77866. */
  77867. export class TransformNode extends Node {
  77868. /**
  77869. * Object will not rotate to face the camera
  77870. */
  77871. static BILLBOARDMODE_NONE: number;
  77872. /**
  77873. * Object will rotate to face the camera but only on the x axis
  77874. */
  77875. static BILLBOARDMODE_X: number;
  77876. /**
  77877. * Object will rotate to face the camera but only on the y axis
  77878. */
  77879. static BILLBOARDMODE_Y: number;
  77880. /**
  77881. * Object will rotate to face the camera but only on the z axis
  77882. */
  77883. static BILLBOARDMODE_Z: number;
  77884. /**
  77885. * Object will rotate to face the camera
  77886. */
  77887. static BILLBOARDMODE_ALL: number;
  77888. /**
  77889. * Object will rotate to face the camera's position instead of orientation
  77890. */
  77891. static BILLBOARDMODE_USE_POSITION: number;
  77892. private _forward;
  77893. private _forwardInverted;
  77894. private _up;
  77895. private _right;
  77896. private _rightInverted;
  77897. private _position;
  77898. private _rotation;
  77899. private _rotationQuaternion;
  77900. protected _scaling: Vector3;
  77901. protected _isDirty: boolean;
  77902. private _transformToBoneReferal;
  77903. private _isAbsoluteSynced;
  77904. private _billboardMode;
  77905. /**
  77906. * Gets or sets the billboard mode. Default is 0.
  77907. *
  77908. * | Value | Type | Description |
  77909. * | --- | --- | --- |
  77910. * | 0 | BILLBOARDMODE_NONE | |
  77911. * | 1 | BILLBOARDMODE_X | |
  77912. * | 2 | BILLBOARDMODE_Y | |
  77913. * | 4 | BILLBOARDMODE_Z | |
  77914. * | 7 | BILLBOARDMODE_ALL | |
  77915. *
  77916. */
  77917. billboardMode: number;
  77918. private _preserveParentRotationForBillboard;
  77919. /**
  77920. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  77921. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  77922. */
  77923. preserveParentRotationForBillboard: boolean;
  77924. /**
  77925. * 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
  77926. */
  77927. scalingDeterminant: number;
  77928. private _infiniteDistance;
  77929. /**
  77930. * Gets or sets the distance of the object to max, often used by skybox
  77931. */
  77932. infiniteDistance: boolean;
  77933. /**
  77934. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  77935. * By default the system will update normals to compensate
  77936. */
  77937. ignoreNonUniformScaling: boolean;
  77938. /**
  77939. * 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
  77940. */
  77941. reIntegrateRotationIntoRotationQuaternion: boolean;
  77942. /** @hidden */
  77943. _poseMatrix: Nullable<Matrix>;
  77944. /** @hidden */
  77945. _localMatrix: Matrix;
  77946. private _usePivotMatrix;
  77947. private _absolutePosition;
  77948. private _absoluteScaling;
  77949. private _absoluteRotationQuaternion;
  77950. private _pivotMatrix;
  77951. private _pivotMatrixInverse;
  77952. protected _postMultiplyPivotMatrix: boolean;
  77953. protected _isWorldMatrixFrozen: boolean;
  77954. /** @hidden */
  77955. _indexInSceneTransformNodesArray: number;
  77956. /**
  77957. * An event triggered after the world matrix is updated
  77958. */
  77959. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  77960. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  77961. /**
  77962. * Gets a string identifying the name of the class
  77963. * @returns "TransformNode" string
  77964. */
  77965. getClassName(): string;
  77966. /**
  77967. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  77968. */
  77969. position: Vector3;
  77970. /**
  77971. * 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)).
  77972. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  77973. */
  77974. rotation: Vector3;
  77975. /**
  77976. * 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)).
  77977. */
  77978. scaling: Vector3;
  77979. /**
  77980. * 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).
  77981. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  77982. */
  77983. rotationQuaternion: Nullable<Quaternion>;
  77984. /**
  77985. * The forward direction of that transform in world space.
  77986. */
  77987. readonly forward: Vector3;
  77988. /**
  77989. * The up direction of that transform in world space.
  77990. */
  77991. readonly up: Vector3;
  77992. /**
  77993. * The right direction of that transform in world space.
  77994. */
  77995. readonly right: Vector3;
  77996. /**
  77997. * Copies the parameter passed Matrix into the mesh Pose matrix.
  77998. * @param matrix the matrix to copy the pose from
  77999. * @returns this TransformNode.
  78000. */
  78001. updatePoseMatrix(matrix: Matrix): TransformNode;
  78002. /**
  78003. * Returns the mesh Pose matrix.
  78004. * @returns the pose matrix
  78005. */
  78006. getPoseMatrix(): Matrix;
  78007. /** @hidden */
  78008. _isSynchronized(): boolean;
  78009. /** @hidden */
  78010. _initCache(): void;
  78011. /**
  78012. * Flag the transform node as dirty (Forcing it to update everything)
  78013. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  78014. * @returns this transform node
  78015. */
  78016. markAsDirty(property: string): TransformNode;
  78017. /**
  78018. * Returns the current mesh absolute position.
  78019. * Returns a Vector3.
  78020. */
  78021. readonly absolutePosition: Vector3;
  78022. /**
  78023. * Returns the current mesh absolute scaling.
  78024. * Returns a Vector3.
  78025. */
  78026. readonly absoluteScaling: Vector3;
  78027. /**
  78028. * Returns the current mesh absolute rotation.
  78029. * Returns a Quaternion.
  78030. */
  78031. readonly absoluteRotationQuaternion: Quaternion;
  78032. /**
  78033. * Sets a new matrix to apply before all other transformation
  78034. * @param matrix defines the transform matrix
  78035. * @returns the current TransformNode
  78036. */
  78037. setPreTransformMatrix(matrix: Matrix): TransformNode;
  78038. /**
  78039. * Sets a new pivot matrix to the current node
  78040. * @param matrix defines the new pivot matrix to use
  78041. * @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
  78042. * @returns the current TransformNode
  78043. */
  78044. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  78045. /**
  78046. * Returns the mesh pivot matrix.
  78047. * Default : Identity.
  78048. * @returns the matrix
  78049. */
  78050. getPivotMatrix(): Matrix;
  78051. /**
  78052. * Prevents the World matrix to be computed any longer.
  78053. * @returns the TransformNode.
  78054. */
  78055. freezeWorldMatrix(): TransformNode;
  78056. /**
  78057. * Allows back the World matrix computation.
  78058. * @returns the TransformNode.
  78059. */
  78060. unfreezeWorldMatrix(): this;
  78061. /**
  78062. * True if the World matrix has been frozen.
  78063. */
  78064. readonly isWorldMatrixFrozen: boolean;
  78065. /**
  78066. * Retuns the mesh absolute position in the World.
  78067. * @returns a Vector3.
  78068. */
  78069. getAbsolutePosition(): Vector3;
  78070. /**
  78071. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  78072. * @param absolutePosition the absolute position to set
  78073. * @returns the TransformNode.
  78074. */
  78075. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  78076. /**
  78077. * Sets the mesh position in its local space.
  78078. * @param vector3 the position to set in localspace
  78079. * @returns the TransformNode.
  78080. */
  78081. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  78082. /**
  78083. * Returns the mesh position in the local space from the current World matrix values.
  78084. * @returns a new Vector3.
  78085. */
  78086. getPositionExpressedInLocalSpace(): Vector3;
  78087. /**
  78088. * Translates the mesh along the passed Vector3 in its local space.
  78089. * @param vector3 the distance to translate in localspace
  78090. * @returns the TransformNode.
  78091. */
  78092. locallyTranslate(vector3: Vector3): TransformNode;
  78093. private static _lookAtVectorCache;
  78094. /**
  78095. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  78096. * @param targetPoint the position (must be in same space as current mesh) to look at
  78097. * @param yawCor optional yaw (y-axis) correction in radians
  78098. * @param pitchCor optional pitch (x-axis) correction in radians
  78099. * @param rollCor optional roll (z-axis) correction in radians
  78100. * @param space the choosen space of the target
  78101. * @returns the TransformNode.
  78102. */
  78103. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  78104. /**
  78105. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  78106. * This Vector3 is expressed in the World space.
  78107. * @param localAxis axis to rotate
  78108. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  78109. */
  78110. getDirection(localAxis: Vector3): Vector3;
  78111. /**
  78112. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  78113. * localAxis is expressed in the mesh local space.
  78114. * result is computed in the Wordl space from the mesh World matrix.
  78115. * @param localAxis axis to rotate
  78116. * @param result the resulting transformnode
  78117. * @returns this TransformNode.
  78118. */
  78119. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  78120. /**
  78121. * Sets this transform node rotation to the given local axis.
  78122. * @param localAxis the axis in local space
  78123. * @param yawCor optional yaw (y-axis) correction in radians
  78124. * @param pitchCor optional pitch (x-axis) correction in radians
  78125. * @param rollCor optional roll (z-axis) correction in radians
  78126. * @returns this TransformNode
  78127. */
  78128. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  78129. /**
  78130. * Sets a new pivot point to the current node
  78131. * @param point defines the new pivot point to use
  78132. * @param space defines if the point is in world or local space (local by default)
  78133. * @returns the current TransformNode
  78134. */
  78135. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  78136. /**
  78137. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  78138. * @returns the pivot point
  78139. */
  78140. getPivotPoint(): Vector3;
  78141. /**
  78142. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  78143. * @param result the vector3 to store the result
  78144. * @returns this TransformNode.
  78145. */
  78146. getPivotPointToRef(result: Vector3): TransformNode;
  78147. /**
  78148. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  78149. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  78150. */
  78151. getAbsolutePivotPoint(): Vector3;
  78152. /**
  78153. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  78154. * @param result vector3 to store the result
  78155. * @returns this TransformNode.
  78156. */
  78157. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  78158. /**
  78159. * Defines the passed node as the parent of the current node.
  78160. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  78161. * @see https://doc.babylonjs.com/how_to/parenting
  78162. * @param node the node ot set as the parent
  78163. * @returns this TransformNode.
  78164. */
  78165. setParent(node: Nullable<Node>): TransformNode;
  78166. private _nonUniformScaling;
  78167. /**
  78168. * True if the scaling property of this object is non uniform eg. (1,2,1)
  78169. */
  78170. readonly nonUniformScaling: boolean;
  78171. /** @hidden */
  78172. _updateNonUniformScalingState(value: boolean): boolean;
  78173. /**
  78174. * Attach the current TransformNode to another TransformNode associated with a bone
  78175. * @param bone Bone affecting the TransformNode
  78176. * @param affectedTransformNode TransformNode associated with the bone
  78177. * @returns this object
  78178. */
  78179. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  78180. /**
  78181. * Detach the transform node if its associated with a bone
  78182. * @returns this object
  78183. */
  78184. detachFromBone(): TransformNode;
  78185. private static _rotationAxisCache;
  78186. /**
  78187. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  78188. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  78189. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  78190. * The passed axis is also normalized.
  78191. * @param axis the axis to rotate around
  78192. * @param amount the amount to rotate in radians
  78193. * @param space Space to rotate in (Default: local)
  78194. * @returns the TransformNode.
  78195. */
  78196. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  78197. /**
  78198. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  78199. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  78200. * The passed axis is also normalized. .
  78201. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  78202. * @param point the point to rotate around
  78203. * @param axis the axis to rotate around
  78204. * @param amount the amount to rotate in radians
  78205. * @returns the TransformNode
  78206. */
  78207. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  78208. /**
  78209. * Translates the mesh along the axis vector for the passed distance in the given space.
  78210. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  78211. * @param axis the axis to translate in
  78212. * @param distance the distance to translate
  78213. * @param space Space to rotate in (Default: local)
  78214. * @returns the TransformNode.
  78215. */
  78216. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  78217. /**
  78218. * Adds a rotation step to the mesh current rotation.
  78219. * x, y, z are Euler angles expressed in radians.
  78220. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  78221. * This means this rotation is made in the mesh local space only.
  78222. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  78223. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  78224. * ```javascript
  78225. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  78226. * ```
  78227. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  78228. * 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.
  78229. * @param x Rotation to add
  78230. * @param y Rotation to add
  78231. * @param z Rotation to add
  78232. * @returns the TransformNode.
  78233. */
  78234. addRotation(x: number, y: number, z: number): TransformNode;
  78235. /**
  78236. * @hidden
  78237. */
  78238. protected _getEffectiveParent(): Nullable<Node>;
  78239. /**
  78240. * Computes the world matrix of the node
  78241. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  78242. * @returns the world matrix
  78243. */
  78244. computeWorldMatrix(force?: boolean): Matrix;
  78245. protected _afterComputeWorldMatrix(): void;
  78246. /**
  78247. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  78248. * @param func callback function to add
  78249. *
  78250. * @returns the TransformNode.
  78251. */
  78252. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  78253. /**
  78254. * Removes a registered callback function.
  78255. * @param func callback function to remove
  78256. * @returns the TransformNode.
  78257. */
  78258. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  78259. /**
  78260. * Gets the position of the current mesh in camera space
  78261. * @param camera defines the camera to use
  78262. * @returns a position
  78263. */
  78264. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  78265. /**
  78266. * Returns the distance from the mesh to the active camera
  78267. * @param camera defines the camera to use
  78268. * @returns the distance
  78269. */
  78270. getDistanceToCamera(camera?: Nullable<Camera>): number;
  78271. /**
  78272. * Clone the current transform node
  78273. * @param name Name of the new clone
  78274. * @param newParent New parent for the clone
  78275. * @param doNotCloneChildren Do not clone children hierarchy
  78276. * @returns the new transform node
  78277. */
  78278. clone(name: string, newParent: Node, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  78279. /**
  78280. * Serializes the objects information.
  78281. * @param currentSerializationObject defines the object to serialize in
  78282. * @returns the serialized object
  78283. */
  78284. serialize(currentSerializationObject?: any): any;
  78285. /**
  78286. * Returns a new TransformNode object parsed from the source provided.
  78287. * @param parsedTransformNode is the source.
  78288. * @param scene the scne the object belongs to
  78289. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  78290. * @returns a new TransformNode object parsed from the source provided.
  78291. */
  78292. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  78293. /**
  78294. * Get all child-transformNodes of this node
  78295. * @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
  78296. * @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
  78297. * @returns an array of TransformNode
  78298. */
  78299. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  78300. /**
  78301. * Releases resources associated with this transform node.
  78302. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  78303. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  78304. */
  78305. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  78306. /**
  78307. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  78308. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  78309. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  78310. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  78311. * @returns the current mesh
  78312. */
  78313. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  78314. private _syncAbsoluteScalingAndRotation;
  78315. }
  78316. }
  78317. declare module BABYLON {
  78318. /**
  78319. * Defines the types of pose enabled controllers that are supported
  78320. */
  78321. export enum PoseEnabledControllerType {
  78322. /**
  78323. * HTC Vive
  78324. */
  78325. VIVE = 0,
  78326. /**
  78327. * Oculus Rift
  78328. */
  78329. OCULUS = 1,
  78330. /**
  78331. * Windows mixed reality
  78332. */
  78333. WINDOWS = 2,
  78334. /**
  78335. * Samsung gear VR
  78336. */
  78337. GEAR_VR = 3,
  78338. /**
  78339. * Google Daydream
  78340. */
  78341. DAYDREAM = 4,
  78342. /**
  78343. * Generic
  78344. */
  78345. GENERIC = 5
  78346. }
  78347. /**
  78348. * Defines the MutableGamepadButton interface for the state of a gamepad button
  78349. */
  78350. export interface MutableGamepadButton {
  78351. /**
  78352. * Value of the button/trigger
  78353. */
  78354. value: number;
  78355. /**
  78356. * If the button/trigger is currently touched
  78357. */
  78358. touched: boolean;
  78359. /**
  78360. * If the button/trigger is currently pressed
  78361. */
  78362. pressed: boolean;
  78363. }
  78364. /**
  78365. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  78366. * @hidden
  78367. */
  78368. export interface ExtendedGamepadButton extends GamepadButton {
  78369. /**
  78370. * If the button/trigger is currently pressed
  78371. */
  78372. readonly pressed: boolean;
  78373. /**
  78374. * If the button/trigger is currently touched
  78375. */
  78376. readonly touched: boolean;
  78377. /**
  78378. * Value of the button/trigger
  78379. */
  78380. readonly value: number;
  78381. }
  78382. /** @hidden */
  78383. export interface _GamePadFactory {
  78384. /**
  78385. * Returns wether or not the current gamepad can be created for this type of controller.
  78386. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  78387. * @returns true if it can be created, otherwise false
  78388. */
  78389. canCreate(gamepadInfo: any): boolean;
  78390. /**
  78391. * Creates a new instance of the Gamepad.
  78392. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  78393. * @returns the new gamepad instance
  78394. */
  78395. create(gamepadInfo: any): Gamepad;
  78396. }
  78397. /**
  78398. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  78399. */
  78400. export class PoseEnabledControllerHelper {
  78401. /** @hidden */
  78402. static _ControllerFactories: _GamePadFactory[];
  78403. /** @hidden */
  78404. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  78405. /**
  78406. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  78407. * @param vrGamepad the gamepad to initialized
  78408. * @returns a vr controller of the type the gamepad identified as
  78409. */
  78410. static InitiateController(vrGamepad: any): Gamepad;
  78411. }
  78412. /**
  78413. * Defines the PoseEnabledController object that contains state of a vr capable controller
  78414. */
  78415. export class PoseEnabledController extends Gamepad implements PoseControlled {
  78416. /**
  78417. * If the controller is used in a webXR session
  78418. */
  78419. isXR: boolean;
  78420. private _deviceRoomPosition;
  78421. private _deviceRoomRotationQuaternion;
  78422. /**
  78423. * The device position in babylon space
  78424. */
  78425. devicePosition: Vector3;
  78426. /**
  78427. * The device rotation in babylon space
  78428. */
  78429. deviceRotationQuaternion: Quaternion;
  78430. /**
  78431. * The scale factor of the device in babylon space
  78432. */
  78433. deviceScaleFactor: number;
  78434. /**
  78435. * (Likely devicePosition should be used instead) The device position in its room space
  78436. */
  78437. position: Vector3;
  78438. /**
  78439. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  78440. */
  78441. rotationQuaternion: Quaternion;
  78442. /**
  78443. * The type of controller (Eg. Windows mixed reality)
  78444. */
  78445. controllerType: PoseEnabledControllerType;
  78446. protected _calculatedPosition: Vector3;
  78447. private _calculatedRotation;
  78448. /**
  78449. * The raw pose from the device
  78450. */
  78451. rawPose: DevicePose;
  78452. private _trackPosition;
  78453. private _maxRotationDistFromHeadset;
  78454. private _draggedRoomRotation;
  78455. /**
  78456. * @hidden
  78457. */
  78458. _disableTrackPosition(fixedPosition: Vector3): void;
  78459. /**
  78460. * Internal, the mesh attached to the controller
  78461. * @hidden
  78462. */
  78463. _mesh: Nullable<AbstractMesh>;
  78464. private _poseControlledCamera;
  78465. private _leftHandSystemQuaternion;
  78466. /**
  78467. * Internal, matrix used to convert room space to babylon space
  78468. * @hidden
  78469. */
  78470. _deviceToWorld: Matrix;
  78471. /**
  78472. * Node to be used when casting a ray from the controller
  78473. * @hidden
  78474. */
  78475. _pointingPoseNode: Nullable<TransformNode>;
  78476. /**
  78477. * Name of the child mesh that can be used to cast a ray from the controller
  78478. */
  78479. static readonly POINTING_POSE: string;
  78480. /**
  78481. * Creates a new PoseEnabledController from a gamepad
  78482. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  78483. */
  78484. constructor(browserGamepad: any);
  78485. private _workingMatrix;
  78486. /**
  78487. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  78488. */
  78489. update(): void;
  78490. /**
  78491. * Updates only the pose device and mesh without doing any button event checking
  78492. */
  78493. protected _updatePoseAndMesh(): void;
  78494. /**
  78495. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  78496. * @param poseData raw pose fromthe device
  78497. */
  78498. updateFromDevice(poseData: DevicePose): void;
  78499. /**
  78500. * @hidden
  78501. */
  78502. _meshAttachedObservable: Observable<AbstractMesh>;
  78503. /**
  78504. * Attaches a mesh to the controller
  78505. * @param mesh the mesh to be attached
  78506. */
  78507. attachToMesh(mesh: AbstractMesh): void;
  78508. /**
  78509. * Attaches the controllers mesh to a camera
  78510. * @param camera the camera the mesh should be attached to
  78511. */
  78512. attachToPoseControlledCamera(camera: TargetCamera): void;
  78513. /**
  78514. * Disposes of the controller
  78515. */
  78516. dispose(): void;
  78517. /**
  78518. * The mesh that is attached to the controller
  78519. */
  78520. readonly mesh: Nullable<AbstractMesh>;
  78521. /**
  78522. * Gets the ray of the controller in the direction the controller is pointing
  78523. * @param length the length the resulting ray should be
  78524. * @returns a ray in the direction the controller is pointing
  78525. */
  78526. getForwardRay(length?: number): Ray;
  78527. }
  78528. }
  78529. declare module BABYLON {
  78530. /**
  78531. * Defines the WebVRController object that represents controllers tracked in 3D space
  78532. */
  78533. export abstract class WebVRController extends PoseEnabledController {
  78534. /**
  78535. * Internal, the default controller model for the controller
  78536. */
  78537. protected _defaultModel: AbstractMesh;
  78538. /**
  78539. * Fired when the trigger state has changed
  78540. */
  78541. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  78542. /**
  78543. * Fired when the main button state has changed
  78544. */
  78545. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  78546. /**
  78547. * Fired when the secondary button state has changed
  78548. */
  78549. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  78550. /**
  78551. * Fired when the pad state has changed
  78552. */
  78553. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  78554. /**
  78555. * Fired when controllers stick values have changed
  78556. */
  78557. onPadValuesChangedObservable: Observable<StickValues>;
  78558. /**
  78559. * Array of button availible on the controller
  78560. */
  78561. protected _buttons: Array<MutableGamepadButton>;
  78562. private _onButtonStateChange;
  78563. /**
  78564. * Fired when a controller button's state has changed
  78565. * @param callback the callback containing the button that was modified
  78566. */
  78567. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  78568. /**
  78569. * X and Y axis corresponding to the controllers joystick
  78570. */
  78571. pad: StickValues;
  78572. /**
  78573. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  78574. */
  78575. hand: string;
  78576. /**
  78577. * The default controller model for the controller
  78578. */
  78579. readonly defaultModel: AbstractMesh;
  78580. /**
  78581. * Creates a new WebVRController from a gamepad
  78582. * @param vrGamepad the gamepad that the WebVRController should be created from
  78583. */
  78584. constructor(vrGamepad: any);
  78585. /**
  78586. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  78587. */
  78588. update(): void;
  78589. /**
  78590. * Function to be called when a button is modified
  78591. */
  78592. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  78593. /**
  78594. * Loads a mesh and attaches it to the controller
  78595. * @param scene the scene the mesh should be added to
  78596. * @param meshLoaded callback for when the mesh has been loaded
  78597. */
  78598. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  78599. private _setButtonValue;
  78600. private _changes;
  78601. private _checkChanges;
  78602. /**
  78603. * Disposes of th webVRCOntroller
  78604. */
  78605. dispose(): void;
  78606. }
  78607. }
  78608. declare module BABYLON {
  78609. /**
  78610. * The HemisphericLight simulates the ambient environment light,
  78611. * so the passed direction is the light reflection direction, not the incoming direction.
  78612. */
  78613. export class HemisphericLight extends Light {
  78614. /**
  78615. * The groundColor is the light in the opposite direction to the one specified during creation.
  78616. * 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.
  78617. */
  78618. groundColor: Color3;
  78619. /**
  78620. * The light reflection direction, not the incoming direction.
  78621. */
  78622. direction: Vector3;
  78623. /**
  78624. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  78625. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  78626. * The HemisphericLight can't cast shadows.
  78627. * Documentation : https://doc.babylonjs.com/babylon101/lights
  78628. * @param name The friendly name of the light
  78629. * @param direction The direction of the light reflection
  78630. * @param scene The scene the light belongs to
  78631. */
  78632. constructor(name: string, direction: Vector3, scene: Scene);
  78633. protected _buildUniformLayout(): void;
  78634. /**
  78635. * Returns the string "HemisphericLight".
  78636. * @return The class name
  78637. */
  78638. getClassName(): string;
  78639. /**
  78640. * Sets the HemisphericLight direction towards the passed target (Vector3).
  78641. * Returns the updated direction.
  78642. * @param target The target the direction should point to
  78643. * @return The computed direction
  78644. */
  78645. setDirectionToTarget(target: Vector3): Vector3;
  78646. /**
  78647. * Returns the shadow generator associated to the light.
  78648. * @returns Always null for hemispheric lights because it does not support shadows.
  78649. */
  78650. getShadowGenerator(): Nullable<IShadowGenerator>;
  78651. /**
  78652. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  78653. * @param effect The effect to update
  78654. * @param lightIndex The index of the light in the effect to update
  78655. * @returns The hemispheric light
  78656. */
  78657. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  78658. /**
  78659. * Computes the world matrix of the node
  78660. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  78661. * @param useWasUpdatedFlag defines a reserved property
  78662. * @returns the world matrix
  78663. */
  78664. computeWorldMatrix(): Matrix;
  78665. /**
  78666. * Returns the integer 3.
  78667. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  78668. */
  78669. getTypeID(): number;
  78670. /**
  78671. * Prepares the list of defines specific to the light type.
  78672. * @param defines the list of defines
  78673. * @param lightIndex defines the index of the light for the effect
  78674. */
  78675. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  78676. }
  78677. }
  78678. declare module BABYLON {
  78679. /** @hidden */
  78680. export var vrMultiviewToSingleviewPixelShader: {
  78681. name: string;
  78682. shader: string;
  78683. };
  78684. }
  78685. declare module BABYLON {
  78686. /**
  78687. * Renders to multiple views with a single draw call
  78688. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  78689. */
  78690. export class MultiviewRenderTarget extends RenderTargetTexture {
  78691. /**
  78692. * Creates a multiview render target
  78693. * @param scene scene used with the render target
  78694. * @param size the size of the render target (used for each view)
  78695. */
  78696. constructor(scene: Scene, size?: number | {
  78697. width: number;
  78698. height: number;
  78699. } | {
  78700. ratio: number;
  78701. });
  78702. /**
  78703. * @hidden
  78704. * @param faceIndex the face index, if its a cube texture
  78705. */
  78706. _bindFrameBuffer(faceIndex?: number): void;
  78707. /**
  78708. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  78709. * @returns the view count
  78710. */
  78711. getViewCount(): number;
  78712. }
  78713. }
  78714. declare module BABYLON {
  78715. /**
  78716. * Reprasents a camera frustum
  78717. */
  78718. export class Frustum {
  78719. /**
  78720. * Gets the planes representing the frustum
  78721. * @param transform matrix to be applied to the returned planes
  78722. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  78723. */
  78724. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  78725. /**
  78726. * Gets the near frustum plane transformed by the transform matrix
  78727. * @param transform transformation matrix to be applied to the resulting frustum plane
  78728. * @param frustumPlane the resuling frustum plane
  78729. */
  78730. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  78731. /**
  78732. * Gets the far frustum plane transformed by the transform matrix
  78733. * @param transform transformation matrix to be applied to the resulting frustum plane
  78734. * @param frustumPlane the resuling frustum plane
  78735. */
  78736. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  78737. /**
  78738. * Gets the left frustum plane transformed by the transform matrix
  78739. * @param transform transformation matrix to be applied to the resulting frustum plane
  78740. * @param frustumPlane the resuling frustum plane
  78741. */
  78742. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  78743. /**
  78744. * Gets the right frustum plane transformed by the transform matrix
  78745. * @param transform transformation matrix to be applied to the resulting frustum plane
  78746. * @param frustumPlane the resuling frustum plane
  78747. */
  78748. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  78749. /**
  78750. * Gets the top frustum plane transformed by the transform matrix
  78751. * @param transform transformation matrix to be applied to the resulting frustum plane
  78752. * @param frustumPlane the resuling frustum plane
  78753. */
  78754. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  78755. /**
  78756. * Gets the bottom frustum plane transformed by the transform matrix
  78757. * @param transform transformation matrix to be applied to the resulting frustum plane
  78758. * @param frustumPlane the resuling frustum plane
  78759. */
  78760. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  78761. /**
  78762. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  78763. * @param transform transformation matrix to be applied to the resulting frustum planes
  78764. * @param frustumPlanes the resuling frustum planes
  78765. */
  78766. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  78767. }
  78768. }
  78769. declare module BABYLON {
  78770. interface Engine {
  78771. /**
  78772. * Creates a new multiview render target
  78773. * @param width defines the width of the texture
  78774. * @param height defines the height of the texture
  78775. * @returns the created multiview texture
  78776. */
  78777. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  78778. /**
  78779. * Binds a multiview framebuffer to be drawn to
  78780. * @param multiviewTexture texture to bind
  78781. */
  78782. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  78783. }
  78784. interface Camera {
  78785. /**
  78786. * @hidden
  78787. * 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)
  78788. */
  78789. _useMultiviewToSingleView: boolean;
  78790. /**
  78791. * @hidden
  78792. * 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)
  78793. */
  78794. _multiviewTexture: Nullable<RenderTargetTexture>;
  78795. /**
  78796. * @hidden
  78797. * ensures the multiview texture of the camera exists and has the specified width/height
  78798. * @param width height to set on the multiview texture
  78799. * @param height width to set on the multiview texture
  78800. */
  78801. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  78802. }
  78803. interface Scene {
  78804. /** @hidden */
  78805. _transformMatrixR: Matrix;
  78806. /** @hidden */
  78807. _multiviewSceneUbo: Nullable<UniformBuffer>;
  78808. /** @hidden */
  78809. _createMultiviewUbo(): void;
  78810. /** @hidden */
  78811. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  78812. /** @hidden */
  78813. _renderMultiviewToSingleView(camera: Camera): void;
  78814. }
  78815. }
  78816. declare module BABYLON {
  78817. /**
  78818. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  78819. * This will not be used for webXR as it supports displaying texture arrays directly
  78820. */
  78821. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  78822. /**
  78823. * Initializes a VRMultiviewToSingleview
  78824. * @param name name of the post process
  78825. * @param camera camera to be applied to
  78826. * @param scaleFactor scaling factor to the size of the output texture
  78827. */
  78828. constructor(name: string, camera: Camera, scaleFactor: number);
  78829. }
  78830. }
  78831. declare module BABYLON {
  78832. interface Engine {
  78833. /** @hidden */
  78834. _vrDisplay: any;
  78835. /** @hidden */
  78836. _vrSupported: boolean;
  78837. /** @hidden */
  78838. _oldSize: Size;
  78839. /** @hidden */
  78840. _oldHardwareScaleFactor: number;
  78841. /** @hidden */
  78842. _vrExclusivePointerMode: boolean;
  78843. /** @hidden */
  78844. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  78845. /** @hidden */
  78846. _onVRDisplayPointerRestricted: () => void;
  78847. /** @hidden */
  78848. _onVRDisplayPointerUnrestricted: () => void;
  78849. /** @hidden */
  78850. _onVrDisplayConnect: Nullable<(display: any) => void>;
  78851. /** @hidden */
  78852. _onVrDisplayDisconnect: Nullable<() => void>;
  78853. /** @hidden */
  78854. _onVrDisplayPresentChange: Nullable<() => void>;
  78855. /**
  78856. * Observable signaled when VR display mode changes
  78857. */
  78858. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  78859. /**
  78860. * Observable signaled when VR request present is complete
  78861. */
  78862. onVRRequestPresentComplete: Observable<boolean>;
  78863. /**
  78864. * Observable signaled when VR request present starts
  78865. */
  78866. onVRRequestPresentStart: Observable<Engine>;
  78867. /**
  78868. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  78869. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  78870. */
  78871. isInVRExclusivePointerMode: boolean;
  78872. /**
  78873. * Gets a boolean indicating if a webVR device was detected
  78874. * @returns true if a webVR device was detected
  78875. */
  78876. isVRDevicePresent(): boolean;
  78877. /**
  78878. * Gets the current webVR device
  78879. * @returns the current webVR device (or null)
  78880. */
  78881. getVRDevice(): any;
  78882. /**
  78883. * Initializes a webVR display and starts listening to display change events
  78884. * The onVRDisplayChangedObservable will be notified upon these changes
  78885. * @returns A promise containing a VRDisplay and if vr is supported
  78886. */
  78887. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  78888. /** @hidden */
  78889. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  78890. /**
  78891. * Call this function to switch to webVR mode
  78892. * Will do nothing if webVR is not supported or if there is no webVR device
  78893. * @see http://doc.babylonjs.com/how_to/webvr_camera
  78894. */
  78895. enableVR(): void;
  78896. /** @hidden */
  78897. _onVRFullScreenTriggered(): void;
  78898. }
  78899. }
  78900. declare module BABYLON {
  78901. /**
  78902. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  78903. * IMPORTANT!! The data is right-hand data.
  78904. * @export
  78905. * @interface DevicePose
  78906. */
  78907. export interface DevicePose {
  78908. /**
  78909. * The position of the device, values in array are [x,y,z].
  78910. */
  78911. readonly position: Nullable<Float32Array>;
  78912. /**
  78913. * The linearVelocity of the device, values in array are [x,y,z].
  78914. */
  78915. readonly linearVelocity: Nullable<Float32Array>;
  78916. /**
  78917. * The linearAcceleration of the device, values in array are [x,y,z].
  78918. */
  78919. readonly linearAcceleration: Nullable<Float32Array>;
  78920. /**
  78921. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  78922. */
  78923. readonly orientation: Nullable<Float32Array>;
  78924. /**
  78925. * The angularVelocity of the device, values in array are [x,y,z].
  78926. */
  78927. readonly angularVelocity: Nullable<Float32Array>;
  78928. /**
  78929. * The angularAcceleration of the device, values in array are [x,y,z].
  78930. */
  78931. readonly angularAcceleration: Nullable<Float32Array>;
  78932. }
  78933. /**
  78934. * Interface representing a pose controlled object in Babylon.
  78935. * A pose controlled object has both regular pose values as well as pose values
  78936. * from an external device such as a VR head mounted display
  78937. */
  78938. export interface PoseControlled {
  78939. /**
  78940. * The position of the object in babylon space.
  78941. */
  78942. position: Vector3;
  78943. /**
  78944. * The rotation quaternion of the object in babylon space.
  78945. */
  78946. rotationQuaternion: Quaternion;
  78947. /**
  78948. * The position of the device in babylon space.
  78949. */
  78950. devicePosition?: Vector3;
  78951. /**
  78952. * The rotation quaternion of the device in babylon space.
  78953. */
  78954. deviceRotationQuaternion: Quaternion;
  78955. /**
  78956. * The raw pose coming from the device.
  78957. */
  78958. rawPose: Nullable<DevicePose>;
  78959. /**
  78960. * The scale of the device to be used when translating from device space to babylon space.
  78961. */
  78962. deviceScaleFactor: number;
  78963. /**
  78964. * Updates the poseControlled values based on the input device pose.
  78965. * @param poseData the pose data to update the object with
  78966. */
  78967. updateFromDevice(poseData: DevicePose): void;
  78968. }
  78969. /**
  78970. * Set of options to customize the webVRCamera
  78971. */
  78972. export interface WebVROptions {
  78973. /**
  78974. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  78975. */
  78976. trackPosition?: boolean;
  78977. /**
  78978. * Sets the scale of the vrDevice in babylon space. (default: 1)
  78979. */
  78980. positionScale?: number;
  78981. /**
  78982. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  78983. */
  78984. displayName?: string;
  78985. /**
  78986. * Should the native controller meshes be initialized. (default: true)
  78987. */
  78988. controllerMeshes?: boolean;
  78989. /**
  78990. * Creating a default HemiLight only on controllers. (default: true)
  78991. */
  78992. defaultLightingOnControllers?: boolean;
  78993. /**
  78994. * If you don't want to use the default VR button of the helper. (default: false)
  78995. */
  78996. useCustomVRButton?: boolean;
  78997. /**
  78998. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  78999. */
  79000. customVRButton?: HTMLButtonElement;
  79001. /**
  79002. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  79003. */
  79004. rayLength?: number;
  79005. /**
  79006. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  79007. */
  79008. defaultHeight?: number;
  79009. /**
  79010. * If multiview should be used if availible (default: false)
  79011. */
  79012. useMultiview?: boolean;
  79013. }
  79014. /**
  79015. * This represents a WebVR camera.
  79016. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  79017. * @example http://doc.babylonjs.com/how_to/webvr_camera
  79018. */
  79019. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  79020. private webVROptions;
  79021. /**
  79022. * @hidden
  79023. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  79024. */
  79025. _vrDevice: any;
  79026. /**
  79027. * The rawPose of the vrDevice.
  79028. */
  79029. rawPose: Nullable<DevicePose>;
  79030. private _onVREnabled;
  79031. private _specsVersion;
  79032. private _attached;
  79033. private _frameData;
  79034. protected _descendants: Array<Node>;
  79035. private _deviceRoomPosition;
  79036. /** @hidden */
  79037. _deviceRoomRotationQuaternion: Quaternion;
  79038. private _standingMatrix;
  79039. /**
  79040. * Represents device position in babylon space.
  79041. */
  79042. devicePosition: Vector3;
  79043. /**
  79044. * Represents device rotation in babylon space.
  79045. */
  79046. deviceRotationQuaternion: Quaternion;
  79047. /**
  79048. * The scale of the device to be used when translating from device space to babylon space.
  79049. */
  79050. deviceScaleFactor: number;
  79051. private _deviceToWorld;
  79052. private _worldToDevice;
  79053. /**
  79054. * References to the webVR controllers for the vrDevice.
  79055. */
  79056. controllers: Array<WebVRController>;
  79057. /**
  79058. * Emits an event when a controller is attached.
  79059. */
  79060. onControllersAttachedObservable: Observable<WebVRController[]>;
  79061. /**
  79062. * Emits an event when a controller's mesh has been loaded;
  79063. */
  79064. onControllerMeshLoadedObservable: Observable<WebVRController>;
  79065. /**
  79066. * Emits an event when the HMD's pose has been updated.
  79067. */
  79068. onPoseUpdatedFromDeviceObservable: Observable<any>;
  79069. private _poseSet;
  79070. /**
  79071. * If the rig cameras be used as parent instead of this camera.
  79072. */
  79073. rigParenting: boolean;
  79074. private _lightOnControllers;
  79075. private _defaultHeight?;
  79076. /**
  79077. * Instantiates a WebVRFreeCamera.
  79078. * @param name The name of the WebVRFreeCamera
  79079. * @param position The starting anchor position for the camera
  79080. * @param scene The scene the camera belongs to
  79081. * @param webVROptions a set of customizable options for the webVRCamera
  79082. */
  79083. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  79084. /**
  79085. * Gets the device distance from the ground in meters.
  79086. * @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.
  79087. */
  79088. deviceDistanceToRoomGround(): number;
  79089. /**
  79090. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  79091. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  79092. */
  79093. useStandingMatrix(callback?: (bool: boolean) => void): void;
  79094. /**
  79095. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  79096. * @returns A promise with a boolean set to if the standing matrix is supported.
  79097. */
  79098. useStandingMatrixAsync(): Promise<boolean>;
  79099. /**
  79100. * Disposes the camera
  79101. */
  79102. dispose(): void;
  79103. /**
  79104. * Gets a vrController by name.
  79105. * @param name The name of the controller to retreive
  79106. * @returns the controller matching the name specified or null if not found
  79107. */
  79108. getControllerByName(name: string): Nullable<WebVRController>;
  79109. private _leftController;
  79110. /**
  79111. * The controller corresponding to the users left hand.
  79112. */
  79113. readonly leftController: Nullable<WebVRController>;
  79114. private _rightController;
  79115. /**
  79116. * The controller corresponding to the users right hand.
  79117. */
  79118. readonly rightController: Nullable<WebVRController>;
  79119. /**
  79120. * Casts a ray forward from the vrCamera's gaze.
  79121. * @param length Length of the ray (default: 100)
  79122. * @returns the ray corresponding to the gaze
  79123. */
  79124. getForwardRay(length?: number): Ray;
  79125. /**
  79126. * @hidden
  79127. * Updates the camera based on device's frame data
  79128. */
  79129. _checkInputs(): void;
  79130. /**
  79131. * Updates the poseControlled values based on the input device pose.
  79132. * @param poseData Pose coming from the device
  79133. */
  79134. updateFromDevice(poseData: DevicePose): void;
  79135. private _htmlElementAttached;
  79136. private _detachIfAttached;
  79137. /**
  79138. * WebVR's attach control will start broadcasting frames to the device.
  79139. * Note that in certain browsers (chrome for example) this function must be called
  79140. * within a user-interaction callback. Example:
  79141. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  79142. *
  79143. * @param element html element to attach the vrDevice to
  79144. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  79145. */
  79146. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79147. /**
  79148. * Detaches the camera from the html element and disables VR
  79149. *
  79150. * @param element html element to detach from
  79151. */
  79152. detachControl(element: HTMLElement): void;
  79153. /**
  79154. * @returns the name of this class
  79155. */
  79156. getClassName(): string;
  79157. /**
  79158. * Calls resetPose on the vrDisplay
  79159. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  79160. */
  79161. resetToCurrentRotation(): void;
  79162. /**
  79163. * @hidden
  79164. * Updates the rig cameras (left and right eye)
  79165. */
  79166. _updateRigCameras(): void;
  79167. private _workingVector;
  79168. private _oneVector;
  79169. private _workingMatrix;
  79170. private updateCacheCalled;
  79171. private _correctPositionIfNotTrackPosition;
  79172. /**
  79173. * @hidden
  79174. * Updates the cached values of the camera
  79175. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  79176. */
  79177. _updateCache(ignoreParentClass?: boolean): void;
  79178. /**
  79179. * @hidden
  79180. * Get current device position in babylon world
  79181. */
  79182. _computeDevicePosition(): void;
  79183. /**
  79184. * Updates the current device position and rotation in the babylon world
  79185. */
  79186. update(): void;
  79187. /**
  79188. * @hidden
  79189. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  79190. * @returns an identity matrix
  79191. */
  79192. _getViewMatrix(): Matrix;
  79193. private _tmpMatrix;
  79194. /**
  79195. * This function is called by the two RIG cameras.
  79196. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  79197. * @hidden
  79198. */
  79199. _getWebVRViewMatrix(): Matrix;
  79200. /** @hidden */
  79201. _getWebVRProjectionMatrix(): Matrix;
  79202. private _onGamepadConnectedObserver;
  79203. private _onGamepadDisconnectedObserver;
  79204. private _updateCacheWhenTrackingDisabledObserver;
  79205. /**
  79206. * Initializes the controllers and their meshes
  79207. */
  79208. initControllers(): void;
  79209. }
  79210. }
  79211. declare module BABYLON {
  79212. /**
  79213. * Size options for a post process
  79214. */
  79215. export type PostProcessOptions = {
  79216. width: number;
  79217. height: number;
  79218. };
  79219. /**
  79220. * PostProcess can be used to apply a shader to a texture after it has been rendered
  79221. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  79222. */
  79223. export class PostProcess {
  79224. /** Name of the PostProcess. */
  79225. name: string;
  79226. /**
  79227. * Gets or sets the unique id of the post process
  79228. */
  79229. uniqueId: number;
  79230. /**
  79231. * Width of the texture to apply the post process on
  79232. */
  79233. width: number;
  79234. /**
  79235. * Height of the texture to apply the post process on
  79236. */
  79237. height: number;
  79238. /**
  79239. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  79240. * @hidden
  79241. */
  79242. _outputTexture: Nullable<InternalTexture>;
  79243. /**
  79244. * Sampling mode used by the shader
  79245. * See https://doc.babylonjs.com/classes/3.1/texture
  79246. */
  79247. renderTargetSamplingMode: number;
  79248. /**
  79249. * Clear color to use when screen clearing
  79250. */
  79251. clearColor: Color4;
  79252. /**
  79253. * If the buffer needs to be cleared before applying the post process. (default: true)
  79254. * Should be set to false if shader will overwrite all previous pixels.
  79255. */
  79256. autoClear: boolean;
  79257. /**
  79258. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  79259. */
  79260. alphaMode: number;
  79261. /**
  79262. * Sets the setAlphaBlendConstants of the babylon engine
  79263. */
  79264. alphaConstants: Color4;
  79265. /**
  79266. * Animations to be used for the post processing
  79267. */
  79268. animations: Animation[];
  79269. /**
  79270. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  79271. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  79272. */
  79273. enablePixelPerfectMode: boolean;
  79274. /**
  79275. * Force the postprocess to be applied without taking in account viewport
  79276. */
  79277. forceFullscreenViewport: boolean;
  79278. /**
  79279. * List of inspectable custom properties (used by the Inspector)
  79280. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  79281. */
  79282. inspectableCustomProperties: IInspectable[];
  79283. /**
  79284. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  79285. *
  79286. * | Value | Type | Description |
  79287. * | ----- | ----------------------------------- | ----------- |
  79288. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  79289. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  79290. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  79291. *
  79292. */
  79293. scaleMode: number;
  79294. /**
  79295. * Force textures to be a power of two (default: false)
  79296. */
  79297. alwaysForcePOT: boolean;
  79298. private _samples;
  79299. /**
  79300. * Number of sample textures (default: 1)
  79301. */
  79302. samples: number;
  79303. /**
  79304. * Modify the scale of the post process to be the same as the viewport (default: false)
  79305. */
  79306. adaptScaleToCurrentViewport: boolean;
  79307. private _camera;
  79308. private _scene;
  79309. private _engine;
  79310. private _options;
  79311. private _reusable;
  79312. private _textureType;
  79313. /**
  79314. * Smart array of input and output textures for the post process.
  79315. * @hidden
  79316. */
  79317. _textures: SmartArray<InternalTexture>;
  79318. /**
  79319. * The index in _textures that corresponds to the output texture.
  79320. * @hidden
  79321. */
  79322. _currentRenderTextureInd: number;
  79323. private _effect;
  79324. private _samplers;
  79325. private _fragmentUrl;
  79326. private _vertexUrl;
  79327. private _parameters;
  79328. private _scaleRatio;
  79329. protected _indexParameters: any;
  79330. private _shareOutputWithPostProcess;
  79331. private _texelSize;
  79332. private _forcedOutputTexture;
  79333. /**
  79334. * Returns the fragment url or shader name used in the post process.
  79335. * @returns the fragment url or name in the shader store.
  79336. */
  79337. getEffectName(): string;
  79338. /**
  79339. * An event triggered when the postprocess is activated.
  79340. */
  79341. onActivateObservable: Observable<Camera>;
  79342. private _onActivateObserver;
  79343. /**
  79344. * A function that is added to the onActivateObservable
  79345. */
  79346. onActivate: Nullable<(camera: Camera) => void>;
  79347. /**
  79348. * An event triggered when the postprocess changes its size.
  79349. */
  79350. onSizeChangedObservable: Observable<PostProcess>;
  79351. private _onSizeChangedObserver;
  79352. /**
  79353. * A function that is added to the onSizeChangedObservable
  79354. */
  79355. onSizeChanged: (postProcess: PostProcess) => void;
  79356. /**
  79357. * An event triggered when the postprocess applies its effect.
  79358. */
  79359. onApplyObservable: Observable<Effect>;
  79360. private _onApplyObserver;
  79361. /**
  79362. * A function that is added to the onApplyObservable
  79363. */
  79364. onApply: (effect: Effect) => void;
  79365. /**
  79366. * An event triggered before rendering the postprocess
  79367. */
  79368. onBeforeRenderObservable: Observable<Effect>;
  79369. private _onBeforeRenderObserver;
  79370. /**
  79371. * A function that is added to the onBeforeRenderObservable
  79372. */
  79373. onBeforeRender: (effect: Effect) => void;
  79374. /**
  79375. * An event triggered after rendering the postprocess
  79376. */
  79377. onAfterRenderObservable: Observable<Effect>;
  79378. private _onAfterRenderObserver;
  79379. /**
  79380. * A function that is added to the onAfterRenderObservable
  79381. */
  79382. onAfterRender: (efect: Effect) => void;
  79383. /**
  79384. * 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
  79385. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  79386. */
  79387. inputTexture: InternalTexture;
  79388. /**
  79389. * Gets the camera which post process is applied to.
  79390. * @returns The camera the post process is applied to.
  79391. */
  79392. getCamera(): Camera;
  79393. /**
  79394. * Gets the texel size of the postprocess.
  79395. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  79396. */
  79397. readonly texelSize: Vector2;
  79398. /**
  79399. * Creates a new instance PostProcess
  79400. * @param name The name of the PostProcess.
  79401. * @param fragmentUrl The url of the fragment shader to be used.
  79402. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  79403. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  79404. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  79405. * @param camera The camera to apply the render pass to.
  79406. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  79407. * @param engine The engine which the post process will be applied. (default: current engine)
  79408. * @param reusable If the post process can be reused on the same frame. (default: false)
  79409. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  79410. * @param textureType Type of textures used when performing the post process. (default: 0)
  79411. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  79412. * @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
  79413. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  79414. */
  79415. constructor(
  79416. /** Name of the PostProcess. */
  79417. 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);
  79418. /**
  79419. * Gets a string idenfifying the name of the class
  79420. * @returns "PostProcess" string
  79421. */
  79422. getClassName(): string;
  79423. /**
  79424. * Gets the engine which this post process belongs to.
  79425. * @returns The engine the post process was enabled with.
  79426. */
  79427. getEngine(): Engine;
  79428. /**
  79429. * The effect that is created when initializing the post process.
  79430. * @returns The created effect corresponding the the postprocess.
  79431. */
  79432. getEffect(): Effect;
  79433. /**
  79434. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  79435. * @param postProcess The post process to share the output with.
  79436. * @returns This post process.
  79437. */
  79438. shareOutputWith(postProcess: PostProcess): PostProcess;
  79439. /**
  79440. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  79441. * This should be called if the post process that shares output with this post process is disabled/disposed.
  79442. */
  79443. useOwnOutput(): void;
  79444. /**
  79445. * Updates the effect with the current post process compile time values and recompiles the shader.
  79446. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  79447. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  79448. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  79449. * @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
  79450. * @param onCompiled Called when the shader has been compiled.
  79451. * @param onError Called if there is an error when compiling a shader.
  79452. */
  79453. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  79454. /**
  79455. * The post process is reusable if it can be used multiple times within one frame.
  79456. * @returns If the post process is reusable
  79457. */
  79458. isReusable(): boolean;
  79459. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  79460. markTextureDirty(): void;
  79461. /**
  79462. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  79463. * 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.
  79464. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  79465. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  79466. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  79467. * @returns The target texture that was bound to be written to.
  79468. */
  79469. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  79470. /**
  79471. * If the post process is supported.
  79472. */
  79473. readonly isSupported: boolean;
  79474. /**
  79475. * The aspect ratio of the output texture.
  79476. */
  79477. readonly aspectRatio: number;
  79478. /**
  79479. * Get a value indicating if the post-process is ready to be used
  79480. * @returns true if the post-process is ready (shader is compiled)
  79481. */
  79482. isReady(): boolean;
  79483. /**
  79484. * Binds all textures and uniforms to the shader, this will be run on every pass.
  79485. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  79486. */
  79487. apply(): Nullable<Effect>;
  79488. private _disposeTextures;
  79489. /**
  79490. * Disposes the post process.
  79491. * @param camera The camera to dispose the post process on.
  79492. */
  79493. dispose(camera?: Camera): void;
  79494. }
  79495. }
  79496. declare module BABYLON {
  79497. /** @hidden */
  79498. export var kernelBlurVaryingDeclaration: {
  79499. name: string;
  79500. shader: string;
  79501. };
  79502. }
  79503. declare module BABYLON {
  79504. /** @hidden */
  79505. export var kernelBlurFragment: {
  79506. name: string;
  79507. shader: string;
  79508. };
  79509. }
  79510. declare module BABYLON {
  79511. /** @hidden */
  79512. export var kernelBlurFragment2: {
  79513. name: string;
  79514. shader: string;
  79515. };
  79516. }
  79517. declare module BABYLON {
  79518. /** @hidden */
  79519. export var kernelBlurPixelShader: {
  79520. name: string;
  79521. shader: string;
  79522. };
  79523. }
  79524. declare module BABYLON {
  79525. /** @hidden */
  79526. export var kernelBlurVertex: {
  79527. name: string;
  79528. shader: string;
  79529. };
  79530. }
  79531. declare module BABYLON {
  79532. /** @hidden */
  79533. export var kernelBlurVertexShader: {
  79534. name: string;
  79535. shader: string;
  79536. };
  79537. }
  79538. declare module BABYLON {
  79539. /**
  79540. * The Blur Post Process which blurs an image based on a kernel and direction.
  79541. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  79542. */
  79543. export class BlurPostProcess extends PostProcess {
  79544. /** The direction in which to blur the image. */
  79545. direction: Vector2;
  79546. private blockCompilation;
  79547. protected _kernel: number;
  79548. protected _idealKernel: number;
  79549. protected _packedFloat: boolean;
  79550. private _staticDefines;
  79551. /**
  79552. * Sets the length in pixels of the blur sample region
  79553. */
  79554. /**
  79555. * Gets the length in pixels of the blur sample region
  79556. */
  79557. kernel: number;
  79558. /**
  79559. * Sets wether or not the blur needs to unpack/repack floats
  79560. */
  79561. /**
  79562. * Gets wether or not the blur is unpacking/repacking floats
  79563. */
  79564. packedFloat: boolean;
  79565. /**
  79566. * Creates a new instance BlurPostProcess
  79567. * @param name The name of the effect.
  79568. * @param direction The direction in which to blur the image.
  79569. * @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.
  79570. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  79571. * @param camera The camera to apply the render pass to.
  79572. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  79573. * @param engine The engine which the post process will be applied. (default: current engine)
  79574. * @param reusable If the post process can be reused on the same frame. (default: false)
  79575. * @param textureType Type of textures used when performing the post process. (default: 0)
  79576. * @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)
  79577. */
  79578. constructor(name: string,
  79579. /** The direction in which to blur the image. */
  79580. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  79581. /**
  79582. * Updates the effect with the current post process compile time values and recompiles the shader.
  79583. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  79584. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  79585. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  79586. * @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
  79587. * @param onCompiled Called when the shader has been compiled.
  79588. * @param onError Called if there is an error when compiling a shader.
  79589. */
  79590. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  79591. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  79592. /**
  79593. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  79594. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  79595. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  79596. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  79597. * The gaps between physical kernels are compensated for in the weighting of the samples
  79598. * @param idealKernel Ideal blur kernel.
  79599. * @return Nearest best kernel.
  79600. */
  79601. protected _nearestBestKernel(idealKernel: number): number;
  79602. /**
  79603. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  79604. * @param x The point on the Gaussian distribution to sample.
  79605. * @return the value of the Gaussian function at x.
  79606. */
  79607. protected _gaussianWeight(x: number): number;
  79608. /**
  79609. * Generates a string that can be used as a floating point number in GLSL.
  79610. * @param x Value to print.
  79611. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  79612. * @return GLSL float string.
  79613. */
  79614. protected _glslFloat(x: number, decimalFigures?: number): string;
  79615. }
  79616. }
  79617. declare module BABYLON {
  79618. /**
  79619. * Mirror texture can be used to simulate the view from a mirror in a scene.
  79620. * It will dynamically be rendered every frame to adapt to the camera point of view.
  79621. * You can then easily use it as a reflectionTexture on a flat surface.
  79622. * In case the surface is not a plane, please consider relying on reflection probes.
  79623. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  79624. */
  79625. export class MirrorTexture extends RenderTargetTexture {
  79626. private scene;
  79627. /**
  79628. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  79629. * 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.
  79630. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  79631. */
  79632. mirrorPlane: Plane;
  79633. /**
  79634. * Define the blur ratio used to blur the reflection if needed.
  79635. */
  79636. blurRatio: number;
  79637. /**
  79638. * Define the adaptive blur kernel used to blur the reflection if needed.
  79639. * This will autocompute the closest best match for the `blurKernel`
  79640. */
  79641. adaptiveBlurKernel: number;
  79642. /**
  79643. * Define the blur kernel used to blur the reflection if needed.
  79644. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  79645. */
  79646. blurKernel: number;
  79647. /**
  79648. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  79649. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  79650. */
  79651. blurKernelX: number;
  79652. /**
  79653. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  79654. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  79655. */
  79656. blurKernelY: number;
  79657. private _autoComputeBlurKernel;
  79658. protected _onRatioRescale(): void;
  79659. private _updateGammaSpace;
  79660. private _imageProcessingConfigChangeObserver;
  79661. private _transformMatrix;
  79662. private _mirrorMatrix;
  79663. private _savedViewMatrix;
  79664. private _blurX;
  79665. private _blurY;
  79666. private _adaptiveBlurKernel;
  79667. private _blurKernelX;
  79668. private _blurKernelY;
  79669. private _blurRatio;
  79670. /**
  79671. * Instantiates a Mirror Texture.
  79672. * Mirror texture can be used to simulate the view from a mirror in a scene.
  79673. * It will dynamically be rendered every frame to adapt to the camera point of view.
  79674. * You can then easily use it as a reflectionTexture on a flat surface.
  79675. * In case the surface is not a plane, please consider relying on reflection probes.
  79676. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  79677. * @param name
  79678. * @param size
  79679. * @param scene
  79680. * @param generateMipMaps
  79681. * @param type
  79682. * @param samplingMode
  79683. * @param generateDepthBuffer
  79684. */
  79685. constructor(name: string, size: number | {
  79686. width: number;
  79687. height: number;
  79688. } | {
  79689. ratio: number;
  79690. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  79691. private _preparePostProcesses;
  79692. /**
  79693. * Clone the mirror texture.
  79694. * @returns the cloned texture
  79695. */
  79696. clone(): MirrorTexture;
  79697. /**
  79698. * Serialize the texture to a JSON representation you could use in Parse later on
  79699. * @returns the serialized JSON representation
  79700. */
  79701. serialize(): any;
  79702. /**
  79703. * Dispose the texture and release its associated resources.
  79704. */
  79705. dispose(): void;
  79706. }
  79707. }
  79708. declare module BABYLON {
  79709. /**
  79710. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  79711. * @see http://doc.babylonjs.com/babylon101/materials#texture
  79712. */
  79713. export class Texture extends BaseTexture {
  79714. /** @hidden */
  79715. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  79716. /** @hidden */
  79717. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  79718. /** @hidden */
  79719. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  79720. /** nearest is mag = nearest and min = nearest and mip = linear */
  79721. static readonly NEAREST_SAMPLINGMODE: number;
  79722. /** nearest is mag = nearest and min = nearest and mip = linear */
  79723. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  79724. /** Bilinear is mag = linear and min = linear and mip = nearest */
  79725. static readonly BILINEAR_SAMPLINGMODE: number;
  79726. /** Bilinear is mag = linear and min = linear and mip = nearest */
  79727. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  79728. /** Trilinear is mag = linear and min = linear and mip = linear */
  79729. static readonly TRILINEAR_SAMPLINGMODE: number;
  79730. /** Trilinear is mag = linear and min = linear and mip = linear */
  79731. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  79732. /** mag = nearest and min = nearest and mip = nearest */
  79733. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  79734. /** mag = nearest and min = linear and mip = nearest */
  79735. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  79736. /** mag = nearest and min = linear and mip = linear */
  79737. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  79738. /** mag = nearest and min = linear and mip = none */
  79739. static readonly NEAREST_LINEAR: number;
  79740. /** mag = nearest and min = nearest and mip = none */
  79741. static readonly NEAREST_NEAREST: number;
  79742. /** mag = linear and min = nearest and mip = nearest */
  79743. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  79744. /** mag = linear and min = nearest and mip = linear */
  79745. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  79746. /** mag = linear and min = linear and mip = none */
  79747. static readonly LINEAR_LINEAR: number;
  79748. /** mag = linear and min = nearest and mip = none */
  79749. static readonly LINEAR_NEAREST: number;
  79750. /** Explicit coordinates mode */
  79751. static readonly EXPLICIT_MODE: number;
  79752. /** Spherical coordinates mode */
  79753. static readonly SPHERICAL_MODE: number;
  79754. /** Planar coordinates mode */
  79755. static readonly PLANAR_MODE: number;
  79756. /** Cubic coordinates mode */
  79757. static readonly CUBIC_MODE: number;
  79758. /** Projection coordinates mode */
  79759. static readonly PROJECTION_MODE: number;
  79760. /** Inverse Cubic coordinates mode */
  79761. static readonly SKYBOX_MODE: number;
  79762. /** Inverse Cubic coordinates mode */
  79763. static readonly INVCUBIC_MODE: number;
  79764. /** Equirectangular coordinates mode */
  79765. static readonly EQUIRECTANGULAR_MODE: number;
  79766. /** Equirectangular Fixed coordinates mode */
  79767. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  79768. /** Equirectangular Fixed Mirrored coordinates mode */
  79769. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  79770. /** Texture is not repeating outside of 0..1 UVs */
  79771. static readonly CLAMP_ADDRESSMODE: number;
  79772. /** Texture is repeating outside of 0..1 UVs */
  79773. static readonly WRAP_ADDRESSMODE: number;
  79774. /** Texture is repeating and mirrored */
  79775. static readonly MIRROR_ADDRESSMODE: number;
  79776. /**
  79777. * 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
  79778. */
  79779. static UseSerializedUrlIfAny: boolean;
  79780. /**
  79781. * Define the url of the texture.
  79782. */
  79783. url: Nullable<string>;
  79784. /**
  79785. * Define an offset on the texture to offset the u coordinates of the UVs
  79786. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  79787. */
  79788. uOffset: number;
  79789. /**
  79790. * Define an offset on the texture to offset the v coordinates of the UVs
  79791. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  79792. */
  79793. vOffset: number;
  79794. /**
  79795. * Define an offset on the texture to scale the u coordinates of the UVs
  79796. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  79797. */
  79798. uScale: number;
  79799. /**
  79800. * Define an offset on the texture to scale the v coordinates of the UVs
  79801. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  79802. */
  79803. vScale: number;
  79804. /**
  79805. * Define an offset on the texture to rotate around the u coordinates of the UVs
  79806. * @see http://doc.babylonjs.com/how_to/more_materials
  79807. */
  79808. uAng: number;
  79809. /**
  79810. * Define an offset on the texture to rotate around the v coordinates of the UVs
  79811. * @see http://doc.babylonjs.com/how_to/more_materials
  79812. */
  79813. vAng: number;
  79814. /**
  79815. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  79816. * @see http://doc.babylonjs.com/how_to/more_materials
  79817. */
  79818. wAng: number;
  79819. /**
  79820. * Defines the center of rotation (U)
  79821. */
  79822. uRotationCenter: number;
  79823. /**
  79824. * Defines the center of rotation (V)
  79825. */
  79826. vRotationCenter: number;
  79827. /**
  79828. * Defines the center of rotation (W)
  79829. */
  79830. wRotationCenter: number;
  79831. /**
  79832. * Are mip maps generated for this texture or not.
  79833. */
  79834. readonly noMipmap: boolean;
  79835. /**
  79836. * List of inspectable custom properties (used by the Inspector)
  79837. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  79838. */
  79839. inspectableCustomProperties: Nullable<IInspectable[]>;
  79840. private _noMipmap;
  79841. /** @hidden */
  79842. _invertY: boolean;
  79843. private _rowGenerationMatrix;
  79844. private _cachedTextureMatrix;
  79845. private _projectionModeMatrix;
  79846. private _t0;
  79847. private _t1;
  79848. private _t2;
  79849. private _cachedUOffset;
  79850. private _cachedVOffset;
  79851. private _cachedUScale;
  79852. private _cachedVScale;
  79853. private _cachedUAng;
  79854. private _cachedVAng;
  79855. private _cachedWAng;
  79856. private _cachedProjectionMatrixId;
  79857. private _cachedCoordinatesMode;
  79858. /** @hidden */
  79859. protected _initialSamplingMode: number;
  79860. /** @hidden */
  79861. _buffer: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>;
  79862. private _deleteBuffer;
  79863. protected _format: Nullable<number>;
  79864. private _delayedOnLoad;
  79865. private _delayedOnError;
  79866. /**
  79867. * Observable triggered once the texture has been loaded.
  79868. */
  79869. onLoadObservable: Observable<Texture>;
  79870. protected _isBlocking: boolean;
  79871. /**
  79872. * Is the texture preventing material to render while loading.
  79873. * If false, a default texture will be used instead of the loading one during the preparation step.
  79874. */
  79875. isBlocking: boolean;
  79876. /**
  79877. * Get the current sampling mode associated with the texture.
  79878. */
  79879. readonly samplingMode: number;
  79880. /**
  79881. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  79882. */
  79883. readonly invertY: boolean;
  79884. /**
  79885. * Instantiates a new texture.
  79886. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  79887. * @see http://doc.babylonjs.com/babylon101/materials#texture
  79888. * @param url define the url of the picture to load as a texture
  79889. * @param scene define the scene or engine the texture will belong to
  79890. * @param noMipmap define if the texture will require mip maps or not
  79891. * @param invertY define if the texture needs to be inverted on the y axis during loading
  79892. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  79893. * @param onLoad define a callback triggered when the texture has been loaded
  79894. * @param onError define a callback triggered when an error occurred during the loading session
  79895. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  79896. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  79897. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  79898. */
  79899. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | Engine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>, deleteBuffer?: boolean, format?: number);
  79900. /**
  79901. * Update the url (and optional buffer) of this texture if url was null during construction.
  79902. * @param url the url of the texture
  79903. * @param buffer the buffer of the texture (defaults to null)
  79904. * @param onLoad callback called when the texture is loaded (defaults to null)
  79905. */
  79906. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>, onLoad?: () => void): void;
  79907. /**
  79908. * Finish the loading sequence of a texture flagged as delayed load.
  79909. * @hidden
  79910. */
  79911. delayLoad(): void;
  79912. private _prepareRowForTextureGeneration;
  79913. /**
  79914. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  79915. * @returns the transform matrix of the texture.
  79916. */
  79917. getTextureMatrix(): Matrix;
  79918. /**
  79919. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  79920. * @returns The reflection texture transform
  79921. */
  79922. getReflectionTextureMatrix(): Matrix;
  79923. /**
  79924. * Clones the texture.
  79925. * @returns the cloned texture
  79926. */
  79927. clone(): Texture;
  79928. /**
  79929. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  79930. * @returns The JSON representation of the texture
  79931. */
  79932. serialize(): any;
  79933. /**
  79934. * Get the current class name of the texture useful for serialization or dynamic coding.
  79935. * @returns "Texture"
  79936. */
  79937. getClassName(): string;
  79938. /**
  79939. * Dispose the texture and release its associated resources.
  79940. */
  79941. dispose(): void;
  79942. /**
  79943. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  79944. * @param parsedTexture Define the JSON representation of the texture
  79945. * @param scene Define the scene the parsed texture should be instantiated in
  79946. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  79947. * @returns The parsed texture if successful
  79948. */
  79949. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  79950. /**
  79951. * Creates a texture from its base 64 representation.
  79952. * @param data Define the base64 payload without the data: prefix
  79953. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  79954. * @param scene Define the scene the texture should belong to
  79955. * @param noMipmap Forces the texture to not create mip map information if true
  79956. * @param invertY define if the texture needs to be inverted on the y axis during loading
  79957. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  79958. * @param onLoad define a callback triggered when the texture has been loaded
  79959. * @param onError define a callback triggered when an error occurred during the loading session
  79960. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  79961. * @returns the created texture
  79962. */
  79963. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  79964. /**
  79965. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  79966. * @param data Define the base64 payload without the data: prefix
  79967. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  79968. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  79969. * @param scene Define the scene the texture should belong to
  79970. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  79971. * @param noMipmap Forces the texture to not create mip map information if true
  79972. * @param invertY define if the texture needs to be inverted on the y axis during loading
  79973. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  79974. * @param onLoad define a callback triggered when the texture has been loaded
  79975. * @param onError define a callback triggered when an error occurred during the loading session
  79976. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  79977. * @returns the created texture
  79978. */
  79979. 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;
  79980. }
  79981. }
  79982. declare module BABYLON {
  79983. /**
  79984. * PostProcessManager is used to manage one or more post processes or post process pipelines
  79985. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  79986. */
  79987. export class PostProcessManager {
  79988. private _scene;
  79989. private _indexBuffer;
  79990. private _vertexBuffers;
  79991. /**
  79992. * Creates a new instance PostProcess
  79993. * @param scene The scene that the post process is associated with.
  79994. */
  79995. constructor(scene: Scene);
  79996. private _prepareBuffers;
  79997. private _buildIndexBuffer;
  79998. /**
  79999. * Rebuilds the vertex buffers of the manager.
  80000. * @hidden
  80001. */
  80002. _rebuild(): void;
  80003. /**
  80004. * Prepares a frame to be run through a post process.
  80005. * @param sourceTexture The input texture to the post procesess. (default: null)
  80006. * @param postProcesses An array of post processes to be run. (default: null)
  80007. * @returns True if the post processes were able to be run.
  80008. * @hidden
  80009. */
  80010. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  80011. /**
  80012. * Manually render a set of post processes to a texture.
  80013. * @param postProcesses An array of post processes to be run.
  80014. * @param targetTexture The target texture to render to.
  80015. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  80016. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  80017. * @param lodLevel defines which lod of the texture to render to
  80018. */
  80019. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  80020. /**
  80021. * Finalize the result of the output of the postprocesses.
  80022. * @param doNotPresent If true the result will not be displayed to the screen.
  80023. * @param targetTexture The target texture to render to.
  80024. * @param faceIndex The index of the face to bind the target texture to.
  80025. * @param postProcesses The array of post processes to render.
  80026. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  80027. * @hidden
  80028. */
  80029. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  80030. /**
  80031. * Disposes of the post process manager.
  80032. */
  80033. dispose(): void;
  80034. }
  80035. }
  80036. declare module BABYLON {
  80037. /** Interface used by value gradients (color, factor, ...) */
  80038. export interface IValueGradient {
  80039. /**
  80040. * Gets or sets the gradient value (between 0 and 1)
  80041. */
  80042. gradient: number;
  80043. }
  80044. /** Class used to store color4 gradient */
  80045. export class ColorGradient implements IValueGradient {
  80046. /**
  80047. * Gets or sets the gradient value (between 0 and 1)
  80048. */
  80049. gradient: number;
  80050. /**
  80051. * Gets or sets first associated color
  80052. */
  80053. color1: Color4;
  80054. /**
  80055. * Gets or sets second associated color
  80056. */
  80057. color2?: Color4;
  80058. /**
  80059. * Will get a color picked randomly between color1 and color2.
  80060. * If color2 is undefined then color1 will be used
  80061. * @param result defines the target Color4 to store the result in
  80062. */
  80063. getColorToRef(result: Color4): void;
  80064. }
  80065. /** Class used to store color 3 gradient */
  80066. export class Color3Gradient implements IValueGradient {
  80067. /**
  80068. * Gets or sets the gradient value (between 0 and 1)
  80069. */
  80070. gradient: number;
  80071. /**
  80072. * Gets or sets the associated color
  80073. */
  80074. color: Color3;
  80075. }
  80076. /** Class used to store factor gradient */
  80077. export class FactorGradient implements IValueGradient {
  80078. /**
  80079. * Gets or sets the gradient value (between 0 and 1)
  80080. */
  80081. gradient: number;
  80082. /**
  80083. * Gets or sets first associated factor
  80084. */
  80085. factor1: number;
  80086. /**
  80087. * Gets or sets second associated factor
  80088. */
  80089. factor2?: number;
  80090. /**
  80091. * Will get a number picked randomly between factor1 and factor2.
  80092. * If factor2 is undefined then factor1 will be used
  80093. * @returns the picked number
  80094. */
  80095. getFactor(): number;
  80096. }
  80097. /**
  80098. * Helper used to simplify some generic gradient tasks
  80099. */
  80100. export class GradientHelper {
  80101. /**
  80102. * Gets the current gradient from an array of IValueGradient
  80103. * @param ratio defines the current ratio to get
  80104. * @param gradients defines the array of IValueGradient
  80105. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  80106. */
  80107. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  80108. }
  80109. }
  80110. declare module BABYLON {
  80111. interface AbstractScene {
  80112. /**
  80113. * The list of procedural textures added to the scene
  80114. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  80115. */
  80116. proceduralTextures: Array<ProceduralTexture>;
  80117. }
  80118. /**
  80119. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  80120. * in a given scene.
  80121. */
  80122. export class ProceduralTextureSceneComponent implements ISceneComponent {
  80123. /**
  80124. * The component name helpfull to identify the component in the list of scene components.
  80125. */
  80126. readonly name: string;
  80127. /**
  80128. * The scene the component belongs to.
  80129. */
  80130. scene: Scene;
  80131. /**
  80132. * Creates a new instance of the component for the given scene
  80133. * @param scene Defines the scene to register the component in
  80134. */
  80135. constructor(scene: Scene);
  80136. /**
  80137. * Registers the component in a given scene
  80138. */
  80139. register(): void;
  80140. /**
  80141. * Rebuilds the elements related to this component in case of
  80142. * context lost for instance.
  80143. */
  80144. rebuild(): void;
  80145. /**
  80146. * Disposes the component and the associated ressources.
  80147. */
  80148. dispose(): void;
  80149. private _beforeClear;
  80150. }
  80151. }
  80152. declare module BABYLON {
  80153. interface Engine {
  80154. /**
  80155. * Creates a new render target cube texture
  80156. * @param size defines the size of the texture
  80157. * @param options defines the options used to create the texture
  80158. * @returns a new render target cube texture stored in an InternalTexture
  80159. */
  80160. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  80161. }
  80162. }
  80163. declare module BABYLON {
  80164. /** @hidden */
  80165. export var proceduralVertexShader: {
  80166. name: string;
  80167. shader: string;
  80168. };
  80169. }
  80170. declare module BABYLON {
  80171. /**
  80172. * 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.
  80173. * This is the base class of any Procedural texture and contains most of the shareable code.
  80174. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  80175. */
  80176. export class ProceduralTexture extends Texture {
  80177. isCube: boolean;
  80178. /**
  80179. * Define if the texture is enabled or not (disabled texture will not render)
  80180. */
  80181. isEnabled: boolean;
  80182. /**
  80183. * Define if the texture must be cleared before rendering (default is true)
  80184. */
  80185. autoClear: boolean;
  80186. /**
  80187. * Callback called when the texture is generated
  80188. */
  80189. onGenerated: () => void;
  80190. /**
  80191. * Event raised when the texture is generated
  80192. */
  80193. onGeneratedObservable: Observable<ProceduralTexture>;
  80194. /** @hidden */
  80195. _generateMipMaps: boolean;
  80196. /** @hidden **/
  80197. _effect: Effect;
  80198. /** @hidden */
  80199. _textures: {
  80200. [key: string]: Texture;
  80201. };
  80202. private _size;
  80203. private _currentRefreshId;
  80204. private _refreshRate;
  80205. private _vertexBuffers;
  80206. private _indexBuffer;
  80207. private _uniforms;
  80208. private _samplers;
  80209. private _fragment;
  80210. private _floats;
  80211. private _ints;
  80212. private _floatsArrays;
  80213. private _colors3;
  80214. private _colors4;
  80215. private _vectors2;
  80216. private _vectors3;
  80217. private _matrices;
  80218. private _fallbackTexture;
  80219. private _fallbackTextureUsed;
  80220. private _engine;
  80221. private _cachedDefines;
  80222. private _contentUpdateId;
  80223. private _contentData;
  80224. /**
  80225. * Instantiates a new procedural texture.
  80226. * 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.
  80227. * This is the base class of any Procedural texture and contains most of the shareable code.
  80228. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  80229. * @param name Define the name of the texture
  80230. * @param size Define the size of the texture to create
  80231. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  80232. * @param scene Define the scene the texture belongs to
  80233. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  80234. * @param generateMipMaps Define if the texture should creates mip maps or not
  80235. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  80236. */
  80237. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  80238. /**
  80239. * The effect that is created when initializing the post process.
  80240. * @returns The created effect corresponding the the postprocess.
  80241. */
  80242. getEffect(): Effect;
  80243. /**
  80244. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  80245. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  80246. */
  80247. getContent(): Nullable<ArrayBufferView>;
  80248. private _createIndexBuffer;
  80249. /** @hidden */
  80250. _rebuild(): void;
  80251. /**
  80252. * Resets the texture in order to recreate its associated resources.
  80253. * This can be called in case of context loss
  80254. */
  80255. reset(): void;
  80256. protected _getDefines(): string;
  80257. /**
  80258. * Is the texture ready to be used ? (rendered at least once)
  80259. * @returns true if ready, otherwise, false.
  80260. */
  80261. isReady(): boolean;
  80262. /**
  80263. * Resets the refresh counter of the texture and start bak from scratch.
  80264. * Could be useful to regenerate the texture if it is setup to render only once.
  80265. */
  80266. resetRefreshCounter(): void;
  80267. /**
  80268. * Set the fragment shader to use in order to render the texture.
  80269. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  80270. */
  80271. setFragment(fragment: any): void;
  80272. /**
  80273. * Define the refresh rate of the texture or the rendering frequency.
  80274. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  80275. */
  80276. refreshRate: number;
  80277. /** @hidden */
  80278. _shouldRender(): boolean;
  80279. /**
  80280. * Get the size the texture is rendering at.
  80281. * @returns the size (texture is always squared)
  80282. */
  80283. getRenderSize(): number;
  80284. /**
  80285. * Resize the texture to new value.
  80286. * @param size Define the new size the texture should have
  80287. * @param generateMipMaps Define whether the new texture should create mip maps
  80288. */
  80289. resize(size: number, generateMipMaps: boolean): void;
  80290. private _checkUniform;
  80291. /**
  80292. * Set a texture in the shader program used to render.
  80293. * @param name Define the name of the uniform samplers as defined in the shader
  80294. * @param texture Define the texture to bind to this sampler
  80295. * @return the texture itself allowing "fluent" like uniform updates
  80296. */
  80297. setTexture(name: string, texture: Texture): ProceduralTexture;
  80298. /**
  80299. * Set a float in the shader.
  80300. * @param name Define the name of the uniform as defined in the shader
  80301. * @param value Define the value to give to the uniform
  80302. * @return the texture itself allowing "fluent" like uniform updates
  80303. */
  80304. setFloat(name: string, value: number): ProceduralTexture;
  80305. /**
  80306. * Set a int in the shader.
  80307. * @param name Define the name of the uniform as defined in the shader
  80308. * @param value Define the value to give to the uniform
  80309. * @return the texture itself allowing "fluent" like uniform updates
  80310. */
  80311. setInt(name: string, value: number): ProceduralTexture;
  80312. /**
  80313. * Set an array of floats in the shader.
  80314. * @param name Define the name of the uniform as defined in the shader
  80315. * @param value Define the value to give to the uniform
  80316. * @return the texture itself allowing "fluent" like uniform updates
  80317. */
  80318. setFloats(name: string, value: number[]): ProceduralTexture;
  80319. /**
  80320. * Set a vec3 in the shader from a Color3.
  80321. * @param name Define the name of the uniform as defined in the shader
  80322. * @param value Define the value to give to the uniform
  80323. * @return the texture itself allowing "fluent" like uniform updates
  80324. */
  80325. setColor3(name: string, value: Color3): ProceduralTexture;
  80326. /**
  80327. * Set a vec4 in the shader from a Color4.
  80328. * @param name Define the name of the uniform as defined in the shader
  80329. * @param value Define the value to give to the uniform
  80330. * @return the texture itself allowing "fluent" like uniform updates
  80331. */
  80332. setColor4(name: string, value: Color4): ProceduralTexture;
  80333. /**
  80334. * Set a vec2 in the shader from a Vector2.
  80335. * @param name Define the name of the uniform as defined in the shader
  80336. * @param value Define the value to give to the uniform
  80337. * @return the texture itself allowing "fluent" like uniform updates
  80338. */
  80339. setVector2(name: string, value: Vector2): ProceduralTexture;
  80340. /**
  80341. * Set a vec3 in the shader from a Vector3.
  80342. * @param name Define the name of the uniform as defined in the shader
  80343. * @param value Define the value to give to the uniform
  80344. * @return the texture itself allowing "fluent" like uniform updates
  80345. */
  80346. setVector3(name: string, value: Vector3): ProceduralTexture;
  80347. /**
  80348. * Set a mat4 in the shader from a MAtrix.
  80349. * @param name Define the name of the uniform as defined in the shader
  80350. * @param value Define the value to give to the uniform
  80351. * @return the texture itself allowing "fluent" like uniform updates
  80352. */
  80353. setMatrix(name: string, value: Matrix): ProceduralTexture;
  80354. /**
  80355. * Render the texture to its associated render target.
  80356. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  80357. */
  80358. render(useCameraPostProcess?: boolean): void;
  80359. /**
  80360. * Clone the texture.
  80361. * @returns the cloned texture
  80362. */
  80363. clone(): ProceduralTexture;
  80364. /**
  80365. * Dispose the texture and release its asoociated resources.
  80366. */
  80367. dispose(): void;
  80368. }
  80369. }
  80370. declare module BABYLON {
  80371. /**
  80372. * This represents the base class for particle system in Babylon.
  80373. * 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.
  80374. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  80375. * @example https://doc.babylonjs.com/babylon101/particles
  80376. */
  80377. export class BaseParticleSystem {
  80378. /**
  80379. * Source color is added to the destination color without alpha affecting the result
  80380. */
  80381. static BLENDMODE_ONEONE: number;
  80382. /**
  80383. * Blend current color and particle color using particle’s alpha
  80384. */
  80385. static BLENDMODE_STANDARD: number;
  80386. /**
  80387. * Add current color and particle color multiplied by particle’s alpha
  80388. */
  80389. static BLENDMODE_ADD: number;
  80390. /**
  80391. * Multiply current color with particle color
  80392. */
  80393. static BLENDMODE_MULTIPLY: number;
  80394. /**
  80395. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  80396. */
  80397. static BLENDMODE_MULTIPLYADD: number;
  80398. /**
  80399. * List of animations used by the particle system.
  80400. */
  80401. animations: Animation[];
  80402. /**
  80403. * The id of the Particle system.
  80404. */
  80405. id: string;
  80406. /**
  80407. * The friendly name of the Particle system.
  80408. */
  80409. name: string;
  80410. /**
  80411. * The rendering group used by the Particle system to chose when to render.
  80412. */
  80413. renderingGroupId: number;
  80414. /**
  80415. * The emitter represents the Mesh or position we are attaching the particle system to.
  80416. */
  80417. emitter: Nullable<AbstractMesh | Vector3>;
  80418. /**
  80419. * The maximum number of particles to emit per frame
  80420. */
  80421. emitRate: number;
  80422. /**
  80423. * If you want to launch only a few particles at once, that can be done, as well.
  80424. */
  80425. manualEmitCount: number;
  80426. /**
  80427. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  80428. */
  80429. updateSpeed: number;
  80430. /**
  80431. * The amount of time the particle system is running (depends of the overall update speed).
  80432. */
  80433. targetStopDuration: number;
  80434. /**
  80435. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  80436. */
  80437. disposeOnStop: boolean;
  80438. /**
  80439. * Minimum power of emitting particles.
  80440. */
  80441. minEmitPower: number;
  80442. /**
  80443. * Maximum power of emitting particles.
  80444. */
  80445. maxEmitPower: number;
  80446. /**
  80447. * Minimum life time of emitting particles.
  80448. */
  80449. minLifeTime: number;
  80450. /**
  80451. * Maximum life time of emitting particles.
  80452. */
  80453. maxLifeTime: number;
  80454. /**
  80455. * Minimum Size of emitting particles.
  80456. */
  80457. minSize: number;
  80458. /**
  80459. * Maximum Size of emitting particles.
  80460. */
  80461. maxSize: number;
  80462. /**
  80463. * Minimum scale of emitting particles on X axis.
  80464. */
  80465. minScaleX: number;
  80466. /**
  80467. * Maximum scale of emitting particles on X axis.
  80468. */
  80469. maxScaleX: number;
  80470. /**
  80471. * Minimum scale of emitting particles on Y axis.
  80472. */
  80473. minScaleY: number;
  80474. /**
  80475. * Maximum scale of emitting particles on Y axis.
  80476. */
  80477. maxScaleY: number;
  80478. /**
  80479. * Gets or sets the minimal initial rotation in radians.
  80480. */
  80481. minInitialRotation: number;
  80482. /**
  80483. * Gets or sets the maximal initial rotation in radians.
  80484. */
  80485. maxInitialRotation: number;
  80486. /**
  80487. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  80488. */
  80489. minAngularSpeed: number;
  80490. /**
  80491. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  80492. */
  80493. maxAngularSpeed: number;
  80494. /**
  80495. * The texture used to render each particle. (this can be a spritesheet)
  80496. */
  80497. particleTexture: Nullable<Texture>;
  80498. /**
  80499. * The layer mask we are rendering the particles through.
  80500. */
  80501. layerMask: number;
  80502. /**
  80503. * This can help using your own shader to render the particle system.
  80504. * The according effect will be created
  80505. */
  80506. customShader: any;
  80507. /**
  80508. * By default particle system starts as soon as they are created. This prevents the
  80509. * automatic start to happen and let you decide when to start emitting particles.
  80510. */
  80511. preventAutoStart: boolean;
  80512. private _noiseTexture;
  80513. /**
  80514. * Gets or sets a texture used to add random noise to particle positions
  80515. */
  80516. noiseTexture: Nullable<ProceduralTexture>;
  80517. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  80518. noiseStrength: Vector3;
  80519. /**
  80520. * Callback triggered when the particle animation is ending.
  80521. */
  80522. onAnimationEnd: Nullable<() => void>;
  80523. /**
  80524. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  80525. */
  80526. blendMode: number;
  80527. /**
  80528. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  80529. * to override the particles.
  80530. */
  80531. forceDepthWrite: boolean;
  80532. /** 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 */
  80533. preWarmCycles: number;
  80534. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  80535. preWarmStepOffset: number;
  80536. /**
  80537. * 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)
  80538. */
  80539. spriteCellChangeSpeed: number;
  80540. /**
  80541. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  80542. */
  80543. startSpriteCellID: number;
  80544. /**
  80545. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  80546. */
  80547. endSpriteCellID: number;
  80548. /**
  80549. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  80550. */
  80551. spriteCellWidth: number;
  80552. /**
  80553. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  80554. */
  80555. spriteCellHeight: number;
  80556. /**
  80557. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  80558. */
  80559. spriteRandomStartCell: boolean;
  80560. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  80561. translationPivot: Vector2;
  80562. /** @hidden */
  80563. protected _isAnimationSheetEnabled: boolean;
  80564. /**
  80565. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  80566. */
  80567. beginAnimationOnStart: boolean;
  80568. /**
  80569. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  80570. */
  80571. beginAnimationFrom: number;
  80572. /**
  80573. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  80574. */
  80575. beginAnimationTo: number;
  80576. /**
  80577. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  80578. */
  80579. beginAnimationLoop: boolean;
  80580. /**
  80581. * Gets or sets a world offset applied to all particles
  80582. */
  80583. worldOffset: Vector3;
  80584. /**
  80585. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  80586. */
  80587. isAnimationSheetEnabled: boolean;
  80588. /**
  80589. * Get hosting scene
  80590. * @returns the scene
  80591. */
  80592. getScene(): Scene;
  80593. /**
  80594. * You can use gravity if you want to give an orientation to your particles.
  80595. */
  80596. gravity: Vector3;
  80597. protected _colorGradients: Nullable<Array<ColorGradient>>;
  80598. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  80599. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  80600. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  80601. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  80602. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  80603. protected _dragGradients: Nullable<Array<FactorGradient>>;
  80604. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  80605. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  80606. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  80607. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  80608. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  80609. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  80610. /**
  80611. * Defines the delay in milliseconds before starting the system (0 by default)
  80612. */
  80613. startDelay: number;
  80614. /**
  80615. * Gets the current list of drag gradients.
  80616. * You must use addDragGradient and removeDragGradient to udpate this list
  80617. * @returns the list of drag gradients
  80618. */
  80619. getDragGradients(): Nullable<Array<FactorGradient>>;
  80620. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  80621. limitVelocityDamping: number;
  80622. /**
  80623. * Gets the current list of limit velocity gradients.
  80624. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  80625. * @returns the list of limit velocity gradients
  80626. */
  80627. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  80628. /**
  80629. * Gets the current list of color gradients.
  80630. * You must use addColorGradient and removeColorGradient to udpate this list
  80631. * @returns the list of color gradients
  80632. */
  80633. getColorGradients(): Nullable<Array<ColorGradient>>;
  80634. /**
  80635. * Gets the current list of size gradients.
  80636. * You must use addSizeGradient and removeSizeGradient to udpate this list
  80637. * @returns the list of size gradients
  80638. */
  80639. getSizeGradients(): Nullable<Array<FactorGradient>>;
  80640. /**
  80641. * Gets the current list of color remap gradients.
  80642. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  80643. * @returns the list of color remap gradients
  80644. */
  80645. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  80646. /**
  80647. * Gets the current list of alpha remap gradients.
  80648. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  80649. * @returns the list of alpha remap gradients
  80650. */
  80651. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  80652. /**
  80653. * Gets the current list of life time gradients.
  80654. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  80655. * @returns the list of life time gradients
  80656. */
  80657. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  80658. /**
  80659. * Gets the current list of angular speed gradients.
  80660. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  80661. * @returns the list of angular speed gradients
  80662. */
  80663. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  80664. /**
  80665. * Gets the current list of velocity gradients.
  80666. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  80667. * @returns the list of velocity gradients
  80668. */
  80669. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  80670. /**
  80671. * Gets the current list of start size gradients.
  80672. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  80673. * @returns the list of start size gradients
  80674. */
  80675. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  80676. /**
  80677. * Gets the current list of emit rate gradients.
  80678. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  80679. * @returns the list of emit rate gradients
  80680. */
  80681. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  80682. /**
  80683. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  80684. * This only works when particleEmitterTyps is a BoxParticleEmitter
  80685. */
  80686. direction1: Vector3;
  80687. /**
  80688. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  80689. * This only works when particleEmitterTyps is a BoxParticleEmitter
  80690. */
  80691. direction2: Vector3;
  80692. /**
  80693. * 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.
  80694. * This only works when particleEmitterTyps is a BoxParticleEmitter
  80695. */
  80696. minEmitBox: Vector3;
  80697. /**
  80698. * 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.
  80699. * This only works when particleEmitterTyps is a BoxParticleEmitter
  80700. */
  80701. maxEmitBox: Vector3;
  80702. /**
  80703. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  80704. */
  80705. color1: Color4;
  80706. /**
  80707. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  80708. */
  80709. color2: Color4;
  80710. /**
  80711. * Color the particle will have at the end of its lifetime
  80712. */
  80713. colorDead: Color4;
  80714. /**
  80715. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  80716. */
  80717. textureMask: Color4;
  80718. /**
  80719. * The particle emitter type defines the emitter used by the particle system.
  80720. * It can be for example box, sphere, or cone...
  80721. */
  80722. particleEmitterType: IParticleEmitterType;
  80723. /** @hidden */
  80724. _isSubEmitter: boolean;
  80725. /**
  80726. * Gets or sets the billboard mode to use when isBillboardBased = true.
  80727. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  80728. */
  80729. billboardMode: number;
  80730. protected _isBillboardBased: boolean;
  80731. /**
  80732. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  80733. */
  80734. isBillboardBased: boolean;
  80735. /**
  80736. * The scene the particle system belongs to.
  80737. */
  80738. protected _scene: Scene;
  80739. /**
  80740. * Local cache of defines for image processing.
  80741. */
  80742. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  80743. /**
  80744. * Default configuration related to image processing available in the standard Material.
  80745. */
  80746. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  80747. /**
  80748. * Gets the image processing configuration used either in this material.
  80749. */
  80750. /**
  80751. * Sets the Default image processing configuration used either in the this material.
  80752. *
  80753. * If sets to null, the scene one is in use.
  80754. */
  80755. imageProcessingConfiguration: ImageProcessingConfiguration;
  80756. /**
  80757. * Attaches a new image processing configuration to the Standard Material.
  80758. * @param configuration
  80759. */
  80760. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  80761. /** @hidden */
  80762. protected _reset(): void;
  80763. /** @hidden */
  80764. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  80765. /**
  80766. * Instantiates a particle system.
  80767. * 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.
  80768. * @param name The name of the particle system
  80769. */
  80770. constructor(name: string);
  80771. /**
  80772. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  80773. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  80774. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  80775. * @returns the emitter
  80776. */
  80777. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  80778. /**
  80779. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  80780. * @param radius The radius of the hemisphere to emit from
  80781. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  80782. * @returns the emitter
  80783. */
  80784. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  80785. /**
  80786. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  80787. * @param radius The radius of the sphere to emit from
  80788. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  80789. * @returns the emitter
  80790. */
  80791. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  80792. /**
  80793. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  80794. * @param radius The radius of the sphere to emit from
  80795. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  80796. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  80797. * @returns the emitter
  80798. */
  80799. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  80800. /**
  80801. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  80802. * @param radius The radius of the emission cylinder
  80803. * @param height The height of the emission cylinder
  80804. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  80805. * @param directionRandomizer How much to randomize the particle direction [0-1]
  80806. * @returns the emitter
  80807. */
  80808. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  80809. /**
  80810. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  80811. * @param radius The radius of the cylinder to emit from
  80812. * @param height The height of the emission cylinder
  80813. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  80814. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  80815. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  80816. * @returns the emitter
  80817. */
  80818. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  80819. /**
  80820. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  80821. * @param radius The radius of the cone to emit from
  80822. * @param angle The base angle of the cone
  80823. * @returns the emitter
  80824. */
  80825. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  80826. /**
  80827. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  80828. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  80829. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  80830. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  80831. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  80832. * @returns the emitter
  80833. */
  80834. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  80835. }
  80836. }
  80837. declare module BABYLON {
  80838. /**
  80839. * Type of sub emitter
  80840. */
  80841. export enum SubEmitterType {
  80842. /**
  80843. * Attached to the particle over it's lifetime
  80844. */
  80845. ATTACHED = 0,
  80846. /**
  80847. * Created when the particle dies
  80848. */
  80849. END = 1
  80850. }
  80851. /**
  80852. * Sub emitter class used to emit particles from an existing particle
  80853. */
  80854. export class SubEmitter {
  80855. /**
  80856. * the particle system to be used by the sub emitter
  80857. */
  80858. particleSystem: ParticleSystem;
  80859. /**
  80860. * Type of the submitter (Default: END)
  80861. */
  80862. type: SubEmitterType;
  80863. /**
  80864. * 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)
  80865. * Note: This only is supported when using an emitter of type Mesh
  80866. */
  80867. inheritDirection: boolean;
  80868. /**
  80869. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  80870. */
  80871. inheritedVelocityAmount: number;
  80872. /**
  80873. * Creates a sub emitter
  80874. * @param particleSystem the particle system to be used by the sub emitter
  80875. */
  80876. constructor(
  80877. /**
  80878. * the particle system to be used by the sub emitter
  80879. */
  80880. particleSystem: ParticleSystem);
  80881. /**
  80882. * Clones the sub emitter
  80883. * @returns the cloned sub emitter
  80884. */
  80885. clone(): SubEmitter;
  80886. /**
  80887. * Serialize current object to a JSON object
  80888. * @returns the serialized object
  80889. */
  80890. serialize(): any;
  80891. /** @hidden */
  80892. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  80893. /**
  80894. * Creates a new SubEmitter from a serialized JSON version
  80895. * @param serializationObject defines the JSON object to read from
  80896. * @param scene defines the hosting scene
  80897. * @param rootUrl defines the rootUrl for data loading
  80898. * @returns a new SubEmitter
  80899. */
  80900. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  80901. /** Release associated resources */
  80902. dispose(): void;
  80903. }
  80904. }
  80905. declare module BABYLON {
  80906. /** @hidden */
  80907. export var clipPlaneFragmentDeclaration: {
  80908. name: string;
  80909. shader: string;
  80910. };
  80911. }
  80912. declare module BABYLON {
  80913. /** @hidden */
  80914. export var imageProcessingDeclaration: {
  80915. name: string;
  80916. shader: string;
  80917. };
  80918. }
  80919. declare module BABYLON {
  80920. /** @hidden */
  80921. export var imageProcessingFunctions: {
  80922. name: string;
  80923. shader: string;
  80924. };
  80925. }
  80926. declare module BABYLON {
  80927. /** @hidden */
  80928. export var clipPlaneFragment: {
  80929. name: string;
  80930. shader: string;
  80931. };
  80932. }
  80933. declare module BABYLON {
  80934. /** @hidden */
  80935. export var particlesPixelShader: {
  80936. name: string;
  80937. shader: string;
  80938. };
  80939. }
  80940. declare module BABYLON {
  80941. /** @hidden */
  80942. export var clipPlaneVertexDeclaration: {
  80943. name: string;
  80944. shader: string;
  80945. };
  80946. }
  80947. declare module BABYLON {
  80948. /** @hidden */
  80949. export var clipPlaneVertex: {
  80950. name: string;
  80951. shader: string;
  80952. };
  80953. }
  80954. declare module BABYLON {
  80955. /** @hidden */
  80956. export var particlesVertexShader: {
  80957. name: string;
  80958. shader: string;
  80959. };
  80960. }
  80961. declare module BABYLON {
  80962. /**
  80963. * This represents a particle system in Babylon.
  80964. * 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.
  80965. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  80966. * @example https://doc.babylonjs.com/babylon101/particles
  80967. */
  80968. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  80969. /**
  80970. * Billboard mode will only apply to Y axis
  80971. */
  80972. static readonly BILLBOARDMODE_Y: number;
  80973. /**
  80974. * Billboard mode will apply to all axes
  80975. */
  80976. static readonly BILLBOARDMODE_ALL: number;
  80977. /**
  80978. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80979. */
  80980. static readonly BILLBOARDMODE_STRETCHED: number;
  80981. /**
  80982. * This function can be defined to provide custom update for active particles.
  80983. * This function will be called instead of regular update (age, position, color, etc.).
  80984. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  80985. */
  80986. updateFunction: (particles: Particle[]) => void;
  80987. private _emitterWorldMatrix;
  80988. /**
  80989. * This function can be defined to specify initial direction for every new particle.
  80990. * It by default use the emitterType defined function
  80991. */
  80992. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  80993. /**
  80994. * This function can be defined to specify initial position for every new particle.
  80995. * It by default use the emitterType defined function
  80996. */
  80997. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  80998. /**
  80999. * @hidden
  81000. */
  81001. _inheritedVelocityOffset: Vector3;
  81002. /**
  81003. * An event triggered when the system is disposed
  81004. */
  81005. onDisposeObservable: Observable<ParticleSystem>;
  81006. private _onDisposeObserver;
  81007. /**
  81008. * Sets a callback that will be triggered when the system is disposed
  81009. */
  81010. onDispose: () => void;
  81011. private _particles;
  81012. private _epsilon;
  81013. private _capacity;
  81014. private _stockParticles;
  81015. private _newPartsExcess;
  81016. private _vertexData;
  81017. private _vertexBuffer;
  81018. private _vertexBuffers;
  81019. private _spriteBuffer;
  81020. private _indexBuffer;
  81021. private _effect;
  81022. private _customEffect;
  81023. private _cachedDefines;
  81024. private _scaledColorStep;
  81025. private _colorDiff;
  81026. private _scaledDirection;
  81027. private _scaledGravity;
  81028. private _currentRenderId;
  81029. private _alive;
  81030. private _useInstancing;
  81031. private _started;
  81032. private _stopped;
  81033. private _actualFrame;
  81034. private _scaledUpdateSpeed;
  81035. private _vertexBufferSize;
  81036. /** @hidden */
  81037. _currentEmitRateGradient: Nullable<FactorGradient>;
  81038. /** @hidden */
  81039. _currentEmitRate1: number;
  81040. /** @hidden */
  81041. _currentEmitRate2: number;
  81042. /** @hidden */
  81043. _currentStartSizeGradient: Nullable<FactorGradient>;
  81044. /** @hidden */
  81045. _currentStartSize1: number;
  81046. /** @hidden */
  81047. _currentStartSize2: number;
  81048. private readonly _rawTextureWidth;
  81049. private _rampGradientsTexture;
  81050. private _useRampGradients;
  81051. /** Gets or sets a boolean indicating that ramp gradients must be used
  81052. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  81053. */
  81054. useRampGradients: boolean;
  81055. /**
  81056. * 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.
  81057. * 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: [])
  81058. */
  81059. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  81060. private _subEmitters;
  81061. /**
  81062. * @hidden
  81063. * If the particle systems emitter should be disposed when the particle system is disposed
  81064. */
  81065. _disposeEmitterOnDispose: boolean;
  81066. /**
  81067. * The current active Sub-systems, this property is used by the root particle system only.
  81068. */
  81069. activeSubSystems: Array<ParticleSystem>;
  81070. private _rootParticleSystem;
  81071. /**
  81072. * Gets the current list of active particles
  81073. */
  81074. readonly particles: Particle[];
  81075. /**
  81076. * Returns the string "ParticleSystem"
  81077. * @returns a string containing the class name
  81078. */
  81079. getClassName(): string;
  81080. /**
  81081. * Instantiates a particle system.
  81082. * 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.
  81083. * @param name The name of the particle system
  81084. * @param capacity The max number of particles alive at the same time
  81085. * @param scene The scene the particle system belongs to
  81086. * @param customEffect a custom effect used to change the way particles are rendered by default
  81087. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  81088. * @param epsilon Offset used to render the particles
  81089. */
  81090. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  81091. private _addFactorGradient;
  81092. private _removeFactorGradient;
  81093. /**
  81094. * Adds a new life time gradient
  81095. * @param gradient defines the gradient to use (between 0 and 1)
  81096. * @param factor defines the life time factor to affect to the specified gradient
  81097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81098. * @returns the current particle system
  81099. */
  81100. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81101. /**
  81102. * Remove a specific life time gradient
  81103. * @param gradient defines the gradient to remove
  81104. * @returns the current particle system
  81105. */
  81106. removeLifeTimeGradient(gradient: number): IParticleSystem;
  81107. /**
  81108. * Adds a new size gradient
  81109. * @param gradient defines the gradient to use (between 0 and 1)
  81110. * @param factor defines the size factor to affect to the specified gradient
  81111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81112. * @returns the current particle system
  81113. */
  81114. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81115. /**
  81116. * Remove a specific size gradient
  81117. * @param gradient defines the gradient to remove
  81118. * @returns the current particle system
  81119. */
  81120. removeSizeGradient(gradient: number): IParticleSystem;
  81121. /**
  81122. * Adds a new color remap gradient
  81123. * @param gradient defines the gradient to use (between 0 and 1)
  81124. * @param min defines the color remap minimal range
  81125. * @param max defines the color remap maximal range
  81126. * @returns the current particle system
  81127. */
  81128. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  81129. /**
  81130. * Remove a specific color remap gradient
  81131. * @param gradient defines the gradient to remove
  81132. * @returns the current particle system
  81133. */
  81134. removeColorRemapGradient(gradient: number): IParticleSystem;
  81135. /**
  81136. * Adds a new alpha remap gradient
  81137. * @param gradient defines the gradient to use (between 0 and 1)
  81138. * @param min defines the alpha remap minimal range
  81139. * @param max defines the alpha remap maximal range
  81140. * @returns the current particle system
  81141. */
  81142. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  81143. /**
  81144. * Remove a specific alpha remap gradient
  81145. * @param gradient defines the gradient to remove
  81146. * @returns the current particle system
  81147. */
  81148. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  81149. /**
  81150. * Adds a new angular speed gradient
  81151. * @param gradient defines the gradient to use (between 0 and 1)
  81152. * @param factor defines the angular speed to affect to the specified gradient
  81153. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81154. * @returns the current particle system
  81155. */
  81156. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81157. /**
  81158. * Remove a specific angular speed gradient
  81159. * @param gradient defines the gradient to remove
  81160. * @returns the current particle system
  81161. */
  81162. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  81163. /**
  81164. * Adds a new velocity gradient
  81165. * @param gradient defines the gradient to use (between 0 and 1)
  81166. * @param factor defines the velocity to affect to the specified gradient
  81167. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81168. * @returns the current particle system
  81169. */
  81170. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81171. /**
  81172. * Remove a specific velocity gradient
  81173. * @param gradient defines the gradient to remove
  81174. * @returns the current particle system
  81175. */
  81176. removeVelocityGradient(gradient: number): IParticleSystem;
  81177. /**
  81178. * Adds a new limit velocity gradient
  81179. * @param gradient defines the gradient to use (between 0 and 1)
  81180. * @param factor defines the limit velocity value to affect to the specified gradient
  81181. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81182. * @returns the current particle system
  81183. */
  81184. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81185. /**
  81186. * Remove a specific limit velocity gradient
  81187. * @param gradient defines the gradient to remove
  81188. * @returns the current particle system
  81189. */
  81190. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  81191. /**
  81192. * Adds a new drag gradient
  81193. * @param gradient defines the gradient to use (between 0 and 1)
  81194. * @param factor defines the drag value to affect to the specified gradient
  81195. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81196. * @returns the current particle system
  81197. */
  81198. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81199. /**
  81200. * Remove a specific drag gradient
  81201. * @param gradient defines the gradient to remove
  81202. * @returns the current particle system
  81203. */
  81204. removeDragGradient(gradient: number): IParticleSystem;
  81205. /**
  81206. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  81207. * @param gradient defines the gradient to use (between 0 and 1)
  81208. * @param factor defines the emit rate value to affect to the specified gradient
  81209. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81210. * @returns the current particle system
  81211. */
  81212. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81213. /**
  81214. * Remove a specific emit rate gradient
  81215. * @param gradient defines the gradient to remove
  81216. * @returns the current particle system
  81217. */
  81218. removeEmitRateGradient(gradient: number): IParticleSystem;
  81219. /**
  81220. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  81221. * @param gradient defines the gradient to use (between 0 and 1)
  81222. * @param factor defines the start size value to affect to the specified gradient
  81223. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  81224. * @returns the current particle system
  81225. */
  81226. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  81227. /**
  81228. * Remove a specific start size gradient
  81229. * @param gradient defines the gradient to remove
  81230. * @returns the current particle system
  81231. */
  81232. removeStartSizeGradient(gradient: number): IParticleSystem;
  81233. private _createRampGradientTexture;
  81234. /**
  81235. * Gets the current list of ramp gradients.
  81236. * You must use addRampGradient and removeRampGradient to udpate this list
  81237. * @returns the list of ramp gradients
  81238. */
  81239. getRampGradients(): Nullable<Array<Color3Gradient>>;
  81240. /**
  81241. * Adds a new ramp gradient used to remap particle colors
  81242. * @param gradient defines the gradient to use (between 0 and 1)
  81243. * @param color defines the color to affect to the specified gradient
  81244. * @returns the current particle system
  81245. */
  81246. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  81247. /**
  81248. * Remove a specific ramp gradient
  81249. * @param gradient defines the gradient to remove
  81250. * @returns the current particle system
  81251. */
  81252. removeRampGradient(gradient: number): ParticleSystem;
  81253. /**
  81254. * Adds a new color gradient
  81255. * @param gradient defines the gradient to use (between 0 and 1)
  81256. * @param color1 defines the color to affect to the specified gradient
  81257. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  81258. * @returns this particle system
  81259. */
  81260. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  81261. /**
  81262. * Remove a specific color gradient
  81263. * @param gradient defines the gradient to remove
  81264. * @returns this particle system
  81265. */
  81266. removeColorGradient(gradient: number): IParticleSystem;
  81267. private _fetchR;
  81268. protected _reset(): void;
  81269. private _resetEffect;
  81270. private _createVertexBuffers;
  81271. private _createIndexBuffer;
  81272. /**
  81273. * Gets the maximum number of particles active at the same time.
  81274. * @returns The max number of active particles.
  81275. */
  81276. getCapacity(): number;
  81277. /**
  81278. * Gets whether there are still active particles in the system.
  81279. * @returns True if it is alive, otherwise false.
  81280. */
  81281. isAlive(): boolean;
  81282. /**
  81283. * Gets if the system has been started. (Note: this will still be true after stop is called)
  81284. * @returns True if it has been started, otherwise false.
  81285. */
  81286. isStarted(): boolean;
  81287. private _prepareSubEmitterInternalArray;
  81288. /**
  81289. * Starts the particle system and begins to emit
  81290. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  81291. */
  81292. start(delay?: number): void;
  81293. /**
  81294. * Stops the particle system.
  81295. * @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.
  81296. */
  81297. stop(stopSubEmitters?: boolean): void;
  81298. /**
  81299. * Remove all active particles
  81300. */
  81301. reset(): void;
  81302. /**
  81303. * @hidden (for internal use only)
  81304. */
  81305. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  81306. /**
  81307. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  81308. * Its lifetime will start back at 0.
  81309. */
  81310. recycleParticle: (particle: Particle) => void;
  81311. private _stopSubEmitters;
  81312. private _createParticle;
  81313. private _removeFromRoot;
  81314. private _emitFromParticle;
  81315. private _update;
  81316. /** @hidden */
  81317. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  81318. /** @hidden */
  81319. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  81320. /** @hidden */
  81321. private _getEffect;
  81322. /**
  81323. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  81324. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  81325. */
  81326. animate(preWarmOnly?: boolean): void;
  81327. private _appendParticleVertices;
  81328. /**
  81329. * Rebuilds the particle system.
  81330. */
  81331. rebuild(): void;
  81332. /**
  81333. * Is this system ready to be used/rendered
  81334. * @return true if the system is ready
  81335. */
  81336. isReady(): boolean;
  81337. private _render;
  81338. /**
  81339. * Renders the particle system in its current state.
  81340. * @returns the current number of particles
  81341. */
  81342. render(): number;
  81343. /**
  81344. * Disposes the particle system and free the associated resources
  81345. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  81346. */
  81347. dispose(disposeTexture?: boolean): void;
  81348. /**
  81349. * Clones the particle system.
  81350. * @param name The name of the cloned object
  81351. * @param newEmitter The new emitter to use
  81352. * @returns the cloned particle system
  81353. */
  81354. clone(name: string, newEmitter: any): ParticleSystem;
  81355. /**
  81356. * Serializes the particle system to a JSON object.
  81357. * @returns the JSON object
  81358. */
  81359. serialize(): any;
  81360. /** @hidden */
  81361. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  81362. /** @hidden */
  81363. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  81364. /**
  81365. * Parses a JSON object to create a particle system.
  81366. * @param parsedParticleSystem The JSON object to parse
  81367. * @param scene The scene to create the particle system in
  81368. * @param rootUrl The root url to use to load external dependencies like texture
  81369. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  81370. * @returns the Parsed particle system
  81371. */
  81372. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  81373. }
  81374. }
  81375. declare module BABYLON {
  81376. /**
  81377. * A particle represents one of the element emitted by a particle system.
  81378. * This is mainly define by its coordinates, direction, velocity and age.
  81379. */
  81380. export class Particle {
  81381. /**
  81382. * The particle system the particle belongs to.
  81383. */
  81384. particleSystem: ParticleSystem;
  81385. private static _Count;
  81386. /**
  81387. * Unique ID of the particle
  81388. */
  81389. id: number;
  81390. /**
  81391. * The world position of the particle in the scene.
  81392. */
  81393. position: Vector3;
  81394. /**
  81395. * The world direction of the particle in the scene.
  81396. */
  81397. direction: Vector3;
  81398. /**
  81399. * The color of the particle.
  81400. */
  81401. color: Color4;
  81402. /**
  81403. * The color change of the particle per step.
  81404. */
  81405. colorStep: Color4;
  81406. /**
  81407. * Defines how long will the life of the particle be.
  81408. */
  81409. lifeTime: number;
  81410. /**
  81411. * The current age of the particle.
  81412. */
  81413. age: number;
  81414. /**
  81415. * The current size of the particle.
  81416. */
  81417. size: number;
  81418. /**
  81419. * The current scale of the particle.
  81420. */
  81421. scale: Vector2;
  81422. /**
  81423. * The current angle of the particle.
  81424. */
  81425. angle: number;
  81426. /**
  81427. * Defines how fast is the angle changing.
  81428. */
  81429. angularSpeed: number;
  81430. /**
  81431. * Defines the cell index used by the particle to be rendered from a sprite.
  81432. */
  81433. cellIndex: number;
  81434. /**
  81435. * The information required to support color remapping
  81436. */
  81437. remapData: Vector4;
  81438. /** @hidden */
  81439. _randomCellOffset?: number;
  81440. /** @hidden */
  81441. _initialDirection: Nullable<Vector3>;
  81442. /** @hidden */
  81443. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  81444. /** @hidden */
  81445. _initialStartSpriteCellID: number;
  81446. /** @hidden */
  81447. _initialEndSpriteCellID: number;
  81448. /** @hidden */
  81449. _currentColorGradient: Nullable<ColorGradient>;
  81450. /** @hidden */
  81451. _currentColor1: Color4;
  81452. /** @hidden */
  81453. _currentColor2: Color4;
  81454. /** @hidden */
  81455. _currentSizeGradient: Nullable<FactorGradient>;
  81456. /** @hidden */
  81457. _currentSize1: number;
  81458. /** @hidden */
  81459. _currentSize2: number;
  81460. /** @hidden */
  81461. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  81462. /** @hidden */
  81463. _currentAngularSpeed1: number;
  81464. /** @hidden */
  81465. _currentAngularSpeed2: number;
  81466. /** @hidden */
  81467. _currentVelocityGradient: Nullable<FactorGradient>;
  81468. /** @hidden */
  81469. _currentVelocity1: number;
  81470. /** @hidden */
  81471. _currentVelocity2: number;
  81472. /** @hidden */
  81473. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  81474. /** @hidden */
  81475. _currentLimitVelocity1: number;
  81476. /** @hidden */
  81477. _currentLimitVelocity2: number;
  81478. /** @hidden */
  81479. _currentDragGradient: Nullable<FactorGradient>;
  81480. /** @hidden */
  81481. _currentDrag1: number;
  81482. /** @hidden */
  81483. _currentDrag2: number;
  81484. /** @hidden */
  81485. _randomNoiseCoordinates1: Vector3;
  81486. /** @hidden */
  81487. _randomNoiseCoordinates2: Vector3;
  81488. /**
  81489. * Creates a new instance Particle
  81490. * @param particleSystem the particle system the particle belongs to
  81491. */
  81492. constructor(
  81493. /**
  81494. * The particle system the particle belongs to.
  81495. */
  81496. particleSystem: ParticleSystem);
  81497. private updateCellInfoFromSystem;
  81498. /**
  81499. * Defines how the sprite cell index is updated for the particle
  81500. */
  81501. updateCellIndex(): void;
  81502. /** @hidden */
  81503. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  81504. /** @hidden */
  81505. _inheritParticleInfoToSubEmitters(): void;
  81506. /** @hidden */
  81507. _reset(): void;
  81508. /**
  81509. * Copy the properties of particle to another one.
  81510. * @param other the particle to copy the information to.
  81511. */
  81512. copyTo(other: Particle): void;
  81513. }
  81514. }
  81515. declare module BABYLON {
  81516. /**
  81517. * Particle emitter represents a volume emitting particles.
  81518. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  81519. */
  81520. export interface IParticleEmitterType {
  81521. /**
  81522. * Called by the particle System when the direction is computed for the created particle.
  81523. * @param worldMatrix is the world matrix of the particle system
  81524. * @param directionToUpdate is the direction vector to update with the result
  81525. * @param particle is the particle we are computed the direction for
  81526. */
  81527. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81528. /**
  81529. * Called by the particle System when the position is computed for the created particle.
  81530. * @param worldMatrix is the world matrix of the particle system
  81531. * @param positionToUpdate is the position vector to update with the result
  81532. * @param particle is the particle we are computed the position for
  81533. */
  81534. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  81535. /**
  81536. * Clones the current emitter and returns a copy of it
  81537. * @returns the new emitter
  81538. */
  81539. clone(): IParticleEmitterType;
  81540. /**
  81541. * Called by the GPUParticleSystem to setup the update shader
  81542. * @param effect defines the update shader
  81543. */
  81544. applyToShader(effect: Effect): void;
  81545. /**
  81546. * Returns a string to use to update the GPU particles update shader
  81547. * @returns the effect defines string
  81548. */
  81549. getEffectDefines(): string;
  81550. /**
  81551. * Returns a string representing the class name
  81552. * @returns a string containing the class name
  81553. */
  81554. getClassName(): string;
  81555. /**
  81556. * Serializes the particle system to a JSON object.
  81557. * @returns the JSON object
  81558. */
  81559. serialize(): any;
  81560. /**
  81561. * Parse properties from a JSON object
  81562. * @param serializationObject defines the JSON object
  81563. */
  81564. parse(serializationObject: any): void;
  81565. }
  81566. }
  81567. declare module BABYLON {
  81568. /**
  81569. * Particle emitter emitting particles from the inside of a box.
  81570. * It emits the particles randomly between 2 given directions.
  81571. */
  81572. export class BoxParticleEmitter implements IParticleEmitterType {
  81573. /**
  81574. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  81575. */
  81576. direction1: Vector3;
  81577. /**
  81578. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  81579. */
  81580. direction2: Vector3;
  81581. /**
  81582. * 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.
  81583. */
  81584. minEmitBox: Vector3;
  81585. /**
  81586. * 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.
  81587. */
  81588. maxEmitBox: Vector3;
  81589. /**
  81590. * Creates a new instance BoxParticleEmitter
  81591. */
  81592. constructor();
  81593. /**
  81594. * Called by the particle System when the direction is computed for the created particle.
  81595. * @param worldMatrix is the world matrix of the particle system
  81596. * @param directionToUpdate is the direction vector to update with the result
  81597. * @param particle is the particle we are computed the direction for
  81598. */
  81599. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81600. /**
  81601. * Called by the particle System when the position is computed for the created particle.
  81602. * @param worldMatrix is the world matrix of the particle system
  81603. * @param positionToUpdate is the position vector to update with the result
  81604. * @param particle is the particle we are computed the position for
  81605. */
  81606. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  81607. /**
  81608. * Clones the current emitter and returns a copy of it
  81609. * @returns the new emitter
  81610. */
  81611. clone(): BoxParticleEmitter;
  81612. /**
  81613. * Called by the GPUParticleSystem to setup the update shader
  81614. * @param effect defines the update shader
  81615. */
  81616. applyToShader(effect: Effect): void;
  81617. /**
  81618. * Returns a string to use to update the GPU particles update shader
  81619. * @returns a string containng the defines string
  81620. */
  81621. getEffectDefines(): string;
  81622. /**
  81623. * Returns the string "BoxParticleEmitter"
  81624. * @returns a string containing the class name
  81625. */
  81626. getClassName(): string;
  81627. /**
  81628. * Serializes the particle system to a JSON object.
  81629. * @returns the JSON object
  81630. */
  81631. serialize(): any;
  81632. /**
  81633. * Parse properties from a JSON object
  81634. * @param serializationObject defines the JSON object
  81635. */
  81636. parse(serializationObject: any): void;
  81637. }
  81638. }
  81639. declare module BABYLON {
  81640. /**
  81641. * Particle emitter emitting particles from the inside of a cone.
  81642. * It emits the particles alongside the cone volume from the base to the particle.
  81643. * The emission direction might be randomized.
  81644. */
  81645. export class ConeParticleEmitter implements IParticleEmitterType {
  81646. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  81647. directionRandomizer: number;
  81648. private _radius;
  81649. private _angle;
  81650. private _height;
  81651. /**
  81652. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  81653. */
  81654. radiusRange: number;
  81655. /**
  81656. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  81657. */
  81658. heightRange: number;
  81659. /**
  81660. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  81661. */
  81662. emitFromSpawnPointOnly: boolean;
  81663. /**
  81664. * Gets or sets the radius of the emission cone
  81665. */
  81666. radius: number;
  81667. /**
  81668. * Gets or sets the angle of the emission cone
  81669. */
  81670. angle: number;
  81671. private _buildHeight;
  81672. /**
  81673. * Creates a new instance ConeParticleEmitter
  81674. * @param radius the radius of the emission cone (1 by default)
  81675. * @param angle the cone base angle (PI by default)
  81676. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  81677. */
  81678. constructor(radius?: number, angle?: number,
  81679. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  81680. directionRandomizer?: number);
  81681. /**
  81682. * Called by the particle System when the direction is computed for the created particle.
  81683. * @param worldMatrix is the world matrix of the particle system
  81684. * @param directionToUpdate is the direction vector to update with the result
  81685. * @param particle is the particle we are computed the direction for
  81686. */
  81687. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81688. /**
  81689. * Called by the particle System when the position is computed for the created particle.
  81690. * @param worldMatrix is the world matrix of the particle system
  81691. * @param positionToUpdate is the position vector to update with the result
  81692. * @param particle is the particle we are computed the position for
  81693. */
  81694. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  81695. /**
  81696. * Clones the current emitter and returns a copy of it
  81697. * @returns the new emitter
  81698. */
  81699. clone(): ConeParticleEmitter;
  81700. /**
  81701. * Called by the GPUParticleSystem to setup the update shader
  81702. * @param effect defines the update shader
  81703. */
  81704. applyToShader(effect: Effect): void;
  81705. /**
  81706. * Returns a string to use to update the GPU particles update shader
  81707. * @returns a string containng the defines string
  81708. */
  81709. getEffectDefines(): string;
  81710. /**
  81711. * Returns the string "ConeParticleEmitter"
  81712. * @returns a string containing the class name
  81713. */
  81714. getClassName(): string;
  81715. /**
  81716. * Serializes the particle system to a JSON object.
  81717. * @returns the JSON object
  81718. */
  81719. serialize(): any;
  81720. /**
  81721. * Parse properties from a JSON object
  81722. * @param serializationObject defines the JSON object
  81723. */
  81724. parse(serializationObject: any): void;
  81725. }
  81726. }
  81727. declare module BABYLON {
  81728. /**
  81729. * Particle emitter emitting particles from the inside of a cylinder.
  81730. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  81731. */
  81732. export class CylinderParticleEmitter implements IParticleEmitterType {
  81733. /**
  81734. * The radius of the emission cylinder.
  81735. */
  81736. radius: number;
  81737. /**
  81738. * The height of the emission cylinder.
  81739. */
  81740. height: number;
  81741. /**
  81742. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  81743. */
  81744. radiusRange: number;
  81745. /**
  81746. * How much to randomize the particle direction [0-1].
  81747. */
  81748. directionRandomizer: number;
  81749. /**
  81750. * Creates a new instance CylinderParticleEmitter
  81751. * @param radius the radius of the emission cylinder (1 by default)
  81752. * @param height the height of the emission cylinder (1 by default)
  81753. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  81754. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  81755. */
  81756. constructor(
  81757. /**
  81758. * The radius of the emission cylinder.
  81759. */
  81760. radius?: number,
  81761. /**
  81762. * The height of the emission cylinder.
  81763. */
  81764. height?: number,
  81765. /**
  81766. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  81767. */
  81768. radiusRange?: number,
  81769. /**
  81770. * How much to randomize the particle direction [0-1].
  81771. */
  81772. directionRandomizer?: number);
  81773. /**
  81774. * Called by the particle System when the direction is computed for the created particle.
  81775. * @param worldMatrix is the world matrix of the particle system
  81776. * @param directionToUpdate is the direction vector to update with the result
  81777. * @param particle is the particle we are computed the direction for
  81778. */
  81779. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81780. /**
  81781. * Called by the particle System when the position is computed for the created particle.
  81782. * @param worldMatrix is the world matrix of the particle system
  81783. * @param positionToUpdate is the position vector to update with the result
  81784. * @param particle is the particle we are computed the position for
  81785. */
  81786. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  81787. /**
  81788. * Clones the current emitter and returns a copy of it
  81789. * @returns the new emitter
  81790. */
  81791. clone(): CylinderParticleEmitter;
  81792. /**
  81793. * Called by the GPUParticleSystem to setup the update shader
  81794. * @param effect defines the update shader
  81795. */
  81796. applyToShader(effect: Effect): void;
  81797. /**
  81798. * Returns a string to use to update the GPU particles update shader
  81799. * @returns a string containng the defines string
  81800. */
  81801. getEffectDefines(): string;
  81802. /**
  81803. * Returns the string "CylinderParticleEmitter"
  81804. * @returns a string containing the class name
  81805. */
  81806. getClassName(): string;
  81807. /**
  81808. * Serializes the particle system to a JSON object.
  81809. * @returns the JSON object
  81810. */
  81811. serialize(): any;
  81812. /**
  81813. * Parse properties from a JSON object
  81814. * @param serializationObject defines the JSON object
  81815. */
  81816. parse(serializationObject: any): void;
  81817. }
  81818. /**
  81819. * Particle emitter emitting particles from the inside of a cylinder.
  81820. * It emits the particles randomly between two vectors.
  81821. */
  81822. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  81823. /**
  81824. * The min limit of the emission direction.
  81825. */
  81826. direction1: Vector3;
  81827. /**
  81828. * The max limit of the emission direction.
  81829. */
  81830. direction2: Vector3;
  81831. /**
  81832. * Creates a new instance CylinderDirectedParticleEmitter
  81833. * @param radius the radius of the emission cylinder (1 by default)
  81834. * @param height the height of the emission cylinder (1 by default)
  81835. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  81836. * @param direction1 the min limit of the emission direction (up vector by default)
  81837. * @param direction2 the max limit of the emission direction (up vector by default)
  81838. */
  81839. constructor(radius?: number, height?: number, radiusRange?: number,
  81840. /**
  81841. * The min limit of the emission direction.
  81842. */
  81843. direction1?: Vector3,
  81844. /**
  81845. * The max limit of the emission direction.
  81846. */
  81847. direction2?: Vector3);
  81848. /**
  81849. * Called by the particle System when the direction is computed for the created particle.
  81850. * @param worldMatrix is the world matrix of the particle system
  81851. * @param directionToUpdate is the direction vector to update with the result
  81852. * @param particle is the particle we are computed the direction for
  81853. */
  81854. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81855. /**
  81856. * Clones the current emitter and returns a copy of it
  81857. * @returns the new emitter
  81858. */
  81859. clone(): CylinderDirectedParticleEmitter;
  81860. /**
  81861. * Called by the GPUParticleSystem to setup the update shader
  81862. * @param effect defines the update shader
  81863. */
  81864. applyToShader(effect: Effect): void;
  81865. /**
  81866. * Returns a string to use to update the GPU particles update shader
  81867. * @returns a string containng the defines string
  81868. */
  81869. getEffectDefines(): string;
  81870. /**
  81871. * Returns the string "CylinderDirectedParticleEmitter"
  81872. * @returns a string containing the class name
  81873. */
  81874. getClassName(): string;
  81875. /**
  81876. * Serializes the particle system to a JSON object.
  81877. * @returns the JSON object
  81878. */
  81879. serialize(): any;
  81880. /**
  81881. * Parse properties from a JSON object
  81882. * @param serializationObject defines the JSON object
  81883. */
  81884. parse(serializationObject: any): void;
  81885. }
  81886. }
  81887. declare module BABYLON {
  81888. /**
  81889. * Particle emitter emitting particles from the inside of a hemisphere.
  81890. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  81891. */
  81892. export class HemisphericParticleEmitter implements IParticleEmitterType {
  81893. /**
  81894. * The radius of the emission hemisphere.
  81895. */
  81896. radius: number;
  81897. /**
  81898. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  81899. */
  81900. radiusRange: number;
  81901. /**
  81902. * How much to randomize the particle direction [0-1].
  81903. */
  81904. directionRandomizer: number;
  81905. /**
  81906. * Creates a new instance HemisphericParticleEmitter
  81907. * @param radius the radius of the emission hemisphere (1 by default)
  81908. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  81909. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  81910. */
  81911. constructor(
  81912. /**
  81913. * The radius of the emission hemisphere.
  81914. */
  81915. radius?: number,
  81916. /**
  81917. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  81918. */
  81919. radiusRange?: number,
  81920. /**
  81921. * How much to randomize the particle direction [0-1].
  81922. */
  81923. directionRandomizer?: number);
  81924. /**
  81925. * Called by the particle System when the direction is computed for the created particle.
  81926. * @param worldMatrix is the world matrix of the particle system
  81927. * @param directionToUpdate is the direction vector to update with the result
  81928. * @param particle is the particle we are computed the direction for
  81929. */
  81930. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81931. /**
  81932. * Called by the particle System when the position is computed for the created particle.
  81933. * @param worldMatrix is the world matrix of the particle system
  81934. * @param positionToUpdate is the position vector to update with the result
  81935. * @param particle is the particle we are computed the position for
  81936. */
  81937. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  81938. /**
  81939. * Clones the current emitter and returns a copy of it
  81940. * @returns the new emitter
  81941. */
  81942. clone(): HemisphericParticleEmitter;
  81943. /**
  81944. * Called by the GPUParticleSystem to setup the update shader
  81945. * @param effect defines the update shader
  81946. */
  81947. applyToShader(effect: Effect): void;
  81948. /**
  81949. * Returns a string to use to update the GPU particles update shader
  81950. * @returns a string containng the defines string
  81951. */
  81952. getEffectDefines(): string;
  81953. /**
  81954. * Returns the string "HemisphericParticleEmitter"
  81955. * @returns a string containing the class name
  81956. */
  81957. getClassName(): string;
  81958. /**
  81959. * Serializes the particle system to a JSON object.
  81960. * @returns the JSON object
  81961. */
  81962. serialize(): any;
  81963. /**
  81964. * Parse properties from a JSON object
  81965. * @param serializationObject defines the JSON object
  81966. */
  81967. parse(serializationObject: any): void;
  81968. }
  81969. }
  81970. declare module BABYLON {
  81971. /**
  81972. * Particle emitter emitting particles from a point.
  81973. * It emits the particles randomly between 2 given directions.
  81974. */
  81975. export class PointParticleEmitter implements IParticleEmitterType {
  81976. /**
  81977. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  81978. */
  81979. direction1: Vector3;
  81980. /**
  81981. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  81982. */
  81983. direction2: Vector3;
  81984. /**
  81985. * Creates a new instance PointParticleEmitter
  81986. */
  81987. constructor();
  81988. /**
  81989. * Called by the particle System when the direction is computed for the created particle.
  81990. * @param worldMatrix is the world matrix of the particle system
  81991. * @param directionToUpdate is the direction vector to update with the result
  81992. * @param particle is the particle we are computed the direction for
  81993. */
  81994. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  81995. /**
  81996. * Called by the particle System when the position is computed for the created particle.
  81997. * @param worldMatrix is the world matrix of the particle system
  81998. * @param positionToUpdate is the position vector to update with the result
  81999. * @param particle is the particle we are computed the position for
  82000. */
  82001. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  82002. /**
  82003. * Clones the current emitter and returns a copy of it
  82004. * @returns the new emitter
  82005. */
  82006. clone(): PointParticleEmitter;
  82007. /**
  82008. * Called by the GPUParticleSystem to setup the update shader
  82009. * @param effect defines the update shader
  82010. */
  82011. applyToShader(effect: Effect): void;
  82012. /**
  82013. * Returns a string to use to update the GPU particles update shader
  82014. * @returns a string containng the defines string
  82015. */
  82016. getEffectDefines(): string;
  82017. /**
  82018. * Returns the string "PointParticleEmitter"
  82019. * @returns a string containing the class name
  82020. */
  82021. getClassName(): string;
  82022. /**
  82023. * Serializes the particle system to a JSON object.
  82024. * @returns the JSON object
  82025. */
  82026. serialize(): any;
  82027. /**
  82028. * Parse properties from a JSON object
  82029. * @param serializationObject defines the JSON object
  82030. */
  82031. parse(serializationObject: any): void;
  82032. }
  82033. }
  82034. declare module BABYLON {
  82035. /**
  82036. * Particle emitter emitting particles from the inside of a sphere.
  82037. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  82038. */
  82039. export class SphereParticleEmitter implements IParticleEmitterType {
  82040. /**
  82041. * The radius of the emission sphere.
  82042. */
  82043. radius: number;
  82044. /**
  82045. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  82046. */
  82047. radiusRange: number;
  82048. /**
  82049. * How much to randomize the particle direction [0-1].
  82050. */
  82051. directionRandomizer: number;
  82052. /**
  82053. * Creates a new instance SphereParticleEmitter
  82054. * @param radius the radius of the emission sphere (1 by default)
  82055. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  82056. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  82057. */
  82058. constructor(
  82059. /**
  82060. * The radius of the emission sphere.
  82061. */
  82062. radius?: number,
  82063. /**
  82064. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  82065. */
  82066. radiusRange?: number,
  82067. /**
  82068. * How much to randomize the particle direction [0-1].
  82069. */
  82070. directionRandomizer?: number);
  82071. /**
  82072. * Called by the particle System when the direction is computed for the created particle.
  82073. * @param worldMatrix is the world matrix of the particle system
  82074. * @param directionToUpdate is the direction vector to update with the result
  82075. * @param particle is the particle we are computed the direction for
  82076. */
  82077. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  82078. /**
  82079. * Called by the particle System when the position is computed for the created particle.
  82080. * @param worldMatrix is the world matrix of the particle system
  82081. * @param positionToUpdate is the position vector to update with the result
  82082. * @param particle is the particle we are computed the position for
  82083. */
  82084. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  82085. /**
  82086. * Clones the current emitter and returns a copy of it
  82087. * @returns the new emitter
  82088. */
  82089. clone(): SphereParticleEmitter;
  82090. /**
  82091. * Called by the GPUParticleSystem to setup the update shader
  82092. * @param effect defines the update shader
  82093. */
  82094. applyToShader(effect: Effect): void;
  82095. /**
  82096. * Returns a string to use to update the GPU particles update shader
  82097. * @returns a string containng the defines string
  82098. */
  82099. getEffectDefines(): string;
  82100. /**
  82101. * Returns the string "SphereParticleEmitter"
  82102. * @returns a string containing the class name
  82103. */
  82104. getClassName(): string;
  82105. /**
  82106. * Serializes the particle system to a JSON object.
  82107. * @returns the JSON object
  82108. */
  82109. serialize(): any;
  82110. /**
  82111. * Parse properties from a JSON object
  82112. * @param serializationObject defines the JSON object
  82113. */
  82114. parse(serializationObject: any): void;
  82115. }
  82116. /**
  82117. * Particle emitter emitting particles from the inside of a sphere.
  82118. * It emits the particles randomly between two vectors.
  82119. */
  82120. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  82121. /**
  82122. * The min limit of the emission direction.
  82123. */
  82124. direction1: Vector3;
  82125. /**
  82126. * The max limit of the emission direction.
  82127. */
  82128. direction2: Vector3;
  82129. /**
  82130. * Creates a new instance SphereDirectedParticleEmitter
  82131. * @param radius the radius of the emission sphere (1 by default)
  82132. * @param direction1 the min limit of the emission direction (up vector by default)
  82133. * @param direction2 the max limit of the emission direction (up vector by default)
  82134. */
  82135. constructor(radius?: number,
  82136. /**
  82137. * The min limit of the emission direction.
  82138. */
  82139. direction1?: Vector3,
  82140. /**
  82141. * The max limit of the emission direction.
  82142. */
  82143. direction2?: Vector3);
  82144. /**
  82145. * Called by the particle System when the direction is computed for the created particle.
  82146. * @param worldMatrix is the world matrix of the particle system
  82147. * @param directionToUpdate is the direction vector to update with the result
  82148. * @param particle is the particle we are computed the direction for
  82149. */
  82150. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  82151. /**
  82152. * Clones the current emitter and returns a copy of it
  82153. * @returns the new emitter
  82154. */
  82155. clone(): SphereDirectedParticleEmitter;
  82156. /**
  82157. * Called by the GPUParticleSystem to setup the update shader
  82158. * @param effect defines the update shader
  82159. */
  82160. applyToShader(effect: Effect): void;
  82161. /**
  82162. * Returns a string to use to update the GPU particles update shader
  82163. * @returns a string containng the defines string
  82164. */
  82165. getEffectDefines(): string;
  82166. /**
  82167. * Returns the string "SphereDirectedParticleEmitter"
  82168. * @returns a string containing the class name
  82169. */
  82170. getClassName(): string;
  82171. /**
  82172. * Serializes the particle system to a JSON object.
  82173. * @returns the JSON object
  82174. */
  82175. serialize(): any;
  82176. /**
  82177. * Parse properties from a JSON object
  82178. * @param serializationObject defines the JSON object
  82179. */
  82180. parse(serializationObject: any): void;
  82181. }
  82182. }
  82183. declare module BABYLON {
  82184. /**
  82185. * Interface representing a particle system in Babylon.js.
  82186. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  82187. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  82188. */
  82189. export interface IParticleSystem {
  82190. /**
  82191. * List of animations used by the particle system.
  82192. */
  82193. animations: Animation[];
  82194. /**
  82195. * The id of the Particle system.
  82196. */
  82197. id: string;
  82198. /**
  82199. * The name of the Particle system.
  82200. */
  82201. name: string;
  82202. /**
  82203. * The emitter represents the Mesh or position we are attaching the particle system to.
  82204. */
  82205. emitter: Nullable<AbstractMesh | Vector3>;
  82206. /**
  82207. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  82208. */
  82209. isBillboardBased: boolean;
  82210. /**
  82211. * The rendering group used by the Particle system to chose when to render.
  82212. */
  82213. renderingGroupId: number;
  82214. /**
  82215. * The layer mask we are rendering the particles through.
  82216. */
  82217. layerMask: number;
  82218. /**
  82219. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  82220. */
  82221. updateSpeed: number;
  82222. /**
  82223. * The amount of time the particle system is running (depends of the overall update speed).
  82224. */
  82225. targetStopDuration: number;
  82226. /**
  82227. * The texture used to render each particle. (this can be a spritesheet)
  82228. */
  82229. particleTexture: Nullable<Texture>;
  82230. /**
  82231. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  82232. */
  82233. blendMode: number;
  82234. /**
  82235. * Minimum life time of emitting particles.
  82236. */
  82237. minLifeTime: number;
  82238. /**
  82239. * Maximum life time of emitting particles.
  82240. */
  82241. maxLifeTime: number;
  82242. /**
  82243. * Minimum Size of emitting particles.
  82244. */
  82245. minSize: number;
  82246. /**
  82247. * Maximum Size of emitting particles.
  82248. */
  82249. maxSize: number;
  82250. /**
  82251. * Minimum scale of emitting particles on X axis.
  82252. */
  82253. minScaleX: number;
  82254. /**
  82255. * Maximum scale of emitting particles on X axis.
  82256. */
  82257. maxScaleX: number;
  82258. /**
  82259. * Minimum scale of emitting particles on Y axis.
  82260. */
  82261. minScaleY: number;
  82262. /**
  82263. * Maximum scale of emitting particles on Y axis.
  82264. */
  82265. maxScaleY: number;
  82266. /**
  82267. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  82268. */
  82269. color1: Color4;
  82270. /**
  82271. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  82272. */
  82273. color2: Color4;
  82274. /**
  82275. * Color the particle will have at the end of its lifetime.
  82276. */
  82277. colorDead: Color4;
  82278. /**
  82279. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  82280. */
  82281. emitRate: number;
  82282. /**
  82283. * You can use gravity if you want to give an orientation to your particles.
  82284. */
  82285. gravity: Vector3;
  82286. /**
  82287. * Minimum power of emitting particles.
  82288. */
  82289. minEmitPower: number;
  82290. /**
  82291. * Maximum power of emitting particles.
  82292. */
  82293. maxEmitPower: number;
  82294. /**
  82295. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  82296. */
  82297. minAngularSpeed: number;
  82298. /**
  82299. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  82300. */
  82301. maxAngularSpeed: number;
  82302. /**
  82303. * Gets or sets the minimal initial rotation in radians.
  82304. */
  82305. minInitialRotation: number;
  82306. /**
  82307. * Gets or sets the maximal initial rotation in radians.
  82308. */
  82309. maxInitialRotation: number;
  82310. /**
  82311. * The particle emitter type defines the emitter used by the particle system.
  82312. * It can be for example box, sphere, or cone...
  82313. */
  82314. particleEmitterType: Nullable<IParticleEmitterType>;
  82315. /**
  82316. * Defines the delay in milliseconds before starting the system (0 by default)
  82317. */
  82318. startDelay: number;
  82319. /**
  82320. * 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
  82321. */
  82322. preWarmCycles: number;
  82323. /**
  82324. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  82325. */
  82326. preWarmStepOffset: number;
  82327. /**
  82328. * 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)
  82329. */
  82330. spriteCellChangeSpeed: number;
  82331. /**
  82332. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  82333. */
  82334. startSpriteCellID: number;
  82335. /**
  82336. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  82337. */
  82338. endSpriteCellID: number;
  82339. /**
  82340. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  82341. */
  82342. spriteCellWidth: number;
  82343. /**
  82344. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  82345. */
  82346. spriteCellHeight: number;
  82347. /**
  82348. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  82349. */
  82350. spriteRandomStartCell: boolean;
  82351. /**
  82352. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  82353. */
  82354. isAnimationSheetEnabled: boolean;
  82355. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  82356. translationPivot: Vector2;
  82357. /**
  82358. * Gets or sets a texture used to add random noise to particle positions
  82359. */
  82360. noiseTexture: Nullable<BaseTexture>;
  82361. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  82362. noiseStrength: Vector3;
  82363. /**
  82364. * Gets or sets the billboard mode to use when isBillboardBased = true.
  82365. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  82366. */
  82367. billboardMode: number;
  82368. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  82369. limitVelocityDamping: number;
  82370. /**
  82371. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  82372. */
  82373. beginAnimationOnStart: boolean;
  82374. /**
  82375. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  82376. */
  82377. beginAnimationFrom: number;
  82378. /**
  82379. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  82380. */
  82381. beginAnimationTo: number;
  82382. /**
  82383. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  82384. */
  82385. beginAnimationLoop: boolean;
  82386. /**
  82387. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  82388. */
  82389. disposeOnStop: boolean;
  82390. /**
  82391. * Gets the maximum number of particles active at the same time.
  82392. * @returns The max number of active particles.
  82393. */
  82394. getCapacity(): number;
  82395. /**
  82396. * Gets if the system has been started. (Note: this will still be true after stop is called)
  82397. * @returns True if it has been started, otherwise false.
  82398. */
  82399. isStarted(): boolean;
  82400. /**
  82401. * Animates the particle system for this frame.
  82402. */
  82403. animate(): void;
  82404. /**
  82405. * Renders the particle system in its current state.
  82406. * @returns the current number of particles
  82407. */
  82408. render(): number;
  82409. /**
  82410. * Dispose the particle system and frees its associated resources.
  82411. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  82412. */
  82413. dispose(disposeTexture?: boolean): void;
  82414. /**
  82415. * Clones the particle system.
  82416. * @param name The name of the cloned object
  82417. * @param newEmitter The new emitter to use
  82418. * @returns the cloned particle system
  82419. */
  82420. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  82421. /**
  82422. * Serializes the particle system to a JSON object.
  82423. * @returns the JSON object
  82424. */
  82425. serialize(): any;
  82426. /**
  82427. * Rebuild the particle system
  82428. */
  82429. rebuild(): void;
  82430. /**
  82431. * Starts the particle system and begins to emit
  82432. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  82433. */
  82434. start(delay?: number): void;
  82435. /**
  82436. * Stops the particle system.
  82437. */
  82438. stop(): void;
  82439. /**
  82440. * Remove all active particles
  82441. */
  82442. reset(): void;
  82443. /**
  82444. * Is this system ready to be used/rendered
  82445. * @return true if the system is ready
  82446. */
  82447. isReady(): boolean;
  82448. /**
  82449. * Adds a new color gradient
  82450. * @param gradient defines the gradient to use (between 0 and 1)
  82451. * @param color1 defines the color to affect to the specified gradient
  82452. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  82453. * @returns the current particle system
  82454. */
  82455. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  82456. /**
  82457. * Remove a specific color gradient
  82458. * @param gradient defines the gradient to remove
  82459. * @returns the current particle system
  82460. */
  82461. removeColorGradient(gradient: number): IParticleSystem;
  82462. /**
  82463. * Adds a new size gradient
  82464. * @param gradient defines the gradient to use (between 0 and 1)
  82465. * @param factor defines the size factor to affect to the specified gradient
  82466. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82467. * @returns the current particle system
  82468. */
  82469. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82470. /**
  82471. * Remove a specific size gradient
  82472. * @param gradient defines the gradient to remove
  82473. * @returns the current particle system
  82474. */
  82475. removeSizeGradient(gradient: number): IParticleSystem;
  82476. /**
  82477. * Gets the current list of color gradients.
  82478. * You must use addColorGradient and removeColorGradient to udpate this list
  82479. * @returns the list of color gradients
  82480. */
  82481. getColorGradients(): Nullable<Array<ColorGradient>>;
  82482. /**
  82483. * Gets the current list of size gradients.
  82484. * You must use addSizeGradient and removeSizeGradient to udpate this list
  82485. * @returns the list of size gradients
  82486. */
  82487. getSizeGradients(): Nullable<Array<FactorGradient>>;
  82488. /**
  82489. * Gets the current list of angular speed gradients.
  82490. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  82491. * @returns the list of angular speed gradients
  82492. */
  82493. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  82494. /**
  82495. * Adds a new angular speed gradient
  82496. * @param gradient defines the gradient to use (between 0 and 1)
  82497. * @param factor defines the angular speed to affect to the specified gradient
  82498. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82499. * @returns the current particle system
  82500. */
  82501. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82502. /**
  82503. * Remove a specific angular speed gradient
  82504. * @param gradient defines the gradient to remove
  82505. * @returns the current particle system
  82506. */
  82507. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  82508. /**
  82509. * Gets the current list of velocity gradients.
  82510. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  82511. * @returns the list of velocity gradients
  82512. */
  82513. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  82514. /**
  82515. * Adds a new velocity gradient
  82516. * @param gradient defines the gradient to use (between 0 and 1)
  82517. * @param factor defines the velocity to affect to the specified gradient
  82518. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82519. * @returns the current particle system
  82520. */
  82521. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82522. /**
  82523. * Remove a specific velocity gradient
  82524. * @param gradient defines the gradient to remove
  82525. * @returns the current particle system
  82526. */
  82527. removeVelocityGradient(gradient: number): IParticleSystem;
  82528. /**
  82529. * Gets the current list of limit velocity gradients.
  82530. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  82531. * @returns the list of limit velocity gradients
  82532. */
  82533. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  82534. /**
  82535. * Adds a new limit velocity gradient
  82536. * @param gradient defines the gradient to use (between 0 and 1)
  82537. * @param factor defines the limit velocity to affect to the specified gradient
  82538. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82539. * @returns the current particle system
  82540. */
  82541. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82542. /**
  82543. * Remove a specific limit velocity gradient
  82544. * @param gradient defines the gradient to remove
  82545. * @returns the current particle system
  82546. */
  82547. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  82548. /**
  82549. * Adds a new drag gradient
  82550. * @param gradient defines the gradient to use (between 0 and 1)
  82551. * @param factor defines the drag to affect to the specified gradient
  82552. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82553. * @returns the current particle system
  82554. */
  82555. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82556. /**
  82557. * Remove a specific drag gradient
  82558. * @param gradient defines the gradient to remove
  82559. * @returns the current particle system
  82560. */
  82561. removeDragGradient(gradient: number): IParticleSystem;
  82562. /**
  82563. * Gets the current list of drag gradients.
  82564. * You must use addDragGradient and removeDragGradient to udpate this list
  82565. * @returns the list of drag gradients
  82566. */
  82567. getDragGradients(): Nullable<Array<FactorGradient>>;
  82568. /**
  82569. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  82570. * @param gradient defines the gradient to use (between 0 and 1)
  82571. * @param factor defines the emit rate to affect to the specified gradient
  82572. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82573. * @returns the current particle system
  82574. */
  82575. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82576. /**
  82577. * Remove a specific emit rate gradient
  82578. * @param gradient defines the gradient to remove
  82579. * @returns the current particle system
  82580. */
  82581. removeEmitRateGradient(gradient: number): IParticleSystem;
  82582. /**
  82583. * Gets the current list of emit rate gradients.
  82584. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  82585. * @returns the list of emit rate gradients
  82586. */
  82587. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  82588. /**
  82589. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  82590. * @param gradient defines the gradient to use (between 0 and 1)
  82591. * @param factor defines the start size to affect to the specified gradient
  82592. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82593. * @returns the current particle system
  82594. */
  82595. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82596. /**
  82597. * Remove a specific start size gradient
  82598. * @param gradient defines the gradient to remove
  82599. * @returns the current particle system
  82600. */
  82601. removeStartSizeGradient(gradient: number): IParticleSystem;
  82602. /**
  82603. * Gets the current list of start size gradients.
  82604. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  82605. * @returns the list of start size gradients
  82606. */
  82607. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  82608. /**
  82609. * Adds a new life time gradient
  82610. * @param gradient defines the gradient to use (between 0 and 1)
  82611. * @param factor defines the life time factor to affect to the specified gradient
  82612. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  82613. * @returns the current particle system
  82614. */
  82615. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  82616. /**
  82617. * Remove a specific life time gradient
  82618. * @param gradient defines the gradient to remove
  82619. * @returns the current particle system
  82620. */
  82621. removeLifeTimeGradient(gradient: number): IParticleSystem;
  82622. /**
  82623. * Gets the current list of life time gradients.
  82624. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  82625. * @returns the list of life time gradients
  82626. */
  82627. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  82628. /**
  82629. * Gets the current list of color gradients.
  82630. * You must use addColorGradient and removeColorGradient to udpate this list
  82631. * @returns the list of color gradients
  82632. */
  82633. getColorGradients(): Nullable<Array<ColorGradient>>;
  82634. /**
  82635. * Adds a new ramp gradient used to remap particle colors
  82636. * @param gradient defines the gradient to use (between 0 and 1)
  82637. * @param color defines the color to affect to the specified gradient
  82638. * @returns the current particle system
  82639. */
  82640. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  82641. /**
  82642. * Gets the current list of ramp gradients.
  82643. * You must use addRampGradient and removeRampGradient to udpate this list
  82644. * @returns the list of ramp gradients
  82645. */
  82646. getRampGradients(): Nullable<Array<Color3Gradient>>;
  82647. /** Gets or sets a boolean indicating that ramp gradients must be used
  82648. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  82649. */
  82650. useRampGradients: boolean;
  82651. /**
  82652. * Adds a new color remap gradient
  82653. * @param gradient defines the gradient to use (between 0 and 1)
  82654. * @param min defines the color remap minimal range
  82655. * @param max defines the color remap maximal range
  82656. * @returns the current particle system
  82657. */
  82658. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  82659. /**
  82660. * Gets the current list of color remap gradients.
  82661. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  82662. * @returns the list of color remap gradients
  82663. */
  82664. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  82665. /**
  82666. * Adds a new alpha remap gradient
  82667. * @param gradient defines the gradient to use (between 0 and 1)
  82668. * @param min defines the alpha remap minimal range
  82669. * @param max defines the alpha remap maximal range
  82670. * @returns the current particle system
  82671. */
  82672. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  82673. /**
  82674. * Gets the current list of alpha remap gradients.
  82675. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  82676. * @returns the list of alpha remap gradients
  82677. */
  82678. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  82679. /**
  82680. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  82681. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  82682. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  82683. * @returns the emitter
  82684. */
  82685. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  82686. /**
  82687. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  82688. * @param radius The radius of the hemisphere to emit from
  82689. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  82690. * @returns the emitter
  82691. */
  82692. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  82693. /**
  82694. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  82695. * @param radius The radius of the sphere to emit from
  82696. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  82697. * @returns the emitter
  82698. */
  82699. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  82700. /**
  82701. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  82702. * @param radius The radius of the sphere to emit from
  82703. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  82704. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  82705. * @returns the emitter
  82706. */
  82707. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  82708. /**
  82709. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  82710. * @param radius The radius of the emission cylinder
  82711. * @param height The height of the emission cylinder
  82712. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  82713. * @param directionRandomizer How much to randomize the particle direction [0-1]
  82714. * @returns the emitter
  82715. */
  82716. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  82717. /**
  82718. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  82719. * @param radius The radius of the cylinder to emit from
  82720. * @param height The height of the emission cylinder
  82721. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  82722. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  82723. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  82724. * @returns the emitter
  82725. */
  82726. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  82727. /**
  82728. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  82729. * @param radius The radius of the cone to emit from
  82730. * @param angle The base angle of the cone
  82731. * @returns the emitter
  82732. */
  82733. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  82734. /**
  82735. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  82736. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  82737. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  82738. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  82739. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  82740. * @returns the emitter
  82741. */
  82742. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  82743. /**
  82744. * Get hosting scene
  82745. * @returns the scene
  82746. */
  82747. getScene(): Scene;
  82748. }
  82749. }
  82750. declare module BABYLON {
  82751. /**
  82752. * Creates an instance based on a source mesh.
  82753. */
  82754. export class InstancedMesh extends AbstractMesh {
  82755. private _sourceMesh;
  82756. private _currentLOD;
  82757. /** @hidden */
  82758. _indexInSourceMeshInstanceArray: number;
  82759. constructor(name: string, source: Mesh);
  82760. /**
  82761. * Returns the string "InstancedMesh".
  82762. */
  82763. getClassName(): string;
  82764. /** Gets the list of lights affecting that mesh */
  82765. readonly lightSources: Light[];
  82766. _resyncLightSources(): void;
  82767. _resyncLighSource(light: Light): void;
  82768. _removeLightSource(light: Light): void;
  82769. /**
  82770. * If the source mesh receives shadows
  82771. */
  82772. readonly receiveShadows: boolean;
  82773. /**
  82774. * The material of the source mesh
  82775. */
  82776. readonly material: Nullable<Material>;
  82777. /**
  82778. * Visibility of the source mesh
  82779. */
  82780. readonly visibility: number;
  82781. /**
  82782. * Skeleton of the source mesh
  82783. */
  82784. readonly skeleton: Nullable<Skeleton>;
  82785. /**
  82786. * Rendering ground id of the source mesh
  82787. */
  82788. renderingGroupId: number;
  82789. /**
  82790. * Returns the total number of vertices (integer).
  82791. */
  82792. getTotalVertices(): number;
  82793. /**
  82794. * Returns a positive integer : the total number of indices in this mesh geometry.
  82795. * @returns the numner of indices or zero if the mesh has no geometry.
  82796. */
  82797. getTotalIndices(): number;
  82798. /**
  82799. * The source mesh of the instance
  82800. */
  82801. readonly sourceMesh: Mesh;
  82802. /**
  82803. * Is this node ready to be used/rendered
  82804. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  82805. * @return {boolean} is it ready
  82806. */
  82807. isReady(completeCheck?: boolean): boolean;
  82808. /**
  82809. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  82810. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  82811. * @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.
  82812. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  82813. */
  82814. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  82815. /**
  82816. * Sets the vertex data of the mesh geometry for the requested `kind`.
  82817. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  82818. * The `data` are either a numeric array either a Float32Array.
  82819. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  82820. * 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).
  82821. * Note that a new underlying VertexBuffer object is created each call.
  82822. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  82823. *
  82824. * Possible `kind` values :
  82825. * - VertexBuffer.PositionKind
  82826. * - VertexBuffer.UVKind
  82827. * - VertexBuffer.UV2Kind
  82828. * - VertexBuffer.UV3Kind
  82829. * - VertexBuffer.UV4Kind
  82830. * - VertexBuffer.UV5Kind
  82831. * - VertexBuffer.UV6Kind
  82832. * - VertexBuffer.ColorKind
  82833. * - VertexBuffer.MatricesIndicesKind
  82834. * - VertexBuffer.MatricesIndicesExtraKind
  82835. * - VertexBuffer.MatricesWeightsKind
  82836. * - VertexBuffer.MatricesWeightsExtraKind
  82837. *
  82838. * Returns the Mesh.
  82839. */
  82840. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): Mesh;
  82841. /**
  82842. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  82843. * If the mesh has no geometry, it is simply returned as it is.
  82844. * The `data` are either a numeric array either a Float32Array.
  82845. * No new underlying VertexBuffer object is created.
  82846. * 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.
  82847. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  82848. *
  82849. * Possible `kind` values :
  82850. * - VertexBuffer.PositionKind
  82851. * - VertexBuffer.UVKind
  82852. * - VertexBuffer.UV2Kind
  82853. * - VertexBuffer.UV3Kind
  82854. * - VertexBuffer.UV4Kind
  82855. * - VertexBuffer.UV5Kind
  82856. * - VertexBuffer.UV6Kind
  82857. * - VertexBuffer.ColorKind
  82858. * - VertexBuffer.MatricesIndicesKind
  82859. * - VertexBuffer.MatricesIndicesExtraKind
  82860. * - VertexBuffer.MatricesWeightsKind
  82861. * - VertexBuffer.MatricesWeightsExtraKind
  82862. *
  82863. * Returns the Mesh.
  82864. */
  82865. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  82866. /**
  82867. * Sets the mesh indices.
  82868. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  82869. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  82870. * This method creates a new index buffer each call.
  82871. * Returns the Mesh.
  82872. */
  82873. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  82874. /**
  82875. * Boolean : True if the mesh owns the requested kind of data.
  82876. */
  82877. isVerticesDataPresent(kind: string): boolean;
  82878. /**
  82879. * Returns an array of indices (IndicesArray).
  82880. */
  82881. getIndices(): Nullable<IndicesArray>;
  82882. readonly _positions: Nullable<Vector3[]>;
  82883. /**
  82884. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  82885. * This means the mesh underlying bounding box and sphere are recomputed.
  82886. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  82887. * @returns the current mesh
  82888. */
  82889. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  82890. /** @hidden */
  82891. _preActivate(): InstancedMesh;
  82892. /** @hidden */
  82893. _activate(renderId: number, intermediateRendering: boolean): boolean;
  82894. /** @hidden */
  82895. _postActivate(): void;
  82896. getWorldMatrix(): Matrix;
  82897. readonly isAnInstance: boolean;
  82898. /**
  82899. * Returns the current associated LOD AbstractMesh.
  82900. */
  82901. getLOD(camera: Camera): AbstractMesh;
  82902. /** @hidden */
  82903. _syncSubMeshes(): InstancedMesh;
  82904. /** @hidden */
  82905. _generatePointsArray(): boolean;
  82906. /**
  82907. * Creates a new InstancedMesh from the current mesh.
  82908. * - name (string) : the cloned mesh name
  82909. * - newParent (optional Node) : the optional Node to parent the clone to.
  82910. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  82911. *
  82912. * Returns the clone.
  82913. */
  82914. clone(name: string, newParent?: Node, doNotCloneChildren?: boolean): InstancedMesh;
  82915. /**
  82916. * Disposes the InstancedMesh.
  82917. * Returns nothing.
  82918. */
  82919. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  82920. }
  82921. }
  82922. declare module BABYLON {
  82923. /**
  82924. * Defines the options associated with the creation of a shader material.
  82925. */
  82926. export interface IShaderMaterialOptions {
  82927. /**
  82928. * Does the material work in alpha blend mode
  82929. */
  82930. needAlphaBlending: boolean;
  82931. /**
  82932. * Does the material work in alpha test mode
  82933. */
  82934. needAlphaTesting: boolean;
  82935. /**
  82936. * The list of attribute names used in the shader
  82937. */
  82938. attributes: string[];
  82939. /**
  82940. * The list of unifrom names used in the shader
  82941. */
  82942. uniforms: string[];
  82943. /**
  82944. * The list of UBO names used in the shader
  82945. */
  82946. uniformBuffers: string[];
  82947. /**
  82948. * The list of sampler names used in the shader
  82949. */
  82950. samplers: string[];
  82951. /**
  82952. * The list of defines used in the shader
  82953. */
  82954. defines: string[];
  82955. }
  82956. /**
  82957. * 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.
  82958. *
  82959. * This returned material effects how the mesh will look based on the code in the shaders.
  82960. *
  82961. * @see http://doc.babylonjs.com/how_to/shader_material
  82962. */
  82963. export class ShaderMaterial extends Material {
  82964. private _shaderPath;
  82965. private _options;
  82966. private _textures;
  82967. private _textureArrays;
  82968. private _floats;
  82969. private _ints;
  82970. private _floatsArrays;
  82971. private _colors3;
  82972. private _colors3Arrays;
  82973. private _colors4;
  82974. private _colors4Arrays;
  82975. private _vectors2;
  82976. private _vectors3;
  82977. private _vectors4;
  82978. private _matrices;
  82979. private _matrices3x3;
  82980. private _matrices2x2;
  82981. private _vectors2Arrays;
  82982. private _vectors3Arrays;
  82983. private _vectors4Arrays;
  82984. private _cachedWorldViewMatrix;
  82985. private _cachedWorldViewProjectionMatrix;
  82986. private _renderId;
  82987. /**
  82988. * Instantiate a new shader material.
  82989. * 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.
  82990. * This returned material effects how the mesh will look based on the code in the shaders.
  82991. * @see http://doc.babylonjs.com/how_to/shader_material
  82992. * @param name Define the name of the material in the scene
  82993. * @param scene Define the scene the material belongs to
  82994. * @param shaderPath Defines the route to the shader code in one of three ways:
  82995. * - object - { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  82996. * - object - { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in <script> tags
  82997. * - string - "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  82998. * @param options Define the options used to create the shader
  82999. */
  83000. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  83001. /**
  83002. * Gets the options used to compile the shader.
  83003. * They can be modified to trigger a new compilation
  83004. */
  83005. readonly options: IShaderMaterialOptions;
  83006. /**
  83007. * Gets the current class name of the material e.g. "ShaderMaterial"
  83008. * Mainly use in serialization.
  83009. * @returns the class name
  83010. */
  83011. getClassName(): string;
  83012. /**
  83013. * Specifies if the material will require alpha blending
  83014. * @returns a boolean specifying if alpha blending is needed
  83015. */
  83016. needAlphaBlending(): boolean;
  83017. /**
  83018. * Specifies if this material should be rendered in alpha test mode
  83019. * @returns a boolean specifying if an alpha test is needed.
  83020. */
  83021. needAlphaTesting(): boolean;
  83022. private _checkUniform;
  83023. /**
  83024. * Set a texture in the shader.
  83025. * @param name Define the name of the uniform samplers as defined in the shader
  83026. * @param texture Define the texture to bind to this sampler
  83027. * @return the material itself allowing "fluent" like uniform updates
  83028. */
  83029. setTexture(name: string, texture: Texture): ShaderMaterial;
  83030. /**
  83031. * Set a texture array in the shader.
  83032. * @param name Define the name of the uniform sampler array as defined in the shader
  83033. * @param textures Define the list of textures to bind to this sampler
  83034. * @return the material itself allowing "fluent" like uniform updates
  83035. */
  83036. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  83037. /**
  83038. * Set a float in the shader.
  83039. * @param name Define the name of the uniform as defined in the shader
  83040. * @param value Define the value to give to the uniform
  83041. * @return the material itself allowing "fluent" like uniform updates
  83042. */
  83043. setFloat(name: string, value: number): ShaderMaterial;
  83044. /**
  83045. * Set a int in the shader.
  83046. * @param name Define the name of the uniform as defined in the shader
  83047. * @param value Define the value to give to the uniform
  83048. * @return the material itself allowing "fluent" like uniform updates
  83049. */
  83050. setInt(name: string, value: number): ShaderMaterial;
  83051. /**
  83052. * Set an array of floats in the shader.
  83053. * @param name Define the name of the uniform as defined in the shader
  83054. * @param value Define the value to give to the uniform
  83055. * @return the material itself allowing "fluent" like uniform updates
  83056. */
  83057. setFloats(name: string, value: number[]): ShaderMaterial;
  83058. /**
  83059. * Set a vec3 in the shader from a Color3.
  83060. * @param name Define the name of the uniform as defined in the shader
  83061. * @param value Define the value to give to the uniform
  83062. * @return the material itself allowing "fluent" like uniform updates
  83063. */
  83064. setColor3(name: string, value: Color3): ShaderMaterial;
  83065. /**
  83066. * Set a vec3 array in the shader from a Color3 array.
  83067. * @param name Define the name of the uniform as defined in the shader
  83068. * @param value Define the value to give to the uniform
  83069. * @return the material itself allowing "fluent" like uniform updates
  83070. */
  83071. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  83072. /**
  83073. * Set a vec4 in the shader from a Color4.
  83074. * @param name Define the name of the uniform as defined in the shader
  83075. * @param value Define the value to give to the uniform
  83076. * @return the material itself allowing "fluent" like uniform updates
  83077. */
  83078. setColor4(name: string, value: Color4): ShaderMaterial;
  83079. /**
  83080. * Set a vec4 array in the shader from a Color4 array.
  83081. * @param name Define the name of the uniform as defined in the shader
  83082. * @param value Define the value to give to the uniform
  83083. * @return the material itself allowing "fluent" like uniform updates
  83084. */
  83085. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  83086. /**
  83087. * Set a vec2 in the shader from a Vector2.
  83088. * @param name Define the name of the uniform as defined in the shader
  83089. * @param value Define the value to give to the uniform
  83090. * @return the material itself allowing "fluent" like uniform updates
  83091. */
  83092. setVector2(name: string, value: Vector2): ShaderMaterial;
  83093. /**
  83094. * Set a vec3 in the shader from a Vector3.
  83095. * @param name Define the name of the uniform as defined in the shader
  83096. * @param value Define the value to give to the uniform
  83097. * @return the material itself allowing "fluent" like uniform updates
  83098. */
  83099. setVector3(name: string, value: Vector3): ShaderMaterial;
  83100. /**
  83101. * Set a vec4 in the shader from a Vector4.
  83102. * @param name Define the name of the uniform as defined in the shader
  83103. * @param value Define the value to give to the uniform
  83104. * @return the material itself allowing "fluent" like uniform updates
  83105. */
  83106. setVector4(name: string, value: Vector4): ShaderMaterial;
  83107. /**
  83108. * Set a mat4 in the shader from a Matrix.
  83109. * @param name Define the name of the uniform as defined in the shader
  83110. * @param value Define the value to give to the uniform
  83111. * @return the material itself allowing "fluent" like uniform updates
  83112. */
  83113. setMatrix(name: string, value: Matrix): ShaderMaterial;
  83114. /**
  83115. * Set a mat3 in the shader from a Float32Array.
  83116. * @param name Define the name of the uniform as defined in the shader
  83117. * @param value Define the value to give to the uniform
  83118. * @return the material itself allowing "fluent" like uniform updates
  83119. */
  83120. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  83121. /**
  83122. * Set a mat2 in the shader from a Float32Array.
  83123. * @param name Define the name of the uniform as defined in the shader
  83124. * @param value Define the value to give to the uniform
  83125. * @return the material itself allowing "fluent" like uniform updates
  83126. */
  83127. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  83128. /**
  83129. * Set a vec2 array in the shader from a number array.
  83130. * @param name Define the name of the uniform as defined in the shader
  83131. * @param value Define the value to give to the uniform
  83132. * @return the material itself allowing "fluent" like uniform updates
  83133. */
  83134. setArray2(name: string, value: number[]): ShaderMaterial;
  83135. /**
  83136. * Set a vec3 array in the shader from a number array.
  83137. * @param name Define the name of the uniform as defined in the shader
  83138. * @param value Define the value to give to the uniform
  83139. * @return the material itself allowing "fluent" like uniform updates
  83140. */
  83141. setArray3(name: string, value: number[]): ShaderMaterial;
  83142. /**
  83143. * Set a vec4 array in the shader from a number array.
  83144. * @param name Define the name of the uniform as defined in the shader
  83145. * @param value Define the value to give to the uniform
  83146. * @return the material itself allowing "fluent" like uniform updates
  83147. */
  83148. setArray4(name: string, value: number[]): ShaderMaterial;
  83149. private _checkCache;
  83150. /**
  83151. * Specifies that the submesh is ready to be used
  83152. * @param mesh defines the mesh to check
  83153. * @param subMesh defines which submesh to check
  83154. * @param useInstances specifies that instances should be used
  83155. * @returns a boolean indicating that the submesh is ready or not
  83156. */
  83157. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  83158. /**
  83159. * Checks if the material is ready to render the requested mesh
  83160. * @param mesh Define the mesh to render
  83161. * @param useInstances Define whether or not the material is used with instances
  83162. * @returns true if ready, otherwise false
  83163. */
  83164. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  83165. /**
  83166. * Binds the world matrix to the material
  83167. * @param world defines the world transformation matrix
  83168. */
  83169. bindOnlyWorldMatrix(world: Matrix): void;
  83170. /**
  83171. * Binds the material to the mesh
  83172. * @param world defines the world transformation matrix
  83173. * @param mesh defines the mesh to bind the material to
  83174. */
  83175. bind(world: Matrix, mesh?: Mesh): void;
  83176. /**
  83177. * Gets the active textures from the material
  83178. * @returns an array of textures
  83179. */
  83180. getActiveTextures(): BaseTexture[];
  83181. /**
  83182. * Specifies if the material uses a texture
  83183. * @param texture defines the texture to check against the material
  83184. * @returns a boolean specifying if the material uses the texture
  83185. */
  83186. hasTexture(texture: BaseTexture): boolean;
  83187. /**
  83188. * Makes a duplicate of the material, and gives it a new name
  83189. * @param name defines the new name for the duplicated material
  83190. * @returns the cloned material
  83191. */
  83192. clone(name: string): ShaderMaterial;
  83193. /**
  83194. * Disposes the material
  83195. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  83196. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  83197. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  83198. */
  83199. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  83200. /**
  83201. * Serializes this material in a JSON representation
  83202. * @returns the serialized material object
  83203. */
  83204. serialize(): any;
  83205. /**
  83206. * Creates a shader material from parsed shader material data
  83207. * @param source defines the JSON represnetation of the material
  83208. * @param scene defines the hosting scene
  83209. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  83210. * @returns a new material
  83211. */
  83212. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  83213. }
  83214. }
  83215. declare module BABYLON {
  83216. /** @hidden */
  83217. export var colorPixelShader: {
  83218. name: string;
  83219. shader: string;
  83220. };
  83221. }
  83222. declare module BABYLON {
  83223. /** @hidden */
  83224. export var colorVertexShader: {
  83225. name: string;
  83226. shader: string;
  83227. };
  83228. }
  83229. declare module BABYLON {
  83230. /**
  83231. * Line mesh
  83232. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  83233. */
  83234. export class LinesMesh extends Mesh {
  83235. /**
  83236. * If vertex color should be applied to the mesh
  83237. */
  83238. readonly useVertexColor?: boolean | undefined;
  83239. /**
  83240. * If vertex alpha should be applied to the mesh
  83241. */
  83242. readonly useVertexAlpha?: boolean | undefined;
  83243. /**
  83244. * Color of the line (Default: White)
  83245. */
  83246. color: Color3;
  83247. /**
  83248. * Alpha of the line (Default: 1)
  83249. */
  83250. alpha: number;
  83251. /**
  83252. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  83253. * This margin is expressed in world space coordinates, so its value may vary.
  83254. * Default value is 0.1
  83255. */
  83256. intersectionThreshold: number;
  83257. private _colorShader;
  83258. private color4;
  83259. /**
  83260. * Creates a new LinesMesh
  83261. * @param name defines the name
  83262. * @param scene defines the hosting scene
  83263. * @param parent defines the parent mesh if any
  83264. * @param source defines the optional source LinesMesh used to clone data from
  83265. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  83266. * When false, achieved by calling a clone(), also passing False.
  83267. * This will make creation of children, recursive.
  83268. * @param useVertexColor defines if this LinesMesh supports vertex color
  83269. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  83270. */
  83271. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: LinesMesh, doNotCloneChildren?: boolean,
  83272. /**
  83273. * If vertex color should be applied to the mesh
  83274. */
  83275. useVertexColor?: boolean | undefined,
  83276. /**
  83277. * If vertex alpha should be applied to the mesh
  83278. */
  83279. useVertexAlpha?: boolean | undefined);
  83280. private _addClipPlaneDefine;
  83281. private _removeClipPlaneDefine;
  83282. isReady(): boolean;
  83283. /**
  83284. * Returns the string "LineMesh"
  83285. */
  83286. getClassName(): string;
  83287. /**
  83288. * @hidden
  83289. */
  83290. /**
  83291. * @hidden
  83292. */
  83293. material: Material;
  83294. /**
  83295. * @hidden
  83296. */
  83297. readonly checkCollisions: boolean;
  83298. /** @hidden */
  83299. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): LinesMesh;
  83300. /** @hidden */
  83301. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): LinesMesh;
  83302. /**
  83303. * Disposes of the line mesh
  83304. * @param doNotRecurse If children should be disposed
  83305. */
  83306. dispose(doNotRecurse?: boolean): void;
  83307. /**
  83308. * Returns a new LineMesh object cloned from the current one.
  83309. */
  83310. clone(name: string, newParent?: Node, doNotCloneChildren?: boolean): LinesMesh;
  83311. /**
  83312. * Creates a new InstancedLinesMesh object from the mesh model.
  83313. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  83314. * @param name defines the name of the new instance
  83315. * @returns a new InstancedLinesMesh
  83316. */
  83317. createInstance(name: string): InstancedLinesMesh;
  83318. }
  83319. /**
  83320. * Creates an instance based on a source LinesMesh
  83321. */
  83322. export class InstancedLinesMesh extends InstancedMesh {
  83323. /**
  83324. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  83325. * This margin is expressed in world space coordinates, so its value may vary.
  83326. * Initilized with the intersectionThreshold value of the source LinesMesh
  83327. */
  83328. intersectionThreshold: number;
  83329. constructor(name: string, source: LinesMesh);
  83330. /**
  83331. * Returns the string "InstancedLinesMesh".
  83332. */
  83333. getClassName(): string;
  83334. }
  83335. }
  83336. declare module BABYLON {
  83337. /** @hidden */
  83338. export var linePixelShader: {
  83339. name: string;
  83340. shader: string;
  83341. };
  83342. }
  83343. declare module BABYLON {
  83344. /** @hidden */
  83345. export var lineVertexShader: {
  83346. name: string;
  83347. shader: string;
  83348. };
  83349. }
  83350. declare module BABYLON {
  83351. interface AbstractMesh {
  83352. /**
  83353. * Gets the edgesRenderer associated with the mesh
  83354. */
  83355. edgesRenderer: Nullable<EdgesRenderer>;
  83356. }
  83357. interface LinesMesh {
  83358. /**
  83359. * Enables the edge rendering mode on the mesh.
  83360. * This mode makes the mesh edges visible
  83361. * @param epsilon defines the maximal distance between two angles to detect a face
  83362. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  83363. * @returns the currentAbstractMesh
  83364. * @see https://www.babylonjs-playground.com/#19O9TU#0
  83365. */
  83366. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  83367. }
  83368. interface InstancedLinesMesh {
  83369. /**
  83370. * Enables the edge rendering mode on the mesh.
  83371. * This mode makes the mesh edges visible
  83372. * @param epsilon defines the maximal distance between two angles to detect a face
  83373. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  83374. * @returns the current InstancedLinesMesh
  83375. * @see https://www.babylonjs-playground.com/#19O9TU#0
  83376. */
  83377. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  83378. }
  83379. /**
  83380. * Defines the minimum contract an Edges renderer should follow.
  83381. */
  83382. export interface IEdgesRenderer extends IDisposable {
  83383. /**
  83384. * Gets or sets a boolean indicating if the edgesRenderer is active
  83385. */
  83386. isEnabled: boolean;
  83387. /**
  83388. * Renders the edges of the attached mesh,
  83389. */
  83390. render(): void;
  83391. /**
  83392. * Checks wether or not the edges renderer is ready to render.
  83393. * @return true if ready, otherwise false.
  83394. */
  83395. isReady(): boolean;
  83396. }
  83397. /**
  83398. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  83399. */
  83400. export class EdgesRenderer implements IEdgesRenderer {
  83401. /**
  83402. * Define the size of the edges with an orthographic camera
  83403. */
  83404. edgesWidthScalerForOrthographic: number;
  83405. /**
  83406. * Define the size of the edges with a perspective camera
  83407. */
  83408. edgesWidthScalerForPerspective: number;
  83409. protected _source: AbstractMesh;
  83410. protected _linesPositions: number[];
  83411. protected _linesNormals: number[];
  83412. protected _linesIndices: number[];
  83413. protected _epsilon: number;
  83414. protected _indicesCount: number;
  83415. protected _lineShader: ShaderMaterial;
  83416. protected _ib: DataBuffer;
  83417. protected _buffers: {
  83418. [key: string]: Nullable<VertexBuffer>;
  83419. };
  83420. protected _checkVerticesInsteadOfIndices: boolean;
  83421. private _meshRebuildObserver;
  83422. private _meshDisposeObserver;
  83423. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  83424. isEnabled: boolean;
  83425. /**
  83426. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  83427. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  83428. * @param source Mesh used to create edges
  83429. * @param epsilon sum of angles in adjacency to check for edge
  83430. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  83431. * @param generateEdgesLines - should generate Lines or only prepare resources.
  83432. */
  83433. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  83434. protected _prepareRessources(): void;
  83435. /** @hidden */
  83436. _rebuild(): void;
  83437. /**
  83438. * Releases the required resources for the edges renderer
  83439. */
  83440. dispose(): void;
  83441. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  83442. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  83443. /**
  83444. * Checks if the pair of p0 and p1 is en edge
  83445. * @param faceIndex
  83446. * @param edge
  83447. * @param faceNormals
  83448. * @param p0
  83449. * @param p1
  83450. * @private
  83451. */
  83452. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  83453. /**
  83454. * push line into the position, normal and index buffer
  83455. * @protected
  83456. */
  83457. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  83458. /**
  83459. * Generates lines edges from adjacencjes
  83460. * @private
  83461. */
  83462. _generateEdgesLines(): void;
  83463. /**
  83464. * Checks wether or not the edges renderer is ready to render.
  83465. * @return true if ready, otherwise false.
  83466. */
  83467. isReady(): boolean;
  83468. /**
  83469. * Renders the edges of the attached mesh,
  83470. */
  83471. render(): void;
  83472. }
  83473. /**
  83474. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  83475. */
  83476. export class LineEdgesRenderer extends EdgesRenderer {
  83477. /**
  83478. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  83479. * @param source LineMesh used to generate edges
  83480. * @param epsilon not important (specified angle for edge detection)
  83481. * @param checkVerticesInsteadOfIndices not important for LineMesh
  83482. */
  83483. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  83484. /**
  83485. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  83486. */
  83487. _generateEdgesLines(): void;
  83488. }
  83489. }
  83490. declare module BABYLON {
  83491. /**
  83492. * This represents the object necessary to create a rendering group.
  83493. * This is exclusively used and created by the rendering manager.
  83494. * To modify the behavior, you use the available helpers in your scene or meshes.
  83495. * @hidden
  83496. */
  83497. export class RenderingGroup {
  83498. index: number;
  83499. private static _zeroVector;
  83500. private _scene;
  83501. private _opaqueSubMeshes;
  83502. private _transparentSubMeshes;
  83503. private _alphaTestSubMeshes;
  83504. private _depthOnlySubMeshes;
  83505. private _particleSystems;
  83506. private _spriteManagers;
  83507. private _opaqueSortCompareFn;
  83508. private _alphaTestSortCompareFn;
  83509. private _transparentSortCompareFn;
  83510. private _renderOpaque;
  83511. private _renderAlphaTest;
  83512. private _renderTransparent;
  83513. /** @hidden */
  83514. _edgesRenderers: SmartArray<IEdgesRenderer>;
  83515. onBeforeTransparentRendering: () => void;
  83516. /**
  83517. * Set the opaque sort comparison function.
  83518. * If null the sub meshes will be render in the order they were created
  83519. */
  83520. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  83521. /**
  83522. * Set the alpha test sort comparison function.
  83523. * If null the sub meshes will be render in the order they were created
  83524. */
  83525. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  83526. /**
  83527. * Set the transparent sort comparison function.
  83528. * If null the sub meshes will be render in the order they were created
  83529. */
  83530. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  83531. /**
  83532. * Creates a new rendering group.
  83533. * @param index The rendering group index
  83534. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  83535. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  83536. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  83537. */
  83538. 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>);
  83539. /**
  83540. * Render all the sub meshes contained in the group.
  83541. * @param customRenderFunction Used to override the default render behaviour of the group.
  83542. * @returns true if rendered some submeshes.
  83543. */
  83544. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  83545. /**
  83546. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  83547. * @param subMeshes The submeshes to render
  83548. */
  83549. private renderOpaqueSorted;
  83550. /**
  83551. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  83552. * @param subMeshes The submeshes to render
  83553. */
  83554. private renderAlphaTestSorted;
  83555. /**
  83556. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  83557. * @param subMeshes The submeshes to render
  83558. */
  83559. private renderTransparentSorted;
  83560. /**
  83561. * Renders the submeshes in a specified order.
  83562. * @param subMeshes The submeshes to sort before render
  83563. * @param sortCompareFn The comparison function use to sort
  83564. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  83565. * @param transparent Specifies to activate blending if true
  83566. */
  83567. private static renderSorted;
  83568. /**
  83569. * Renders the submeshes in the order they were dispatched (no sort applied).
  83570. * @param subMeshes The submeshes to render
  83571. */
  83572. private static renderUnsorted;
  83573. /**
  83574. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  83575. * are rendered back to front if in the same alpha index.
  83576. *
  83577. * @param a The first submesh
  83578. * @param b The second submesh
  83579. * @returns The result of the comparison
  83580. */
  83581. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  83582. /**
  83583. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  83584. * are rendered back to front.
  83585. *
  83586. * @param a The first submesh
  83587. * @param b The second submesh
  83588. * @returns The result of the comparison
  83589. */
  83590. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  83591. /**
  83592. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  83593. * are rendered front to back (prevent overdraw).
  83594. *
  83595. * @param a The first submesh
  83596. * @param b The second submesh
  83597. * @returns The result of the comparison
  83598. */
  83599. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  83600. /**
  83601. * Resets the different lists of submeshes to prepare a new frame.
  83602. */
  83603. prepare(): void;
  83604. dispose(): void;
  83605. /**
  83606. * Inserts the submesh in its correct queue depending on its material.
  83607. * @param subMesh The submesh to dispatch
  83608. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  83609. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  83610. */
  83611. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  83612. dispatchSprites(spriteManager: ISpriteManager): void;
  83613. dispatchParticles(particleSystem: IParticleSystem): void;
  83614. private _renderParticles;
  83615. private _renderSprites;
  83616. }
  83617. }
  83618. declare module BABYLON {
  83619. /**
  83620. * Interface describing the different options available in the rendering manager
  83621. * regarding Auto Clear between groups.
  83622. */
  83623. export interface IRenderingManagerAutoClearSetup {
  83624. /**
  83625. * Defines whether or not autoclear is enable.
  83626. */
  83627. autoClear: boolean;
  83628. /**
  83629. * Defines whether or not to autoclear the depth buffer.
  83630. */
  83631. depth: boolean;
  83632. /**
  83633. * Defines whether or not to autoclear the stencil buffer.
  83634. */
  83635. stencil: boolean;
  83636. }
  83637. /**
  83638. * This class is used by the onRenderingGroupObservable
  83639. */
  83640. export class RenderingGroupInfo {
  83641. /**
  83642. * The Scene that being rendered
  83643. */
  83644. scene: Scene;
  83645. /**
  83646. * The camera currently used for the rendering pass
  83647. */
  83648. camera: Nullable<Camera>;
  83649. /**
  83650. * The ID of the renderingGroup being processed
  83651. */
  83652. renderingGroupId: number;
  83653. }
  83654. /**
  83655. * This is the manager responsible of all the rendering for meshes sprites and particles.
  83656. * It is enable to manage the different groups as well as the different necessary sort functions.
  83657. * This should not be used directly aside of the few static configurations
  83658. */
  83659. export class RenderingManager {
  83660. /**
  83661. * The max id used for rendering groups (not included)
  83662. */
  83663. static MAX_RENDERINGGROUPS: number;
  83664. /**
  83665. * The min id used for rendering groups (included)
  83666. */
  83667. static MIN_RENDERINGGROUPS: number;
  83668. /**
  83669. * Used to globally prevent autoclearing scenes.
  83670. */
  83671. static AUTOCLEAR: boolean;
  83672. /**
  83673. * @hidden
  83674. */
  83675. _useSceneAutoClearSetup: boolean;
  83676. private _scene;
  83677. private _renderingGroups;
  83678. private _depthStencilBufferAlreadyCleaned;
  83679. private _autoClearDepthStencil;
  83680. private _customOpaqueSortCompareFn;
  83681. private _customAlphaTestSortCompareFn;
  83682. private _customTransparentSortCompareFn;
  83683. private _renderingGroupInfo;
  83684. /**
  83685. * Instantiates a new rendering group for a particular scene
  83686. * @param scene Defines the scene the groups belongs to
  83687. */
  83688. constructor(scene: Scene);
  83689. private _clearDepthStencilBuffer;
  83690. /**
  83691. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  83692. * @hidden
  83693. */
  83694. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  83695. /**
  83696. * Resets the different information of the group to prepare a new frame
  83697. * @hidden
  83698. */
  83699. reset(): void;
  83700. /**
  83701. * Dispose and release the group and its associated resources.
  83702. * @hidden
  83703. */
  83704. dispose(): void;
  83705. /**
  83706. * Clear the info related to rendering groups preventing retention points during dispose.
  83707. */
  83708. freeRenderingGroups(): void;
  83709. private _prepareRenderingGroup;
  83710. /**
  83711. * Add a sprite manager to the rendering manager in order to render it this frame.
  83712. * @param spriteManager Define the sprite manager to render
  83713. */
  83714. dispatchSprites(spriteManager: ISpriteManager): void;
  83715. /**
  83716. * Add a particle system to the rendering manager in order to render it this frame.
  83717. * @param particleSystem Define the particle system to render
  83718. */
  83719. dispatchParticles(particleSystem: IParticleSystem): void;
  83720. /**
  83721. * Add a submesh to the manager in order to render it this frame
  83722. * @param subMesh The submesh to dispatch
  83723. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  83724. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  83725. */
  83726. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  83727. /**
  83728. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  83729. * This allowed control for front to back rendering or reversly depending of the special needs.
  83730. *
  83731. * @param renderingGroupId The rendering group id corresponding to its index
  83732. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  83733. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  83734. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  83735. */
  83736. 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;
  83737. /**
  83738. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  83739. *
  83740. * @param renderingGroupId The rendering group id corresponding to its index
  83741. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  83742. * @param depth Automatically clears depth between groups if true and autoClear is true.
  83743. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  83744. */
  83745. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  83746. /**
  83747. * Gets the current auto clear configuration for one rendering group of the rendering
  83748. * manager.
  83749. * @param index the rendering group index to get the information for
  83750. * @returns The auto clear setup for the requested rendering group
  83751. */
  83752. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  83753. }
  83754. }
  83755. declare module BABYLON {
  83756. /**
  83757. * This Helps creating a texture that will be created from a camera in your scene.
  83758. * It is basically a dynamic texture that could be used to create special effects for instance.
  83759. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  83760. */
  83761. export class RenderTargetTexture extends Texture {
  83762. isCube: boolean;
  83763. /**
  83764. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  83765. */
  83766. static readonly REFRESHRATE_RENDER_ONCE: number;
  83767. /**
  83768. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  83769. */
  83770. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  83771. /**
  83772. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  83773. * the central point of your effect and can save a lot of performances.
  83774. */
  83775. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  83776. /**
  83777. * Use this predicate to dynamically define the list of mesh you want to render.
  83778. * If set, the renderList property will be overwritten.
  83779. */
  83780. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  83781. private _renderList;
  83782. /**
  83783. * Use this list to define the list of mesh you want to render.
  83784. */
  83785. renderList: Nullable<Array<AbstractMesh>>;
  83786. private _hookArray;
  83787. /**
  83788. * Define if particles should be rendered in your texture.
  83789. */
  83790. renderParticles: boolean;
  83791. /**
  83792. * Define if sprites should be rendered in your texture.
  83793. */
  83794. renderSprites: boolean;
  83795. /**
  83796. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  83797. */
  83798. coordinatesMode: number;
  83799. /**
  83800. * Define the camera used to render the texture.
  83801. */
  83802. activeCamera: Nullable<Camera>;
  83803. /**
  83804. * Override the render function of the texture with your own one.
  83805. */
  83806. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  83807. /**
  83808. * Define if camera post processes should be use while rendering the texture.
  83809. */
  83810. useCameraPostProcesses: boolean;
  83811. /**
  83812. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  83813. */
  83814. ignoreCameraViewport: boolean;
  83815. private _postProcessManager;
  83816. private _postProcesses;
  83817. private _resizeObserver;
  83818. /**
  83819. * An event triggered when the texture is unbind.
  83820. */
  83821. onBeforeBindObservable: Observable<RenderTargetTexture>;
  83822. /**
  83823. * An event triggered when the texture is unbind.
  83824. */
  83825. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  83826. private _onAfterUnbindObserver;
  83827. /**
  83828. * Set a after unbind callback in the texture.
  83829. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  83830. */
  83831. onAfterUnbind: () => void;
  83832. /**
  83833. * An event triggered before rendering the texture
  83834. */
  83835. onBeforeRenderObservable: Observable<number>;
  83836. private _onBeforeRenderObserver;
  83837. /**
  83838. * Set a before render callback in the texture.
  83839. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  83840. */
  83841. onBeforeRender: (faceIndex: number) => void;
  83842. /**
  83843. * An event triggered after rendering the texture
  83844. */
  83845. onAfterRenderObservable: Observable<number>;
  83846. private _onAfterRenderObserver;
  83847. /**
  83848. * Set a after render callback in the texture.
  83849. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  83850. */
  83851. onAfterRender: (faceIndex: number) => void;
  83852. /**
  83853. * An event triggered after the texture clear
  83854. */
  83855. onClearObservable: Observable<Engine>;
  83856. private _onClearObserver;
  83857. /**
  83858. * Set a clear callback in the texture.
  83859. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  83860. */
  83861. onClear: (Engine: Engine) => void;
  83862. /**
  83863. * An event triggered when the texture is resized.
  83864. */
  83865. onResizeObservable: Observable<RenderTargetTexture>;
  83866. /**
  83867. * Define the clear color of the Render Target if it should be different from the scene.
  83868. */
  83869. clearColor: Color4;
  83870. protected _size: number | {
  83871. width: number;
  83872. height: number;
  83873. };
  83874. protected _initialSizeParameter: number | {
  83875. width: number;
  83876. height: number;
  83877. } | {
  83878. ratio: number;
  83879. };
  83880. protected _sizeRatio: Nullable<number>;
  83881. /** @hidden */
  83882. _generateMipMaps: boolean;
  83883. protected _renderingManager: RenderingManager;
  83884. /** @hidden */
  83885. _waitingRenderList: string[];
  83886. protected _doNotChangeAspectRatio: boolean;
  83887. protected _currentRefreshId: number;
  83888. protected _refreshRate: number;
  83889. protected _textureMatrix: Matrix;
  83890. protected _samples: number;
  83891. protected _renderTargetOptions: RenderTargetCreationOptions;
  83892. /**
  83893. * Gets render target creation options that were used.
  83894. */
  83895. readonly renderTargetOptions: RenderTargetCreationOptions;
  83896. protected _engine: Engine;
  83897. protected _onRatioRescale(): void;
  83898. /**
  83899. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  83900. * It must define where the camera used to render the texture is set
  83901. */
  83902. boundingBoxPosition: Vector3;
  83903. private _boundingBoxSize;
  83904. /**
  83905. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  83906. * When defined, the cubemap will switch to local mode
  83907. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  83908. * @example https://www.babylonjs-playground.com/#RNASML
  83909. */
  83910. boundingBoxSize: Vector3;
  83911. /**
  83912. * In case the RTT has been created with a depth texture, get the associated
  83913. * depth texture.
  83914. * Otherwise, return null.
  83915. */
  83916. depthStencilTexture: Nullable<InternalTexture>;
  83917. /**
  83918. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  83919. * or used a shadow, depth texture...
  83920. * @param name The friendly name of the texture
  83921. * @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)
  83922. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  83923. * @param generateMipMaps True if mip maps need to be generated after render.
  83924. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  83925. * @param type The type of the buffer in the RTT (int, half float, float...)
  83926. * @param isCube True if a cube texture needs to be created
  83927. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  83928. * @param generateDepthBuffer True to generate a depth buffer
  83929. * @param generateStencilBuffer True to generate a stencil buffer
  83930. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  83931. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  83932. * @param delayAllocation if the texture allocation should be delayed (default: false)
  83933. */
  83934. constructor(name: string, size: number | {
  83935. width: number;
  83936. height: number;
  83937. } | {
  83938. ratio: number;
  83939. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  83940. /**
  83941. * Creates a depth stencil texture.
  83942. * This is only available in WebGL 2 or with the depth texture extension available.
  83943. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  83944. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  83945. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  83946. */
  83947. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  83948. private _processSizeParameter;
  83949. /**
  83950. * Define the number of samples to use in case of MSAA.
  83951. * It defaults to one meaning no MSAA has been enabled.
  83952. */
  83953. samples: number;
  83954. /**
  83955. * Resets the refresh counter of the texture and start bak from scratch.
  83956. * Could be useful to regenerate the texture if it is setup to render only once.
  83957. */
  83958. resetRefreshCounter(): void;
  83959. /**
  83960. * Define the refresh rate of the texture or the rendering frequency.
  83961. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  83962. */
  83963. refreshRate: number;
  83964. /**
  83965. * Adds a post process to the render target rendering passes.
  83966. * @param postProcess define the post process to add
  83967. */
  83968. addPostProcess(postProcess: PostProcess): void;
  83969. /**
  83970. * Clear all the post processes attached to the render target
  83971. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  83972. */
  83973. clearPostProcesses(dispose?: boolean): void;
  83974. /**
  83975. * Remove one of the post process from the list of attached post processes to the texture
  83976. * @param postProcess define the post process to remove from the list
  83977. */
  83978. removePostProcess(postProcess: PostProcess): void;
  83979. /** @hidden */
  83980. _shouldRender(): boolean;
  83981. /**
  83982. * Gets the actual render size of the texture.
  83983. * @returns the width of the render size
  83984. */
  83985. getRenderSize(): number;
  83986. /**
  83987. * Gets the actual render width of the texture.
  83988. * @returns the width of the render size
  83989. */
  83990. getRenderWidth(): number;
  83991. /**
  83992. * Gets the actual render height of the texture.
  83993. * @returns the height of the render size
  83994. */
  83995. getRenderHeight(): number;
  83996. /**
  83997. * Get if the texture can be rescaled or not.
  83998. */
  83999. readonly canRescale: boolean;
  84000. /**
  84001. * Resize the texture using a ratio.
  84002. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  84003. */
  84004. scale(ratio: number): void;
  84005. /**
  84006. * Get the texture reflection matrix used to rotate/transform the reflection.
  84007. * @returns the reflection matrix
  84008. */
  84009. getReflectionTextureMatrix(): Matrix;
  84010. /**
  84011. * Resize the texture to a new desired size.
  84012. * Be carrefull as it will recreate all the data in the new texture.
  84013. * @param size Define the new size. It can be:
  84014. * - a number for squared texture,
  84015. * - an object containing { width: number, height: number }
  84016. * - or an object containing a ratio { ratio: number }
  84017. */
  84018. resize(size: number | {
  84019. width: number;
  84020. height: number;
  84021. } | {
  84022. ratio: number;
  84023. }): void;
  84024. /**
  84025. * Renders all the objects from the render list into the texture.
  84026. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  84027. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  84028. */
  84029. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  84030. private _bestReflectionRenderTargetDimension;
  84031. /**
  84032. * @hidden
  84033. * @param faceIndex face index to bind to if this is a cubetexture
  84034. */
  84035. _bindFrameBuffer(faceIndex?: number): void;
  84036. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  84037. private renderToTarget;
  84038. /**
  84039. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  84040. * This allowed control for front to back rendering or reversly depending of the special needs.
  84041. *
  84042. * @param renderingGroupId The rendering group id corresponding to its index
  84043. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  84044. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  84045. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  84046. */
  84047. 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;
  84048. /**
  84049. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  84050. *
  84051. * @param renderingGroupId The rendering group id corresponding to its index
  84052. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  84053. */
  84054. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  84055. /**
  84056. * Clones the texture.
  84057. * @returns the cloned texture
  84058. */
  84059. clone(): RenderTargetTexture;
  84060. /**
  84061. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  84062. * @returns The JSON representation of the texture
  84063. */
  84064. serialize(): any;
  84065. /**
  84066. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  84067. */
  84068. disposeFramebufferObjects(): void;
  84069. /**
  84070. * Dispose the texture and release its associated resources.
  84071. */
  84072. dispose(): void;
  84073. /** @hidden */
  84074. _rebuild(): void;
  84075. /**
  84076. * Clear the info related to rendering groups preventing retention point in material dispose.
  84077. */
  84078. freeRenderingGroups(): void;
  84079. /**
  84080. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  84081. * @returns the view count
  84082. */
  84083. getViewCount(): number;
  84084. }
  84085. }
  84086. declare module BABYLON {
  84087. /**
  84088. * Base class for the main features of a material in Babylon.js
  84089. */
  84090. export class Material implements IAnimatable {
  84091. /**
  84092. * Returns the triangle fill mode
  84093. */
  84094. static readonly TriangleFillMode: number;
  84095. /**
  84096. * Returns the wireframe mode
  84097. */
  84098. static readonly WireFrameFillMode: number;
  84099. /**
  84100. * Returns the point fill mode
  84101. */
  84102. static readonly PointFillMode: number;
  84103. /**
  84104. * Returns the point list draw mode
  84105. */
  84106. static readonly PointListDrawMode: number;
  84107. /**
  84108. * Returns the line list draw mode
  84109. */
  84110. static readonly LineListDrawMode: number;
  84111. /**
  84112. * Returns the line loop draw mode
  84113. */
  84114. static readonly LineLoopDrawMode: number;
  84115. /**
  84116. * Returns the line strip draw mode
  84117. */
  84118. static readonly LineStripDrawMode: number;
  84119. /**
  84120. * Returns the triangle strip draw mode
  84121. */
  84122. static readonly TriangleStripDrawMode: number;
  84123. /**
  84124. * Returns the triangle fan draw mode
  84125. */
  84126. static readonly TriangleFanDrawMode: number;
  84127. /**
  84128. * Stores the clock-wise side orientation
  84129. */
  84130. static readonly ClockWiseSideOrientation: number;
  84131. /**
  84132. * Stores the counter clock-wise side orientation
  84133. */
  84134. static readonly CounterClockWiseSideOrientation: number;
  84135. /**
  84136. * The dirty texture flag value
  84137. */
  84138. static readonly TextureDirtyFlag: number;
  84139. /**
  84140. * The dirty light flag value
  84141. */
  84142. static readonly LightDirtyFlag: number;
  84143. /**
  84144. * The dirty fresnel flag value
  84145. */
  84146. static readonly FresnelDirtyFlag: number;
  84147. /**
  84148. * The dirty attribute flag value
  84149. */
  84150. static readonly AttributesDirtyFlag: number;
  84151. /**
  84152. * The dirty misc flag value
  84153. */
  84154. static readonly MiscDirtyFlag: number;
  84155. /**
  84156. * The all dirty flag value
  84157. */
  84158. static readonly AllDirtyFlag: number;
  84159. /**
  84160. * The ID of the material
  84161. */
  84162. id: string;
  84163. /**
  84164. * Gets or sets the unique id of the material
  84165. */
  84166. uniqueId: number;
  84167. /**
  84168. * The name of the material
  84169. */
  84170. name: string;
  84171. /**
  84172. * Gets or sets user defined metadata
  84173. */
  84174. metadata: any;
  84175. /**
  84176. * For internal use only. Please do not use.
  84177. */
  84178. reservedDataStore: any;
  84179. /**
  84180. * Specifies if the ready state should be checked on each call
  84181. */
  84182. checkReadyOnEveryCall: boolean;
  84183. /**
  84184. * Specifies if the ready state should be checked once
  84185. */
  84186. checkReadyOnlyOnce: boolean;
  84187. /**
  84188. * The state of the material
  84189. */
  84190. state: string;
  84191. /**
  84192. * The alpha value of the material
  84193. */
  84194. protected _alpha: number;
  84195. /**
  84196. * List of inspectable custom properties (used by the Inspector)
  84197. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  84198. */
  84199. inspectableCustomProperties: IInspectable[];
  84200. /**
  84201. * Sets the alpha value of the material
  84202. */
  84203. /**
  84204. * Gets the alpha value of the material
  84205. */
  84206. alpha: number;
  84207. /**
  84208. * Specifies if back face culling is enabled
  84209. */
  84210. protected _backFaceCulling: boolean;
  84211. /**
  84212. * Sets the back-face culling state
  84213. */
  84214. /**
  84215. * Gets the back-face culling state
  84216. */
  84217. backFaceCulling: boolean;
  84218. /**
  84219. * Stores the value for side orientation
  84220. */
  84221. sideOrientation: number;
  84222. /**
  84223. * Callback triggered when the material is compiled
  84224. */
  84225. onCompiled: Nullable<(effect: Effect) => void>;
  84226. /**
  84227. * Callback triggered when an error occurs
  84228. */
  84229. onError: Nullable<(effect: Effect, errors: string) => void>;
  84230. /**
  84231. * Callback triggered to get the render target textures
  84232. */
  84233. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  84234. /**
  84235. * Gets a boolean indicating that current material needs to register RTT
  84236. */
  84237. readonly hasRenderTargetTextures: boolean;
  84238. /**
  84239. * Specifies if the material should be serialized
  84240. */
  84241. doNotSerialize: boolean;
  84242. /**
  84243. * @hidden
  84244. */
  84245. _storeEffectOnSubMeshes: boolean;
  84246. /**
  84247. * Stores the animations for the material
  84248. */
  84249. animations: Nullable<Array<Animation>>;
  84250. /**
  84251. * An event triggered when the material is disposed
  84252. */
  84253. onDisposeObservable: Observable<Material>;
  84254. /**
  84255. * An observer which watches for dispose events
  84256. */
  84257. private _onDisposeObserver;
  84258. private _onUnBindObservable;
  84259. /**
  84260. * Called during a dispose event
  84261. */
  84262. onDispose: () => void;
  84263. private _onBindObservable;
  84264. /**
  84265. * An event triggered when the material is bound
  84266. */
  84267. readonly onBindObservable: Observable<AbstractMesh>;
  84268. /**
  84269. * An observer which watches for bind events
  84270. */
  84271. private _onBindObserver;
  84272. /**
  84273. * Called during a bind event
  84274. */
  84275. onBind: (Mesh: AbstractMesh) => void;
  84276. /**
  84277. * An event triggered when the material is unbound
  84278. */
  84279. readonly onUnBindObservable: Observable<Material>;
  84280. /**
  84281. * Stores the value of the alpha mode
  84282. */
  84283. private _alphaMode;
  84284. /**
  84285. * Sets the value of the alpha mode.
  84286. *
  84287. * | Value | Type | Description |
  84288. * | --- | --- | --- |
  84289. * | 0 | ALPHA_DISABLE | |
  84290. * | 1 | ALPHA_ADD | |
  84291. * | 2 | ALPHA_COMBINE | |
  84292. * | 3 | ALPHA_SUBTRACT | |
  84293. * | 4 | ALPHA_MULTIPLY | |
  84294. * | 5 | ALPHA_MAXIMIZED | |
  84295. * | 6 | ALPHA_ONEONE | |
  84296. * | 7 | ALPHA_PREMULTIPLIED | |
  84297. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  84298. * | 9 | ALPHA_INTERPOLATE | |
  84299. * | 10 | ALPHA_SCREENMODE | |
  84300. *
  84301. */
  84302. /**
  84303. * Gets the value of the alpha mode
  84304. */
  84305. alphaMode: number;
  84306. /**
  84307. * Stores the state of the need depth pre-pass value
  84308. */
  84309. private _needDepthPrePass;
  84310. /**
  84311. * Sets the need depth pre-pass value
  84312. */
  84313. /**
  84314. * Gets the depth pre-pass value
  84315. */
  84316. needDepthPrePass: boolean;
  84317. /**
  84318. * Specifies if depth writing should be disabled
  84319. */
  84320. disableDepthWrite: boolean;
  84321. /**
  84322. * Specifies if depth writing should be forced
  84323. */
  84324. forceDepthWrite: boolean;
  84325. /**
  84326. * Specifies if there should be a separate pass for culling
  84327. */
  84328. separateCullingPass: boolean;
  84329. /**
  84330. * Stores the state specifing if fog should be enabled
  84331. */
  84332. private _fogEnabled;
  84333. /**
  84334. * Sets the state for enabling fog
  84335. */
  84336. /**
  84337. * Gets the value of the fog enabled state
  84338. */
  84339. fogEnabled: boolean;
  84340. /**
  84341. * Stores the size of points
  84342. */
  84343. pointSize: number;
  84344. /**
  84345. * Stores the z offset value
  84346. */
  84347. zOffset: number;
  84348. /**
  84349. * Gets a value specifying if wireframe mode is enabled
  84350. */
  84351. /**
  84352. * Sets the state of wireframe mode
  84353. */
  84354. wireframe: boolean;
  84355. /**
  84356. * Gets the value specifying if point clouds are enabled
  84357. */
  84358. /**
  84359. * Sets the state of point cloud mode
  84360. */
  84361. pointsCloud: boolean;
  84362. /**
  84363. * Gets the material fill mode
  84364. */
  84365. /**
  84366. * Sets the material fill mode
  84367. */
  84368. fillMode: number;
  84369. /**
  84370. * @hidden
  84371. * Stores the effects for the material
  84372. */
  84373. _effect: Nullable<Effect>;
  84374. /**
  84375. * @hidden
  84376. * Specifies if the material was previously ready
  84377. */
  84378. _wasPreviouslyReady: boolean;
  84379. /**
  84380. * Specifies if uniform buffers should be used
  84381. */
  84382. private _useUBO;
  84383. /**
  84384. * Stores a reference to the scene
  84385. */
  84386. private _scene;
  84387. /**
  84388. * Stores the fill mode state
  84389. */
  84390. private _fillMode;
  84391. /**
  84392. * Specifies if the depth write state should be cached
  84393. */
  84394. private _cachedDepthWriteState;
  84395. /**
  84396. * Stores the uniform buffer
  84397. */
  84398. protected _uniformBuffer: UniformBuffer;
  84399. /** @hidden */
  84400. _indexInSceneMaterialArray: number;
  84401. /** @hidden */
  84402. meshMap: Nullable<{
  84403. [id: string]: AbstractMesh | undefined;
  84404. }>;
  84405. /**
  84406. * Creates a material instance
  84407. * @param name defines the name of the material
  84408. * @param scene defines the scene to reference
  84409. * @param doNotAdd specifies if the material should be added to the scene
  84410. */
  84411. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  84412. /**
  84413. * Returns a string representation of the current material
  84414. * @param fullDetails defines a boolean indicating which levels of logging is desired
  84415. * @returns a string with material information
  84416. */
  84417. toString(fullDetails?: boolean): string;
  84418. /**
  84419. * Gets the class name of the material
  84420. * @returns a string with the class name of the material
  84421. */
  84422. getClassName(): string;
  84423. /**
  84424. * Specifies if updates for the material been locked
  84425. */
  84426. readonly isFrozen: boolean;
  84427. /**
  84428. * Locks updates for the material
  84429. */
  84430. freeze(): void;
  84431. /**
  84432. * Unlocks updates for the material
  84433. */
  84434. unfreeze(): void;
  84435. /**
  84436. * Specifies if the material is ready to be used
  84437. * @param mesh defines the mesh to check
  84438. * @param useInstances specifies if instances should be used
  84439. * @returns a boolean indicating if the material is ready to be used
  84440. */
  84441. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  84442. /**
  84443. * Specifies that the submesh is ready to be used
  84444. * @param mesh defines the mesh to check
  84445. * @param subMesh defines which submesh to check
  84446. * @param useInstances specifies that instances should be used
  84447. * @returns a boolean indicating that the submesh is ready or not
  84448. */
  84449. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  84450. /**
  84451. * Returns the material effect
  84452. * @returns the effect associated with the material
  84453. */
  84454. getEffect(): Nullable<Effect>;
  84455. /**
  84456. * Returns the current scene
  84457. * @returns a Scene
  84458. */
  84459. getScene(): Scene;
  84460. /**
  84461. * Specifies if the material will require alpha blending
  84462. * @returns a boolean specifying if alpha blending is needed
  84463. */
  84464. needAlphaBlending(): boolean;
  84465. /**
  84466. * Specifies if the mesh will require alpha blending
  84467. * @param mesh defines the mesh to check
  84468. * @returns a boolean specifying if alpha blending is needed for the mesh
  84469. */
  84470. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  84471. /**
  84472. * Specifies if this material should be rendered in alpha test mode
  84473. * @returns a boolean specifying if an alpha test is needed.
  84474. */
  84475. needAlphaTesting(): boolean;
  84476. /**
  84477. * Gets the texture used for the alpha test
  84478. * @returns the texture to use for alpha testing
  84479. */
  84480. getAlphaTestTexture(): Nullable<BaseTexture>;
  84481. /**
  84482. * Marks the material to indicate that it needs to be re-calculated
  84483. */
  84484. markDirty(): void;
  84485. /** @hidden */
  84486. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  84487. /**
  84488. * Binds the material to the mesh
  84489. * @param world defines the world transformation matrix
  84490. * @param mesh defines the mesh to bind the material to
  84491. */
  84492. bind(world: Matrix, mesh?: Mesh): void;
  84493. /**
  84494. * Binds the submesh to the material
  84495. * @param world defines the world transformation matrix
  84496. * @param mesh defines the mesh containing the submesh
  84497. * @param subMesh defines the submesh to bind the material to
  84498. */
  84499. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  84500. /**
  84501. * Binds the world matrix to the material
  84502. * @param world defines the world transformation matrix
  84503. */
  84504. bindOnlyWorldMatrix(world: Matrix): void;
  84505. /**
  84506. * Binds the scene's uniform buffer to the effect.
  84507. * @param effect defines the effect to bind to the scene uniform buffer
  84508. * @param sceneUbo defines the uniform buffer storing scene data
  84509. */
  84510. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  84511. /**
  84512. * Binds the view matrix to the effect
  84513. * @param effect defines the effect to bind the view matrix to
  84514. */
  84515. bindView(effect: Effect): void;
  84516. /**
  84517. * Binds the view projection matrix to the effect
  84518. * @param effect defines the effect to bind the view projection matrix to
  84519. */
  84520. bindViewProjection(effect: Effect): void;
  84521. /**
  84522. * Specifies if material alpha testing should be turned on for the mesh
  84523. * @param mesh defines the mesh to check
  84524. */
  84525. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  84526. /**
  84527. * Processes to execute after binding the material to a mesh
  84528. * @param mesh defines the rendered mesh
  84529. */
  84530. protected _afterBind(mesh?: Mesh): void;
  84531. /**
  84532. * Unbinds the material from the mesh
  84533. */
  84534. unbind(): void;
  84535. /**
  84536. * Gets the active textures from the material
  84537. * @returns an array of textures
  84538. */
  84539. getActiveTextures(): BaseTexture[];
  84540. /**
  84541. * Specifies if the material uses a texture
  84542. * @param texture defines the texture to check against the material
  84543. * @returns a boolean specifying if the material uses the texture
  84544. */
  84545. hasTexture(texture: BaseTexture): boolean;
  84546. /**
  84547. * Makes a duplicate of the material, and gives it a new name
  84548. * @param name defines the new name for the duplicated material
  84549. * @returns the cloned material
  84550. */
  84551. clone(name: string): Nullable<Material>;
  84552. /**
  84553. * Gets the meshes bound to the material
  84554. * @returns an array of meshes bound to the material
  84555. */
  84556. getBindedMeshes(): AbstractMesh[];
  84557. /**
  84558. * Force shader compilation
  84559. * @param mesh defines the mesh associated with this material
  84560. * @param onCompiled defines a function to execute once the material is compiled
  84561. * @param options defines the options to configure the compilation
  84562. */
  84563. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  84564. clipPlane: boolean;
  84565. }>): void;
  84566. /**
  84567. * Force shader compilation
  84568. * @param mesh defines the mesh that will use this material
  84569. * @param options defines additional options for compiling the shaders
  84570. * @returns a promise that resolves when the compilation completes
  84571. */
  84572. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<{
  84573. clipPlane: boolean;
  84574. }>): Promise<void>;
  84575. private static readonly _AllDirtyCallBack;
  84576. private static readonly _ImageProcessingDirtyCallBack;
  84577. private static readonly _TextureDirtyCallBack;
  84578. private static readonly _FresnelDirtyCallBack;
  84579. private static readonly _MiscDirtyCallBack;
  84580. private static readonly _LightsDirtyCallBack;
  84581. private static readonly _AttributeDirtyCallBack;
  84582. private static _FresnelAndMiscDirtyCallBack;
  84583. private static _TextureAndMiscDirtyCallBack;
  84584. private static readonly _DirtyCallbackArray;
  84585. private static readonly _RunDirtyCallBacks;
  84586. /**
  84587. * Marks a define in the material to indicate that it needs to be re-computed
  84588. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  84589. */
  84590. markAsDirty(flag: number): void;
  84591. /**
  84592. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  84593. * @param func defines a function which checks material defines against the submeshes
  84594. */
  84595. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  84596. /**
  84597. * Indicates that we need to re-calculated for all submeshes
  84598. */
  84599. protected _markAllSubMeshesAsAllDirty(): void;
  84600. /**
  84601. * Indicates that image processing needs to be re-calculated for all submeshes
  84602. */
  84603. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  84604. /**
  84605. * Indicates that textures need to be re-calculated for all submeshes
  84606. */
  84607. protected _markAllSubMeshesAsTexturesDirty(): void;
  84608. /**
  84609. * Indicates that fresnel needs to be re-calculated for all submeshes
  84610. */
  84611. protected _markAllSubMeshesAsFresnelDirty(): void;
  84612. /**
  84613. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  84614. */
  84615. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  84616. /**
  84617. * Indicates that lights need to be re-calculated for all submeshes
  84618. */
  84619. protected _markAllSubMeshesAsLightsDirty(): void;
  84620. /**
  84621. * Indicates that attributes need to be re-calculated for all submeshes
  84622. */
  84623. protected _markAllSubMeshesAsAttributesDirty(): void;
  84624. /**
  84625. * Indicates that misc needs to be re-calculated for all submeshes
  84626. */
  84627. protected _markAllSubMeshesAsMiscDirty(): void;
  84628. /**
  84629. * Indicates that textures and misc need to be re-calculated for all submeshes
  84630. */
  84631. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  84632. /**
  84633. * Disposes the material
  84634. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  84635. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  84636. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  84637. */
  84638. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  84639. /** @hidden */
  84640. private releaseVertexArrayObject;
  84641. /**
  84642. * Serializes this material
  84643. * @returns the serialized material object
  84644. */
  84645. serialize(): any;
  84646. /**
  84647. * Creates a material from parsed material data
  84648. * @param parsedMaterial defines parsed material data
  84649. * @param scene defines the hosting scene
  84650. * @param rootUrl defines the root URL to use to load textures
  84651. * @returns a new material
  84652. */
  84653. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  84654. }
  84655. }
  84656. declare module BABYLON {
  84657. /**
  84658. * A multi-material is used to apply different materials to different parts of the same object without the need of
  84659. * separate meshes. This can be use to improve performances.
  84660. * @see http://doc.babylonjs.com/how_to/multi_materials
  84661. */
  84662. export class MultiMaterial extends Material {
  84663. private _subMaterials;
  84664. /**
  84665. * Gets or Sets the list of Materials used within the multi material.
  84666. * They need to be ordered according to the submeshes order in the associated mesh
  84667. */
  84668. subMaterials: Nullable<Material>[];
  84669. /**
  84670. * Function used to align with Node.getChildren()
  84671. * @returns the list of Materials used within the multi material
  84672. */
  84673. getChildren(): Nullable<Material>[];
  84674. /**
  84675. * Instantiates a new Multi Material
  84676. * A multi-material is used to apply different materials to different parts of the same object without the need of
  84677. * separate meshes. This can be use to improve performances.
  84678. * @see http://doc.babylonjs.com/how_to/multi_materials
  84679. * @param name Define the name in the scene
  84680. * @param scene Define the scene the material belongs to
  84681. */
  84682. constructor(name: string, scene: Scene);
  84683. private _hookArray;
  84684. /**
  84685. * Get one of the submaterial by its index in the submaterials array
  84686. * @param index The index to look the sub material at
  84687. * @returns The Material if the index has been defined
  84688. */
  84689. getSubMaterial(index: number): Nullable<Material>;
  84690. /**
  84691. * Get the list of active textures for the whole sub materials list.
  84692. * @returns All the textures that will be used during the rendering
  84693. */
  84694. getActiveTextures(): BaseTexture[];
  84695. /**
  84696. * Gets the current class name of the material e.g. "MultiMaterial"
  84697. * Mainly use in serialization.
  84698. * @returns the class name
  84699. */
  84700. getClassName(): string;
  84701. /**
  84702. * Checks if the material is ready to render the requested sub mesh
  84703. * @param mesh Define the mesh the submesh belongs to
  84704. * @param subMesh Define the sub mesh to look readyness for
  84705. * @param useInstances Define whether or not the material is used with instances
  84706. * @returns true if ready, otherwise false
  84707. */
  84708. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  84709. /**
  84710. * Clones the current material and its related sub materials
  84711. * @param name Define the name of the newly cloned material
  84712. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  84713. * @returns the cloned material
  84714. */
  84715. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  84716. /**
  84717. * Serializes the materials into a JSON representation.
  84718. * @returns the JSON representation
  84719. */
  84720. serialize(): any;
  84721. /**
  84722. * Dispose the material and release its associated resources
  84723. * @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)
  84724. * @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)
  84725. * @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)
  84726. */
  84727. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  84728. /**
  84729. * Creates a MultiMaterial from parsed MultiMaterial data.
  84730. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  84731. * @param scene defines the hosting scene
  84732. * @returns a new MultiMaterial
  84733. */
  84734. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  84735. }
  84736. }
  84737. declare module BABYLON {
  84738. /**
  84739. * Base class for submeshes
  84740. */
  84741. export class BaseSubMesh {
  84742. /** @hidden */
  84743. _materialDefines: Nullable<MaterialDefines>;
  84744. /** @hidden */
  84745. _materialEffect: Nullable<Effect>;
  84746. /**
  84747. * Gets associated effect
  84748. */
  84749. readonly effect: Nullable<Effect>;
  84750. /**
  84751. * Sets associated effect (effect used to render this submesh)
  84752. * @param effect defines the effect to associate with
  84753. * @param defines defines the set of defines used to compile this effect
  84754. */
  84755. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  84756. }
  84757. /**
  84758. * Defines a subdivision inside a mesh
  84759. */
  84760. export class SubMesh extends BaseSubMesh implements ICullable {
  84761. /** the material index to use */
  84762. materialIndex: number;
  84763. /** vertex index start */
  84764. verticesStart: number;
  84765. /** vertices count */
  84766. verticesCount: number;
  84767. /** index start */
  84768. indexStart: number;
  84769. /** indices count */
  84770. indexCount: number;
  84771. /** @hidden */
  84772. _linesIndexCount: number;
  84773. private _mesh;
  84774. private _renderingMesh;
  84775. private _boundingInfo;
  84776. private _linesIndexBuffer;
  84777. /** @hidden */
  84778. _lastColliderWorldVertices: Nullable<Vector3[]>;
  84779. /** @hidden */
  84780. _trianglePlanes: Plane[];
  84781. /** @hidden */
  84782. _lastColliderTransformMatrix: Nullable<Matrix>;
  84783. /** @hidden */
  84784. _renderId: number;
  84785. /** @hidden */
  84786. _alphaIndex: number;
  84787. /** @hidden */
  84788. _distanceToCamera: number;
  84789. /** @hidden */
  84790. _id: number;
  84791. private _currentMaterial;
  84792. /**
  84793. * Add a new submesh to a mesh
  84794. * @param materialIndex defines the material index to use
  84795. * @param verticesStart defines vertex index start
  84796. * @param verticesCount defines vertices count
  84797. * @param indexStart defines index start
  84798. * @param indexCount defines indices count
  84799. * @param mesh defines the parent mesh
  84800. * @param renderingMesh defines an optional rendering mesh
  84801. * @param createBoundingBox defines if bounding box should be created for this submesh
  84802. * @returns the new submesh
  84803. */
  84804. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  84805. /**
  84806. * Creates a new submesh
  84807. * @param materialIndex defines the material index to use
  84808. * @param verticesStart defines vertex index start
  84809. * @param verticesCount defines vertices count
  84810. * @param indexStart defines index start
  84811. * @param indexCount defines indices count
  84812. * @param mesh defines the parent mesh
  84813. * @param renderingMesh defines an optional rendering mesh
  84814. * @param createBoundingBox defines if bounding box should be created for this submesh
  84815. */
  84816. constructor(
  84817. /** the material index to use */
  84818. materialIndex: number,
  84819. /** vertex index start */
  84820. verticesStart: number,
  84821. /** vertices count */
  84822. verticesCount: number,
  84823. /** index start */
  84824. indexStart: number,
  84825. /** indices count */
  84826. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  84827. /**
  84828. * Returns true if this submesh covers the entire parent mesh
  84829. * @ignorenaming
  84830. */
  84831. readonly IsGlobal: boolean;
  84832. /**
  84833. * Returns the submesh BoudingInfo object
  84834. * @returns current bounding info (or mesh's one if the submesh is global)
  84835. */
  84836. getBoundingInfo(): BoundingInfo;
  84837. /**
  84838. * Sets the submesh BoundingInfo
  84839. * @param boundingInfo defines the new bounding info to use
  84840. * @returns the SubMesh
  84841. */
  84842. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  84843. /**
  84844. * Returns the mesh of the current submesh
  84845. * @return the parent mesh
  84846. */
  84847. getMesh(): AbstractMesh;
  84848. /**
  84849. * Returns the rendering mesh of the submesh
  84850. * @returns the rendering mesh (could be different from parent mesh)
  84851. */
  84852. getRenderingMesh(): Mesh;
  84853. /**
  84854. * Returns the submesh material
  84855. * @returns null or the current material
  84856. */
  84857. getMaterial(): Nullable<Material>;
  84858. /**
  84859. * Sets a new updated BoundingInfo object to the submesh
  84860. * @param data defines an optional position array to use to determine the bounding info
  84861. * @returns the SubMesh
  84862. */
  84863. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  84864. /** @hidden */
  84865. _checkCollision(collider: Collider): boolean;
  84866. /**
  84867. * Updates the submesh BoundingInfo
  84868. * @param world defines the world matrix to use to update the bounding info
  84869. * @returns the submesh
  84870. */
  84871. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  84872. /**
  84873. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  84874. * @param frustumPlanes defines the frustum planes
  84875. * @returns true if the submesh is intersecting with the frustum
  84876. */
  84877. isInFrustum(frustumPlanes: Plane[]): boolean;
  84878. /**
  84879. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  84880. * @param frustumPlanes defines the frustum planes
  84881. * @returns true if the submesh is inside the frustum
  84882. */
  84883. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  84884. /**
  84885. * Renders the submesh
  84886. * @param enableAlphaMode defines if alpha needs to be used
  84887. * @returns the submesh
  84888. */
  84889. render(enableAlphaMode: boolean): SubMesh;
  84890. /**
  84891. * @hidden
  84892. */
  84893. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  84894. /**
  84895. * Checks if the submesh intersects with a ray
  84896. * @param ray defines the ray to test
  84897. * @returns true is the passed ray intersects the submesh bounding box
  84898. */
  84899. canIntersects(ray: Ray): boolean;
  84900. /**
  84901. * Intersects current submesh with a ray
  84902. * @param ray defines the ray to test
  84903. * @param positions defines mesh's positions array
  84904. * @param indices defines mesh's indices array
  84905. * @param fastCheck defines if only bounding info should be used
  84906. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  84907. * @returns intersection info or null if no intersection
  84908. */
  84909. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  84910. /** @hidden */
  84911. private _intersectLines;
  84912. /** @hidden */
  84913. private _intersectUnIndexedLines;
  84914. /** @hidden */
  84915. private _intersectTriangles;
  84916. /** @hidden */
  84917. private _intersectUnIndexedTriangles;
  84918. /** @hidden */
  84919. _rebuild(): void;
  84920. /**
  84921. * Creates a new submesh from the passed mesh
  84922. * @param newMesh defines the new hosting mesh
  84923. * @param newRenderingMesh defines an optional rendering mesh
  84924. * @returns the new submesh
  84925. */
  84926. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  84927. /**
  84928. * Release associated resources
  84929. */
  84930. dispose(): void;
  84931. /**
  84932. * Gets the class name
  84933. * @returns the string "SubMesh".
  84934. */
  84935. getClassName(): string;
  84936. /**
  84937. * Creates a new submesh from indices data
  84938. * @param materialIndex the index of the main mesh material
  84939. * @param startIndex the index where to start the copy in the mesh indices array
  84940. * @param indexCount the number of indices to copy then from the startIndex
  84941. * @param mesh the main mesh to create the submesh from
  84942. * @param renderingMesh the optional rendering mesh
  84943. * @returns a new submesh
  84944. */
  84945. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  84946. }
  84947. }
  84948. declare module BABYLON {
  84949. /**
  84950. * Class used to represent data loading progression
  84951. */
  84952. export class SceneLoaderFlags {
  84953. private static _ForceFullSceneLoadingForIncremental;
  84954. private static _ShowLoadingScreen;
  84955. private static _CleanBoneMatrixWeights;
  84956. private static _loggingLevel;
  84957. /**
  84958. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  84959. */
  84960. static ForceFullSceneLoadingForIncremental: boolean;
  84961. /**
  84962. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  84963. */
  84964. static ShowLoadingScreen: boolean;
  84965. /**
  84966. * Defines the current logging level (while loading the scene)
  84967. * @ignorenaming
  84968. */
  84969. static loggingLevel: number;
  84970. /**
  84971. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  84972. */
  84973. static CleanBoneMatrixWeights: boolean;
  84974. }
  84975. }
  84976. declare module BABYLON {
  84977. /**
  84978. * Class used to store geometry data (vertex buffers + index buffer)
  84979. */
  84980. export class Geometry implements IGetSetVerticesData {
  84981. /**
  84982. * Gets or sets the ID of the geometry
  84983. */
  84984. id: string;
  84985. /**
  84986. * Gets or sets the unique ID of the geometry
  84987. */
  84988. uniqueId: number;
  84989. /**
  84990. * Gets the delay loading state of the geometry (none by default which means not delayed)
  84991. */
  84992. delayLoadState: number;
  84993. /**
  84994. * Gets the file containing the data to load when running in delay load state
  84995. */
  84996. delayLoadingFile: Nullable<string>;
  84997. /**
  84998. * Callback called when the geometry is updated
  84999. */
  85000. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  85001. private _scene;
  85002. private _engine;
  85003. private _meshes;
  85004. private _totalVertices;
  85005. /** @hidden */
  85006. _indices: IndicesArray;
  85007. /** @hidden */
  85008. _vertexBuffers: {
  85009. [key: string]: VertexBuffer;
  85010. };
  85011. private _isDisposed;
  85012. private _extend;
  85013. private _boundingBias;
  85014. /** @hidden */
  85015. _delayInfo: Array<string>;
  85016. private _indexBuffer;
  85017. private _indexBufferIsUpdatable;
  85018. /** @hidden */
  85019. _boundingInfo: Nullable<BoundingInfo>;
  85020. /** @hidden */
  85021. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  85022. /** @hidden */
  85023. _softwareSkinningFrameId: number;
  85024. private _vertexArrayObjects;
  85025. private _updatable;
  85026. /** @hidden */
  85027. _positions: Nullable<Vector3[]>;
  85028. /**
  85029. * 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
  85030. */
  85031. /**
  85032. * 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
  85033. */
  85034. boundingBias: Vector2;
  85035. /**
  85036. * Static function used to attach a new empty geometry to a mesh
  85037. * @param mesh defines the mesh to attach the geometry to
  85038. * @returns the new Geometry
  85039. */
  85040. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  85041. /**
  85042. * Creates a new geometry
  85043. * @param id defines the unique ID
  85044. * @param scene defines the hosting scene
  85045. * @param vertexData defines the VertexData used to get geometry data
  85046. * @param updatable defines if geometry must be updatable (false by default)
  85047. * @param mesh defines the mesh that will be associated with the geometry
  85048. */
  85049. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  85050. /**
  85051. * Gets the current extend of the geometry
  85052. */
  85053. readonly extend: {
  85054. minimum: Vector3;
  85055. maximum: Vector3;
  85056. };
  85057. /**
  85058. * Gets the hosting scene
  85059. * @returns the hosting Scene
  85060. */
  85061. getScene(): Scene;
  85062. /**
  85063. * Gets the hosting engine
  85064. * @returns the hosting Engine
  85065. */
  85066. getEngine(): Engine;
  85067. /**
  85068. * Defines if the geometry is ready to use
  85069. * @returns true if the geometry is ready to be used
  85070. */
  85071. isReady(): boolean;
  85072. /**
  85073. * Gets a value indicating that the geometry should not be serialized
  85074. */
  85075. readonly doNotSerialize: boolean;
  85076. /** @hidden */
  85077. _rebuild(): void;
  85078. /**
  85079. * Affects all geometry data in one call
  85080. * @param vertexData defines the geometry data
  85081. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  85082. */
  85083. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  85084. /**
  85085. * Set specific vertex data
  85086. * @param kind defines the data kind (Position, normal, etc...)
  85087. * @param data defines the vertex data to use
  85088. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  85089. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  85090. */
  85091. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  85092. /**
  85093. * Removes a specific vertex data
  85094. * @param kind defines the data kind (Position, normal, etc...)
  85095. */
  85096. removeVerticesData(kind: string): void;
  85097. /**
  85098. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  85099. * @param buffer defines the vertex buffer to use
  85100. * @param totalVertices defines the total number of vertices for position kind (could be null)
  85101. */
  85102. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  85103. /**
  85104. * Update a specific vertex buffer
  85105. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  85106. * It will do nothing if the buffer is not updatable
  85107. * @param kind defines the data kind (Position, normal, etc...)
  85108. * @param data defines the data to use
  85109. * @param offset defines the offset in the target buffer where to store the data
  85110. * @param useBytes set to true if the offset is in bytes
  85111. */
  85112. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  85113. /**
  85114. * Update a specific vertex buffer
  85115. * This function will create a new buffer if the current one is not updatable
  85116. * @param kind defines the data kind (Position, normal, etc...)
  85117. * @param data defines the data to use
  85118. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  85119. */
  85120. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  85121. private _updateBoundingInfo;
  85122. /** @hidden */
  85123. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  85124. /**
  85125. * Gets total number of vertices
  85126. * @returns the total number of vertices
  85127. */
  85128. getTotalVertices(): number;
  85129. /**
  85130. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  85131. * @param kind defines the data kind (Position, normal, etc...)
  85132. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  85133. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  85134. * @returns a float array containing vertex data
  85135. */
  85136. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  85137. /**
  85138. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  85139. * @param kind defines the data kind (Position, normal, etc...)
  85140. * @returns true if the vertex buffer with the specified kind is updatable
  85141. */
  85142. isVertexBufferUpdatable(kind: string): boolean;
  85143. /**
  85144. * Gets a specific vertex buffer
  85145. * @param kind defines the data kind (Position, normal, etc...)
  85146. * @returns a VertexBuffer
  85147. */
  85148. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  85149. /**
  85150. * Returns all vertex buffers
  85151. * @return an object holding all vertex buffers indexed by kind
  85152. */
  85153. getVertexBuffers(): Nullable<{
  85154. [key: string]: VertexBuffer;
  85155. }>;
  85156. /**
  85157. * Gets a boolean indicating if specific vertex buffer is present
  85158. * @param kind defines the data kind (Position, normal, etc...)
  85159. * @returns true if data is present
  85160. */
  85161. isVerticesDataPresent(kind: string): boolean;
  85162. /**
  85163. * Gets a list of all attached data kinds (Position, normal, etc...)
  85164. * @returns a list of string containing all kinds
  85165. */
  85166. getVerticesDataKinds(): string[];
  85167. /**
  85168. * Update index buffer
  85169. * @param indices defines the indices to store in the index buffer
  85170. * @param offset defines the offset in the target buffer where to store the data
  85171. * @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)
  85172. */
  85173. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  85174. /**
  85175. * Creates a new index buffer
  85176. * @param indices defines the indices to store in the index buffer
  85177. * @param totalVertices defines the total number of vertices (could be null)
  85178. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  85179. */
  85180. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  85181. /**
  85182. * Return the total number of indices
  85183. * @returns the total number of indices
  85184. */
  85185. getTotalIndices(): number;
  85186. /**
  85187. * Gets the index buffer array
  85188. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  85189. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  85190. * @returns the index buffer array
  85191. */
  85192. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  85193. /**
  85194. * Gets the index buffer
  85195. * @return the index buffer
  85196. */
  85197. getIndexBuffer(): Nullable<DataBuffer>;
  85198. /** @hidden */
  85199. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  85200. /**
  85201. * Release the associated resources for a specific mesh
  85202. * @param mesh defines the source mesh
  85203. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  85204. */
  85205. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  85206. /**
  85207. * Apply current geometry to a given mesh
  85208. * @param mesh defines the mesh to apply geometry to
  85209. */
  85210. applyToMesh(mesh: Mesh): void;
  85211. private _updateExtend;
  85212. private _applyToMesh;
  85213. private notifyUpdate;
  85214. /**
  85215. * Load the geometry if it was flagged as delay loaded
  85216. * @param scene defines the hosting scene
  85217. * @param onLoaded defines a callback called when the geometry is loaded
  85218. */
  85219. load(scene: Scene, onLoaded?: () => void): void;
  85220. private _queueLoad;
  85221. /**
  85222. * Invert the geometry to move from a right handed system to a left handed one.
  85223. */
  85224. toLeftHanded(): void;
  85225. /** @hidden */
  85226. _resetPointsArrayCache(): void;
  85227. /** @hidden */
  85228. _generatePointsArray(): boolean;
  85229. /**
  85230. * Gets a value indicating if the geometry is disposed
  85231. * @returns true if the geometry was disposed
  85232. */
  85233. isDisposed(): boolean;
  85234. private _disposeVertexArrayObjects;
  85235. /**
  85236. * Free all associated resources
  85237. */
  85238. dispose(): void;
  85239. /**
  85240. * Clone the current geometry into a new geometry
  85241. * @param id defines the unique ID of the new geometry
  85242. * @returns a new geometry object
  85243. */
  85244. copy(id: string): Geometry;
  85245. /**
  85246. * Serialize the current geometry info (and not the vertices data) into a JSON object
  85247. * @return a JSON representation of the current geometry data (without the vertices data)
  85248. */
  85249. serialize(): any;
  85250. private toNumberArray;
  85251. /**
  85252. * Serialize all vertices data into a JSON oject
  85253. * @returns a JSON representation of the current geometry data
  85254. */
  85255. serializeVerticeData(): any;
  85256. /**
  85257. * Extracts a clone of a mesh geometry
  85258. * @param mesh defines the source mesh
  85259. * @param id defines the unique ID of the new geometry object
  85260. * @returns the new geometry object
  85261. */
  85262. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  85263. /**
  85264. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  85265. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  85266. * Be aware Math.random() could cause collisions, but:
  85267. * "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"
  85268. * @returns a string containing a new GUID
  85269. */
  85270. static RandomId(): string;
  85271. /** @hidden */
  85272. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  85273. private static _CleanMatricesWeights;
  85274. /**
  85275. * Create a new geometry from persisted data (Using .babylon file format)
  85276. * @param parsedVertexData defines the persisted data
  85277. * @param scene defines the hosting scene
  85278. * @param rootUrl defines the root url to use to load assets (like delayed data)
  85279. * @returns the new geometry object
  85280. */
  85281. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  85282. }
  85283. }
  85284. declare module BABYLON {
  85285. /**
  85286. * Define an interface for all classes that will get and set the data on vertices
  85287. */
  85288. export interface IGetSetVerticesData {
  85289. /**
  85290. * Gets a boolean indicating if specific vertex data is present
  85291. * @param kind defines the vertex data kind to use
  85292. * @returns true is data kind is present
  85293. */
  85294. isVerticesDataPresent(kind: string): boolean;
  85295. /**
  85296. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  85297. * @param kind defines the data kind (Position, normal, etc...)
  85298. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  85299. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  85300. * @returns a float array containing vertex data
  85301. */
  85302. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  85303. /**
  85304. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  85305. * @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.
  85306. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  85307. * @returns the indices array or an empty array if the mesh has no geometry
  85308. */
  85309. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  85310. /**
  85311. * Set specific vertex data
  85312. * @param kind defines the data kind (Position, normal, etc...)
  85313. * @param data defines the vertex data to use
  85314. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  85315. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  85316. */
  85317. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  85318. /**
  85319. * Update a specific associated vertex buffer
  85320. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  85321. * - VertexBuffer.PositionKind
  85322. * - VertexBuffer.UVKind
  85323. * - VertexBuffer.UV2Kind
  85324. * - VertexBuffer.UV3Kind
  85325. * - VertexBuffer.UV4Kind
  85326. * - VertexBuffer.UV5Kind
  85327. * - VertexBuffer.UV6Kind
  85328. * - VertexBuffer.ColorKind
  85329. * - VertexBuffer.MatricesIndicesKind
  85330. * - VertexBuffer.MatricesIndicesExtraKind
  85331. * - VertexBuffer.MatricesWeightsKind
  85332. * - VertexBuffer.MatricesWeightsExtraKind
  85333. * @param data defines the data source
  85334. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  85335. * @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)
  85336. */
  85337. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  85338. /**
  85339. * Creates a new index buffer
  85340. * @param indices defines the indices to store in the index buffer
  85341. * @param totalVertices defines the total number of vertices (could be null)
  85342. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  85343. */
  85344. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  85345. }
  85346. /**
  85347. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  85348. */
  85349. export class VertexData {
  85350. /**
  85351. * Mesh side orientation : usually the external or front surface
  85352. */
  85353. static readonly FRONTSIDE: number;
  85354. /**
  85355. * Mesh side orientation : usually the internal or back surface
  85356. */
  85357. static readonly BACKSIDE: number;
  85358. /**
  85359. * Mesh side orientation : both internal and external or front and back surfaces
  85360. */
  85361. static readonly DOUBLESIDE: number;
  85362. /**
  85363. * Mesh side orientation : by default, `FRONTSIDE`
  85364. */
  85365. static readonly DEFAULTSIDE: number;
  85366. /**
  85367. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  85368. */
  85369. positions: Nullable<FloatArray>;
  85370. /**
  85371. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  85372. */
  85373. normals: Nullable<FloatArray>;
  85374. /**
  85375. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  85376. */
  85377. tangents: Nullable<FloatArray>;
  85378. /**
  85379. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  85380. */
  85381. uvs: Nullable<FloatArray>;
  85382. /**
  85383. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  85384. */
  85385. uvs2: Nullable<FloatArray>;
  85386. /**
  85387. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  85388. */
  85389. uvs3: Nullable<FloatArray>;
  85390. /**
  85391. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  85392. */
  85393. uvs4: Nullable<FloatArray>;
  85394. /**
  85395. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  85396. */
  85397. uvs5: Nullable<FloatArray>;
  85398. /**
  85399. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  85400. */
  85401. uvs6: Nullable<FloatArray>;
  85402. /**
  85403. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  85404. */
  85405. colors: Nullable<FloatArray>;
  85406. /**
  85407. * 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).
  85408. */
  85409. matricesIndices: Nullable<FloatArray>;
  85410. /**
  85411. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  85412. */
  85413. matricesWeights: Nullable<FloatArray>;
  85414. /**
  85415. * An array extending the number of possible indices
  85416. */
  85417. matricesIndicesExtra: Nullable<FloatArray>;
  85418. /**
  85419. * An array extending the number of possible weights when the number of indices is extended
  85420. */
  85421. matricesWeightsExtra: Nullable<FloatArray>;
  85422. /**
  85423. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  85424. */
  85425. indices: Nullable<IndicesArray>;
  85426. /**
  85427. * Uses the passed data array to set the set the values for the specified kind of data
  85428. * @param data a linear array of floating numbers
  85429. * @param kind the type of data that is being set, eg positions, colors etc
  85430. */
  85431. set(data: FloatArray, kind: string): void;
  85432. /**
  85433. * Associates the vertexData to the passed Mesh.
  85434. * Sets it as updatable or not (default `false`)
  85435. * @param mesh the mesh the vertexData is applied to
  85436. * @param updatable when used and having the value true allows new data to update the vertexData
  85437. * @returns the VertexData
  85438. */
  85439. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  85440. /**
  85441. * Associates the vertexData to the passed Geometry.
  85442. * Sets it as updatable or not (default `false`)
  85443. * @param geometry the geometry the vertexData is applied to
  85444. * @param updatable when used and having the value true allows new data to update the vertexData
  85445. * @returns VertexData
  85446. */
  85447. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  85448. /**
  85449. * Updates the associated mesh
  85450. * @param mesh the mesh to be updated
  85451. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  85452. * @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
  85453. * @returns VertexData
  85454. */
  85455. updateMesh(mesh: Mesh): VertexData;
  85456. /**
  85457. * Updates the associated geometry
  85458. * @param geometry the geometry to be updated
  85459. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  85460. * @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
  85461. * @returns VertexData.
  85462. */
  85463. updateGeometry(geometry: Geometry): VertexData;
  85464. private _applyTo;
  85465. private _update;
  85466. /**
  85467. * Transforms each position and each normal of the vertexData according to the passed Matrix
  85468. * @param matrix the transforming matrix
  85469. * @returns the VertexData
  85470. */
  85471. transform(matrix: Matrix): VertexData;
  85472. /**
  85473. * Merges the passed VertexData into the current one
  85474. * @param other the VertexData to be merged into the current one
  85475. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  85476. * @returns the modified VertexData
  85477. */
  85478. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  85479. private _mergeElement;
  85480. private _validate;
  85481. /**
  85482. * Serializes the VertexData
  85483. * @returns a serialized object
  85484. */
  85485. serialize(): any;
  85486. /**
  85487. * Extracts the vertexData from a mesh
  85488. * @param mesh the mesh from which to extract the VertexData
  85489. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  85490. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  85491. * @returns the object VertexData associated to the passed mesh
  85492. */
  85493. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  85494. /**
  85495. * Extracts the vertexData from the geometry
  85496. * @param geometry the geometry from which to extract the VertexData
  85497. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  85498. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  85499. * @returns the object VertexData associated to the passed mesh
  85500. */
  85501. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  85502. private static _ExtractFrom;
  85503. /**
  85504. * Creates the VertexData for a Ribbon
  85505. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  85506. * * pathArray array of paths, each of which an array of successive Vector3
  85507. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  85508. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  85509. * * 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
  85510. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85511. * * 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)
  85512. * * 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)
  85513. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  85514. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  85515. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  85516. * @returns the VertexData of the ribbon
  85517. */
  85518. static CreateRibbon(options: {
  85519. pathArray: Vector3[][];
  85520. closeArray?: boolean;
  85521. closePath?: boolean;
  85522. offset?: number;
  85523. sideOrientation?: number;
  85524. frontUVs?: Vector4;
  85525. backUVs?: Vector4;
  85526. invertUV?: boolean;
  85527. uvs?: Vector2[];
  85528. colors?: Color4[];
  85529. }): VertexData;
  85530. /**
  85531. * Creates the VertexData for a box
  85532. * @param options an object used to set the following optional parameters for the box, required but can be empty
  85533. * * size sets the width, height and depth of the box to the value of size, optional default 1
  85534. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  85535. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  85536. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  85537. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  85538. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  85539. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85540. * * 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)
  85541. * * 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)
  85542. * @returns the VertexData of the box
  85543. */
  85544. static CreateBox(options: {
  85545. size?: number;
  85546. width?: number;
  85547. height?: number;
  85548. depth?: number;
  85549. faceUV?: Vector4[];
  85550. faceColors?: Color4[];
  85551. sideOrientation?: number;
  85552. frontUVs?: Vector4;
  85553. backUVs?: Vector4;
  85554. }): VertexData;
  85555. /**
  85556. * Creates the VertexData for a tiled box
  85557. * @param options an object used to set the following optional parameters for the box, required but can be empty
  85558. * * faceTiles sets the pattern, tile size and number of tiles for a face
  85559. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  85560. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  85561. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85562. * @returns the VertexData of the box
  85563. */
  85564. static CreateTiledBox(options: {
  85565. pattern?: number;
  85566. width?: number;
  85567. height?: number;
  85568. depth?: number;
  85569. tileSize?: number;
  85570. tileWidth?: number;
  85571. tileHeight?: number;
  85572. alignHorizontal?: number;
  85573. alignVertical?: number;
  85574. faceUV?: Vector4[];
  85575. faceColors?: Color4[];
  85576. sideOrientation?: number;
  85577. }): VertexData;
  85578. /**
  85579. * Creates the VertexData for a tiled plane
  85580. * @param options an object used to set the following optional parameters for the box, required but can be empty
  85581. * * pattern a limited pattern arrangement depending on the number
  85582. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  85583. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  85584. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  85585. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85586. * * 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)
  85587. * * 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)
  85588. * @returns the VertexData of the tiled plane
  85589. */
  85590. static CreateTiledPlane(options: {
  85591. pattern?: number;
  85592. tileSize?: number;
  85593. tileWidth?: number;
  85594. tileHeight?: number;
  85595. size?: number;
  85596. width?: number;
  85597. height?: number;
  85598. alignHorizontal?: number;
  85599. alignVertical?: number;
  85600. sideOrientation?: number;
  85601. frontUVs?: Vector4;
  85602. backUVs?: Vector4;
  85603. }): VertexData;
  85604. /**
  85605. * Creates the VertexData for an ellipsoid, defaults to a sphere
  85606. * @param options an object used to set the following optional parameters for the box, required but can be empty
  85607. * * segments sets the number of horizontal strips optional, default 32
  85608. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  85609. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  85610. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  85611. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  85612. * * 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
  85613. * * 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
  85614. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85615. * * 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)
  85616. * * 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)
  85617. * @returns the VertexData of the ellipsoid
  85618. */
  85619. static CreateSphere(options: {
  85620. segments?: number;
  85621. diameter?: number;
  85622. diameterX?: number;
  85623. diameterY?: number;
  85624. diameterZ?: number;
  85625. arc?: number;
  85626. slice?: number;
  85627. sideOrientation?: number;
  85628. frontUVs?: Vector4;
  85629. backUVs?: Vector4;
  85630. }): VertexData;
  85631. /**
  85632. * Creates the VertexData for a cylinder, cone or prism
  85633. * @param options an object used to set the following optional parameters for the box, required but can be empty
  85634. * * height sets the height (y direction) of the cylinder, optional, default 2
  85635. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  85636. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  85637. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  85638. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  85639. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  85640. * * 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
  85641. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  85642. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  85643. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  85644. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  85645. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85646. * * 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)
  85647. * * 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)
  85648. * @returns the VertexData of the cylinder, cone or prism
  85649. */
  85650. static CreateCylinder(options: {
  85651. height?: number;
  85652. diameterTop?: number;
  85653. diameterBottom?: number;
  85654. diameter?: number;
  85655. tessellation?: number;
  85656. subdivisions?: number;
  85657. arc?: number;
  85658. faceColors?: Color4[];
  85659. faceUV?: Vector4[];
  85660. hasRings?: boolean;
  85661. enclose?: boolean;
  85662. sideOrientation?: number;
  85663. frontUVs?: Vector4;
  85664. backUVs?: Vector4;
  85665. }): VertexData;
  85666. /**
  85667. * Creates the VertexData for a torus
  85668. * @param options an object used to set the following optional parameters for the box, required but can be empty
  85669. * * diameter the diameter of the torus, optional default 1
  85670. * * thickness the diameter of the tube forming the torus, optional default 0.5
  85671. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  85672. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85673. * * 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)
  85674. * * 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)
  85675. * @returns the VertexData of the torus
  85676. */
  85677. static CreateTorus(options: {
  85678. diameter?: number;
  85679. thickness?: number;
  85680. tessellation?: number;
  85681. sideOrientation?: number;
  85682. frontUVs?: Vector4;
  85683. backUVs?: Vector4;
  85684. }): VertexData;
  85685. /**
  85686. * Creates the VertexData of the LineSystem
  85687. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  85688. * - lines an array of lines, each line being an array of successive Vector3
  85689. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  85690. * @returns the VertexData of the LineSystem
  85691. */
  85692. static CreateLineSystem(options: {
  85693. lines: Vector3[][];
  85694. colors?: Nullable<Color4[][]>;
  85695. }): VertexData;
  85696. /**
  85697. * Create the VertexData for a DashedLines
  85698. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  85699. * - points an array successive Vector3
  85700. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  85701. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  85702. * - dashNb the intended total number of dashes, optional, default 200
  85703. * @returns the VertexData for the DashedLines
  85704. */
  85705. static CreateDashedLines(options: {
  85706. points: Vector3[];
  85707. dashSize?: number;
  85708. gapSize?: number;
  85709. dashNb?: number;
  85710. }): VertexData;
  85711. /**
  85712. * Creates the VertexData for a Ground
  85713. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  85714. * - width the width (x direction) of the ground, optional, default 1
  85715. * - height the height (z direction) of the ground, optional, default 1
  85716. * - subdivisions the number of subdivisions per side, optional, default 1
  85717. * @returns the VertexData of the Ground
  85718. */
  85719. static CreateGround(options: {
  85720. width?: number;
  85721. height?: number;
  85722. subdivisions?: number;
  85723. subdivisionsX?: number;
  85724. subdivisionsY?: number;
  85725. }): VertexData;
  85726. /**
  85727. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  85728. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  85729. * * xmin the ground minimum X coordinate, optional, default -1
  85730. * * zmin the ground minimum Z coordinate, optional, default -1
  85731. * * xmax the ground maximum X coordinate, optional, default 1
  85732. * * zmax the ground maximum Z coordinate, optional, default 1
  85733. * * 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}
  85734. * * 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}
  85735. * @returns the VertexData of the TiledGround
  85736. */
  85737. static CreateTiledGround(options: {
  85738. xmin: number;
  85739. zmin: number;
  85740. xmax: number;
  85741. zmax: number;
  85742. subdivisions?: {
  85743. w: number;
  85744. h: number;
  85745. };
  85746. precision?: {
  85747. w: number;
  85748. h: number;
  85749. };
  85750. }): VertexData;
  85751. /**
  85752. * Creates the VertexData of the Ground designed from a heightmap
  85753. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  85754. * * width the width (x direction) of the ground
  85755. * * height the height (z direction) of the ground
  85756. * * subdivisions the number of subdivisions per side
  85757. * * minHeight the minimum altitude on the ground, optional, default 0
  85758. * * maxHeight the maximum altitude on the ground, optional default 1
  85759. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  85760. * * buffer the array holding the image color data
  85761. * * bufferWidth the width of image
  85762. * * bufferHeight the height of image
  85763. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  85764. * @returns the VertexData of the Ground designed from a heightmap
  85765. */
  85766. static CreateGroundFromHeightMap(options: {
  85767. width: number;
  85768. height: number;
  85769. subdivisions: number;
  85770. minHeight: number;
  85771. maxHeight: number;
  85772. colorFilter: Color3;
  85773. buffer: Uint8Array;
  85774. bufferWidth: number;
  85775. bufferHeight: number;
  85776. alphaFilter: number;
  85777. }): VertexData;
  85778. /**
  85779. * Creates the VertexData for a Plane
  85780. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  85781. * * size sets the width and height of the plane to the value of size, optional default 1
  85782. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  85783. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  85784. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85785. * * 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)
  85786. * * 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)
  85787. * @returns the VertexData of the box
  85788. */
  85789. static CreatePlane(options: {
  85790. size?: number;
  85791. width?: number;
  85792. height?: number;
  85793. sideOrientation?: number;
  85794. frontUVs?: Vector4;
  85795. backUVs?: Vector4;
  85796. }): VertexData;
  85797. /**
  85798. * Creates the VertexData of the Disc or regular Polygon
  85799. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  85800. * * radius the radius of the disc, optional default 0.5
  85801. * * tessellation the number of polygon sides, optional, default 64
  85802. * * 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
  85803. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85804. * * 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)
  85805. * * 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)
  85806. * @returns the VertexData of the box
  85807. */
  85808. static CreateDisc(options: {
  85809. radius?: number;
  85810. tessellation?: number;
  85811. arc?: number;
  85812. sideOrientation?: number;
  85813. frontUVs?: Vector4;
  85814. backUVs?: Vector4;
  85815. }): VertexData;
  85816. /**
  85817. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  85818. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  85819. * @param polygon a mesh built from polygonTriangulation.build()
  85820. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85821. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  85822. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  85823. * @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)
  85824. * @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)
  85825. * @returns the VertexData of the Polygon
  85826. */
  85827. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  85828. /**
  85829. * Creates the VertexData of the IcoSphere
  85830. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  85831. * * radius the radius of the IcoSphere, optional default 1
  85832. * * radiusX allows stretching in the x direction, optional, default radius
  85833. * * radiusY allows stretching in the y direction, optional, default radius
  85834. * * radiusZ allows stretching in the z direction, optional, default radius
  85835. * * flat when true creates a flat shaded mesh, optional, default true
  85836. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  85837. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85838. * * 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)
  85839. * * 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)
  85840. * @returns the VertexData of the IcoSphere
  85841. */
  85842. static CreateIcoSphere(options: {
  85843. radius?: number;
  85844. radiusX?: number;
  85845. radiusY?: number;
  85846. radiusZ?: number;
  85847. flat?: boolean;
  85848. subdivisions?: number;
  85849. sideOrientation?: number;
  85850. frontUVs?: Vector4;
  85851. backUVs?: Vector4;
  85852. }): VertexData;
  85853. /**
  85854. * Creates the VertexData for a Polyhedron
  85855. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  85856. * * type provided types are:
  85857. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  85858. * * 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)
  85859. * * size the size of the IcoSphere, optional default 1
  85860. * * sizeX allows stretching in the x direction, optional, default size
  85861. * * sizeY allows stretching in the y direction, optional, default size
  85862. * * sizeZ allows stretching in the z direction, optional, default size
  85863. * * 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
  85864. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  85865. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  85866. * * flat when true creates a flat shaded mesh, optional, default true
  85867. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  85868. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85869. * * 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)
  85870. * * 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)
  85871. * @returns the VertexData of the Polyhedron
  85872. */
  85873. static CreatePolyhedron(options: {
  85874. type?: number;
  85875. size?: number;
  85876. sizeX?: number;
  85877. sizeY?: number;
  85878. sizeZ?: number;
  85879. custom?: any;
  85880. faceUV?: Vector4[];
  85881. faceColors?: Color4[];
  85882. flat?: boolean;
  85883. sideOrientation?: number;
  85884. frontUVs?: Vector4;
  85885. backUVs?: Vector4;
  85886. }): VertexData;
  85887. /**
  85888. * Creates the VertexData for a TorusKnot
  85889. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  85890. * * radius the radius of the torus knot, optional, default 2
  85891. * * tube the thickness of the tube, optional, default 0.5
  85892. * * radialSegments the number of sides on each tube segments, optional, default 32
  85893. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  85894. * * p the number of windings around the z axis, optional, default 2
  85895. * * q the number of windings around the x axis, optional, default 3
  85896. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  85897. * * 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)
  85898. * * 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)
  85899. * @returns the VertexData of the Torus Knot
  85900. */
  85901. static CreateTorusKnot(options: {
  85902. radius?: number;
  85903. tube?: number;
  85904. radialSegments?: number;
  85905. tubularSegments?: number;
  85906. p?: number;
  85907. q?: number;
  85908. sideOrientation?: number;
  85909. frontUVs?: Vector4;
  85910. backUVs?: Vector4;
  85911. }): VertexData;
  85912. /**
  85913. * Compute normals for given positions and indices
  85914. * @param positions an array of vertex positions, [...., x, y, z, ......]
  85915. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  85916. * @param normals an array of vertex normals, [...., x, y, z, ......]
  85917. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  85918. * * facetNormals : optional array of facet normals (vector3)
  85919. * * facetPositions : optional array of facet positions (vector3)
  85920. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  85921. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  85922. * * bInfo : optional bounding info, required for facetPartitioning computation
  85923. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  85924. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  85925. * * useRightHandedSystem: optional boolean to for right handed system computation
  85926. * * depthSort : optional boolean to enable the facet depth sort computation
  85927. * * distanceTo : optional Vector3 to compute the facet depth from this location
  85928. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  85929. */
  85930. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  85931. facetNormals?: any;
  85932. facetPositions?: any;
  85933. facetPartitioning?: any;
  85934. ratio?: number;
  85935. bInfo?: any;
  85936. bbSize?: Vector3;
  85937. subDiv?: any;
  85938. useRightHandedSystem?: boolean;
  85939. depthSort?: boolean;
  85940. distanceTo?: Vector3;
  85941. depthSortedFacets?: any;
  85942. }): void;
  85943. /** @hidden */
  85944. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  85945. /**
  85946. * Applies VertexData created from the imported parameters to the geometry
  85947. * @param parsedVertexData the parsed data from an imported file
  85948. * @param geometry the geometry to apply the VertexData to
  85949. */
  85950. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  85951. }
  85952. }
  85953. declare module BABYLON {
  85954. /**
  85955. * Defines a target to use with MorphTargetManager
  85956. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  85957. */
  85958. export class MorphTarget implements IAnimatable {
  85959. /** defines the name of the target */
  85960. name: string;
  85961. /**
  85962. * Gets or sets the list of animations
  85963. */
  85964. animations: Animation[];
  85965. private _scene;
  85966. private _positions;
  85967. private _normals;
  85968. private _tangents;
  85969. private _uvs;
  85970. private _influence;
  85971. /**
  85972. * Observable raised when the influence changes
  85973. */
  85974. onInfluenceChanged: Observable<boolean>;
  85975. /** @hidden */
  85976. _onDataLayoutChanged: Observable<void>;
  85977. /**
  85978. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  85979. */
  85980. influence: number;
  85981. /**
  85982. * Gets or sets the id of the morph Target
  85983. */
  85984. id: string;
  85985. private _animationPropertiesOverride;
  85986. /**
  85987. * Gets or sets the animation properties override
  85988. */
  85989. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  85990. /**
  85991. * Creates a new MorphTarget
  85992. * @param name defines the name of the target
  85993. * @param influence defines the influence to use
  85994. * @param scene defines the scene the morphtarget belongs to
  85995. */
  85996. constructor(
  85997. /** defines the name of the target */
  85998. name: string, influence?: number, scene?: Nullable<Scene>);
  85999. /**
  86000. * Gets a boolean defining if the target contains position data
  86001. */
  86002. readonly hasPositions: boolean;
  86003. /**
  86004. * Gets a boolean defining if the target contains normal data
  86005. */
  86006. readonly hasNormals: boolean;
  86007. /**
  86008. * Gets a boolean defining if the target contains tangent data
  86009. */
  86010. readonly hasTangents: boolean;
  86011. /**
  86012. * Gets a boolean defining if the target contains texture coordinates data
  86013. */
  86014. readonly hasUVs: boolean;
  86015. /**
  86016. * Affects position data to this target
  86017. * @param data defines the position data to use
  86018. */
  86019. setPositions(data: Nullable<FloatArray>): void;
  86020. /**
  86021. * Gets the position data stored in this target
  86022. * @returns a FloatArray containing the position data (or null if not present)
  86023. */
  86024. getPositions(): Nullable<FloatArray>;
  86025. /**
  86026. * Affects normal data to this target
  86027. * @param data defines the normal data to use
  86028. */
  86029. setNormals(data: Nullable<FloatArray>): void;
  86030. /**
  86031. * Gets the normal data stored in this target
  86032. * @returns a FloatArray containing the normal data (or null if not present)
  86033. */
  86034. getNormals(): Nullable<FloatArray>;
  86035. /**
  86036. * Affects tangent data to this target
  86037. * @param data defines the tangent data to use
  86038. */
  86039. setTangents(data: Nullable<FloatArray>): void;
  86040. /**
  86041. * Gets the tangent data stored in this target
  86042. * @returns a FloatArray containing the tangent data (or null if not present)
  86043. */
  86044. getTangents(): Nullable<FloatArray>;
  86045. /**
  86046. * Affects texture coordinates data to this target
  86047. * @param data defines the texture coordinates data to use
  86048. */
  86049. setUVs(data: Nullable<FloatArray>): void;
  86050. /**
  86051. * Gets the texture coordinates data stored in this target
  86052. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  86053. */
  86054. getUVs(): Nullable<FloatArray>;
  86055. /**
  86056. * Serializes the current target into a Serialization object
  86057. * @returns the serialized object
  86058. */
  86059. serialize(): any;
  86060. /**
  86061. * Returns the string "MorphTarget"
  86062. * @returns "MorphTarget"
  86063. */
  86064. getClassName(): string;
  86065. /**
  86066. * Creates a new target from serialized data
  86067. * @param serializationObject defines the serialized data to use
  86068. * @returns a new MorphTarget
  86069. */
  86070. static Parse(serializationObject: any): MorphTarget;
  86071. /**
  86072. * Creates a MorphTarget from mesh data
  86073. * @param mesh defines the source mesh
  86074. * @param name defines the name to use for the new target
  86075. * @param influence defines the influence to attach to the target
  86076. * @returns a new MorphTarget
  86077. */
  86078. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  86079. }
  86080. }
  86081. declare module BABYLON {
  86082. /**
  86083. * This class is used to deform meshes using morphing between different targets
  86084. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  86085. */
  86086. export class MorphTargetManager {
  86087. private _targets;
  86088. private _targetInfluenceChangedObservers;
  86089. private _targetDataLayoutChangedObservers;
  86090. private _activeTargets;
  86091. private _scene;
  86092. private _influences;
  86093. private _supportsNormals;
  86094. private _supportsTangents;
  86095. private _supportsUVs;
  86096. private _vertexCount;
  86097. private _uniqueId;
  86098. private _tempInfluences;
  86099. /**
  86100. * Gets or sets a boolean indicating if normals must be morphed
  86101. */
  86102. enableNormalMorphing: boolean;
  86103. /**
  86104. * Gets or sets a boolean indicating if tangents must be morphed
  86105. */
  86106. enableTangentMorphing: boolean;
  86107. /**
  86108. * Gets or sets a boolean indicating if UV must be morphed
  86109. */
  86110. enableUVMorphing: boolean;
  86111. /**
  86112. * Creates a new MorphTargetManager
  86113. * @param scene defines the current scene
  86114. */
  86115. constructor(scene?: Nullable<Scene>);
  86116. /**
  86117. * Gets the unique ID of this manager
  86118. */
  86119. readonly uniqueId: number;
  86120. /**
  86121. * Gets the number of vertices handled by this manager
  86122. */
  86123. readonly vertexCount: number;
  86124. /**
  86125. * Gets a boolean indicating if this manager supports morphing of normals
  86126. */
  86127. readonly supportsNormals: boolean;
  86128. /**
  86129. * Gets a boolean indicating if this manager supports morphing of tangents
  86130. */
  86131. readonly supportsTangents: boolean;
  86132. /**
  86133. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  86134. */
  86135. readonly supportsUVs: boolean;
  86136. /**
  86137. * Gets the number of targets stored in this manager
  86138. */
  86139. readonly numTargets: number;
  86140. /**
  86141. * Gets the number of influencers (ie. the number of targets with influences > 0)
  86142. */
  86143. readonly numInfluencers: number;
  86144. /**
  86145. * Gets the list of influences (one per target)
  86146. */
  86147. readonly influences: Float32Array;
  86148. /**
  86149. * Gets the active target at specified index. An active target is a target with an influence > 0
  86150. * @param index defines the index to check
  86151. * @returns the requested target
  86152. */
  86153. getActiveTarget(index: number): MorphTarget;
  86154. /**
  86155. * Gets the target at specified index
  86156. * @param index defines the index to check
  86157. * @returns the requested target
  86158. */
  86159. getTarget(index: number): MorphTarget;
  86160. /**
  86161. * Add a new target to this manager
  86162. * @param target defines the target to add
  86163. */
  86164. addTarget(target: MorphTarget): void;
  86165. /**
  86166. * Removes a target from the manager
  86167. * @param target defines the target to remove
  86168. */
  86169. removeTarget(target: MorphTarget): void;
  86170. /**
  86171. * Serializes the current manager into a Serialization object
  86172. * @returns the serialized object
  86173. */
  86174. serialize(): any;
  86175. private _syncActiveTargets;
  86176. /**
  86177. * Syncrhonize the targets with all the meshes using this morph target manager
  86178. */
  86179. synchronize(): void;
  86180. /**
  86181. * Creates a new MorphTargetManager from serialized data
  86182. * @param serializationObject defines the serialized data
  86183. * @param scene defines the hosting scene
  86184. * @returns the new MorphTargetManager
  86185. */
  86186. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  86187. }
  86188. }
  86189. declare module BABYLON {
  86190. /**
  86191. * Class used to represent a specific level of detail of a mesh
  86192. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  86193. */
  86194. export class MeshLODLevel {
  86195. /** Defines the distance where this level should star being displayed */
  86196. distance: number;
  86197. /** Defines the mesh to use to render this level */
  86198. mesh: Nullable<Mesh>;
  86199. /**
  86200. * Creates a new LOD level
  86201. * @param distance defines the distance where this level should star being displayed
  86202. * @param mesh defines the mesh to use to render this level
  86203. */
  86204. constructor(
  86205. /** Defines the distance where this level should star being displayed */
  86206. distance: number,
  86207. /** Defines the mesh to use to render this level */
  86208. mesh: Nullable<Mesh>);
  86209. }
  86210. }
  86211. declare module BABYLON {
  86212. /**
  86213. * Mesh representing the gorund
  86214. */
  86215. export class GroundMesh extends Mesh {
  86216. /** If octree should be generated */
  86217. generateOctree: boolean;
  86218. private _heightQuads;
  86219. /** @hidden */
  86220. _subdivisionsX: number;
  86221. /** @hidden */
  86222. _subdivisionsY: number;
  86223. /** @hidden */
  86224. _width: number;
  86225. /** @hidden */
  86226. _height: number;
  86227. /** @hidden */
  86228. _minX: number;
  86229. /** @hidden */
  86230. _maxX: number;
  86231. /** @hidden */
  86232. _minZ: number;
  86233. /** @hidden */
  86234. _maxZ: number;
  86235. constructor(name: string, scene: Scene);
  86236. /**
  86237. * "GroundMesh"
  86238. * @returns "GroundMesh"
  86239. */
  86240. getClassName(): string;
  86241. /**
  86242. * The minimum of x and y subdivisions
  86243. */
  86244. readonly subdivisions: number;
  86245. /**
  86246. * X subdivisions
  86247. */
  86248. readonly subdivisionsX: number;
  86249. /**
  86250. * Y subdivisions
  86251. */
  86252. readonly subdivisionsY: number;
  86253. /**
  86254. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  86255. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  86256. * @param chunksCount the number of subdivisions for x and y
  86257. * @param octreeBlocksSize (Default: 32)
  86258. */
  86259. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  86260. /**
  86261. * Returns a height (y) value in the Worl system :
  86262. * the ground altitude at the coordinates (x, z) expressed in the World system.
  86263. * @param x x coordinate
  86264. * @param z z coordinate
  86265. * @returns the ground y position if (x, z) are outside the ground surface.
  86266. */
  86267. getHeightAtCoordinates(x: number, z: number): number;
  86268. /**
  86269. * Returns a normalized vector (Vector3) orthogonal to the ground
  86270. * at the ground coordinates (x, z) expressed in the World system.
  86271. * @param x x coordinate
  86272. * @param z z coordinate
  86273. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  86274. */
  86275. getNormalAtCoordinates(x: number, z: number): Vector3;
  86276. /**
  86277. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  86278. * at the ground coordinates (x, z) expressed in the World system.
  86279. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  86280. * @param x x coordinate
  86281. * @param z z coordinate
  86282. * @param ref vector to store the result
  86283. * @returns the GroundMesh.
  86284. */
  86285. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  86286. /**
  86287. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  86288. * if the ground has been updated.
  86289. * This can be used in the render loop.
  86290. * @returns the GroundMesh.
  86291. */
  86292. updateCoordinateHeights(): GroundMesh;
  86293. private _getFacetAt;
  86294. private _initHeightQuads;
  86295. private _computeHeightQuads;
  86296. /**
  86297. * Serializes this ground mesh
  86298. * @param serializationObject object to write serialization to
  86299. */
  86300. serialize(serializationObject: any): void;
  86301. /**
  86302. * Parses a serialized ground mesh
  86303. * @param parsedMesh the serialized mesh
  86304. * @param scene the scene to create the ground mesh in
  86305. * @returns the created ground mesh
  86306. */
  86307. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  86308. }
  86309. }
  86310. declare module BABYLON {
  86311. /**
  86312. * Interface for Physics-Joint data
  86313. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86314. */
  86315. export interface PhysicsJointData {
  86316. /**
  86317. * The main pivot of the joint
  86318. */
  86319. mainPivot?: Vector3;
  86320. /**
  86321. * The connected pivot of the joint
  86322. */
  86323. connectedPivot?: Vector3;
  86324. /**
  86325. * The main axis of the joint
  86326. */
  86327. mainAxis?: Vector3;
  86328. /**
  86329. * The connected axis of the joint
  86330. */
  86331. connectedAxis?: Vector3;
  86332. /**
  86333. * The collision of the joint
  86334. */
  86335. collision?: boolean;
  86336. /**
  86337. * Native Oimo/Cannon/Energy data
  86338. */
  86339. nativeParams?: any;
  86340. }
  86341. /**
  86342. * This is a holder class for the physics joint created by the physics plugin
  86343. * It holds a set of functions to control the underlying joint
  86344. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86345. */
  86346. export class PhysicsJoint {
  86347. /**
  86348. * The type of the physics joint
  86349. */
  86350. type: number;
  86351. /**
  86352. * The data for the physics joint
  86353. */
  86354. jointData: PhysicsJointData;
  86355. private _physicsJoint;
  86356. protected _physicsPlugin: IPhysicsEnginePlugin;
  86357. /**
  86358. * Initializes the physics joint
  86359. * @param type The type of the physics joint
  86360. * @param jointData The data for the physics joint
  86361. */
  86362. constructor(
  86363. /**
  86364. * The type of the physics joint
  86365. */
  86366. type: number,
  86367. /**
  86368. * The data for the physics joint
  86369. */
  86370. jointData: PhysicsJointData);
  86371. /**
  86372. * Gets the physics joint
  86373. */
  86374. /**
  86375. * Sets the physics joint
  86376. */
  86377. physicsJoint: any;
  86378. /**
  86379. * Sets the physics plugin
  86380. */
  86381. physicsPlugin: IPhysicsEnginePlugin;
  86382. /**
  86383. * Execute a function that is physics-plugin specific.
  86384. * @param {Function} func the function that will be executed.
  86385. * It accepts two parameters: the physics world and the physics joint
  86386. */
  86387. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  86388. /**
  86389. * Distance-Joint type
  86390. */
  86391. static DistanceJoint: number;
  86392. /**
  86393. * Hinge-Joint type
  86394. */
  86395. static HingeJoint: number;
  86396. /**
  86397. * Ball-and-Socket joint type
  86398. */
  86399. static BallAndSocketJoint: number;
  86400. /**
  86401. * Wheel-Joint type
  86402. */
  86403. static WheelJoint: number;
  86404. /**
  86405. * Slider-Joint type
  86406. */
  86407. static SliderJoint: number;
  86408. /**
  86409. * Prismatic-Joint type
  86410. */
  86411. static PrismaticJoint: number;
  86412. /**
  86413. * Universal-Joint type
  86414. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  86415. */
  86416. static UniversalJoint: number;
  86417. /**
  86418. * Hinge-Joint 2 type
  86419. */
  86420. static Hinge2Joint: number;
  86421. /**
  86422. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  86423. */
  86424. static PointToPointJoint: number;
  86425. /**
  86426. * Spring-Joint type
  86427. */
  86428. static SpringJoint: number;
  86429. /**
  86430. * Lock-Joint type
  86431. */
  86432. static LockJoint: number;
  86433. }
  86434. /**
  86435. * A class representing a physics distance joint
  86436. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86437. */
  86438. export class DistanceJoint extends PhysicsJoint {
  86439. /**
  86440. *
  86441. * @param jointData The data for the Distance-Joint
  86442. */
  86443. constructor(jointData: DistanceJointData);
  86444. /**
  86445. * Update the predefined distance.
  86446. * @param maxDistance The maximum preferred distance
  86447. * @param minDistance The minimum preferred distance
  86448. */
  86449. updateDistance(maxDistance: number, minDistance?: number): void;
  86450. }
  86451. /**
  86452. * Represents a Motor-Enabled Joint
  86453. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86454. */
  86455. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  86456. /**
  86457. * Initializes the Motor-Enabled Joint
  86458. * @param type The type of the joint
  86459. * @param jointData The physica joint data for the joint
  86460. */
  86461. constructor(type: number, jointData: PhysicsJointData);
  86462. /**
  86463. * Set the motor values.
  86464. * Attention, this function is plugin specific. Engines won't react 100% the same.
  86465. * @param force the force to apply
  86466. * @param maxForce max force for this motor.
  86467. */
  86468. setMotor(force?: number, maxForce?: number): void;
  86469. /**
  86470. * Set the motor's limits.
  86471. * Attention, this function is plugin specific. Engines won't react 100% the same.
  86472. * @param upperLimit The upper limit of the motor
  86473. * @param lowerLimit The lower limit of the motor
  86474. */
  86475. setLimit(upperLimit: number, lowerLimit?: number): void;
  86476. }
  86477. /**
  86478. * This class represents a single physics Hinge-Joint
  86479. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86480. */
  86481. export class HingeJoint extends MotorEnabledJoint {
  86482. /**
  86483. * Initializes the Hinge-Joint
  86484. * @param jointData The joint data for the Hinge-Joint
  86485. */
  86486. constructor(jointData: PhysicsJointData);
  86487. /**
  86488. * Set the motor values.
  86489. * Attention, this function is plugin specific. Engines won't react 100% the same.
  86490. * @param {number} force the force to apply
  86491. * @param {number} maxForce max force for this motor.
  86492. */
  86493. setMotor(force?: number, maxForce?: number): void;
  86494. /**
  86495. * Set the motor's limits.
  86496. * Attention, this function is plugin specific. Engines won't react 100% the same.
  86497. * @param upperLimit The upper limit of the motor
  86498. * @param lowerLimit The lower limit of the motor
  86499. */
  86500. setLimit(upperLimit: number, lowerLimit?: number): void;
  86501. }
  86502. /**
  86503. * This class represents a dual hinge physics joint (same as wheel joint)
  86504. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86505. */
  86506. export class Hinge2Joint extends MotorEnabledJoint {
  86507. /**
  86508. * Initializes the Hinge2-Joint
  86509. * @param jointData The joint data for the Hinge2-Joint
  86510. */
  86511. constructor(jointData: PhysicsJointData);
  86512. /**
  86513. * Set the motor values.
  86514. * Attention, this function is plugin specific. Engines won't react 100% the same.
  86515. * @param {number} targetSpeed the speed the motor is to reach
  86516. * @param {number} maxForce max force for this motor.
  86517. * @param {motorIndex} the motor's index, 0 or 1.
  86518. */
  86519. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  86520. /**
  86521. * Set the motor limits.
  86522. * Attention, this function is plugin specific. Engines won't react 100% the same.
  86523. * @param {number} upperLimit the upper limit
  86524. * @param {number} lowerLimit lower limit
  86525. * @param {motorIndex} the motor's index, 0 or 1.
  86526. */
  86527. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  86528. }
  86529. /**
  86530. * Interface for a motor enabled joint
  86531. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86532. */
  86533. export interface IMotorEnabledJoint {
  86534. /**
  86535. * Physics joint
  86536. */
  86537. physicsJoint: any;
  86538. /**
  86539. * Sets the motor of the motor-enabled joint
  86540. * @param force The force of the motor
  86541. * @param maxForce The maximum force of the motor
  86542. * @param motorIndex The index of the motor
  86543. */
  86544. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  86545. /**
  86546. * Sets the limit of the motor
  86547. * @param upperLimit The upper limit of the motor
  86548. * @param lowerLimit The lower limit of the motor
  86549. * @param motorIndex The index of the motor
  86550. */
  86551. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  86552. }
  86553. /**
  86554. * Joint data for a Distance-Joint
  86555. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86556. */
  86557. export interface DistanceJointData extends PhysicsJointData {
  86558. /**
  86559. * Max distance the 2 joint objects can be apart
  86560. */
  86561. maxDistance: number;
  86562. }
  86563. /**
  86564. * Joint data from a spring joint
  86565. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86566. */
  86567. export interface SpringJointData extends PhysicsJointData {
  86568. /**
  86569. * Length of the spring
  86570. */
  86571. length: number;
  86572. /**
  86573. * Stiffness of the spring
  86574. */
  86575. stiffness: number;
  86576. /**
  86577. * Damping of the spring
  86578. */
  86579. damping: number;
  86580. /** this callback will be called when applying the force to the impostors. */
  86581. forceApplicationCallback: () => void;
  86582. }
  86583. }
  86584. declare module BABYLON {
  86585. /**
  86586. * Holds the data for the raycast result
  86587. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86588. */
  86589. export class PhysicsRaycastResult {
  86590. private _hasHit;
  86591. private _hitDistance;
  86592. private _hitNormalWorld;
  86593. private _hitPointWorld;
  86594. private _rayFromWorld;
  86595. private _rayToWorld;
  86596. /**
  86597. * Gets if there was a hit
  86598. */
  86599. readonly hasHit: boolean;
  86600. /**
  86601. * Gets the distance from the hit
  86602. */
  86603. readonly hitDistance: number;
  86604. /**
  86605. * Gets the hit normal/direction in the world
  86606. */
  86607. readonly hitNormalWorld: Vector3;
  86608. /**
  86609. * Gets the hit point in the world
  86610. */
  86611. readonly hitPointWorld: Vector3;
  86612. /**
  86613. * Gets the ray "start point" of the ray in the world
  86614. */
  86615. readonly rayFromWorld: Vector3;
  86616. /**
  86617. * Gets the ray "end point" of the ray in the world
  86618. */
  86619. readonly rayToWorld: Vector3;
  86620. /**
  86621. * Sets the hit data (normal & point in world space)
  86622. * @param hitNormalWorld defines the normal in world space
  86623. * @param hitPointWorld defines the point in world space
  86624. */
  86625. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  86626. /**
  86627. * Sets the distance from the start point to the hit point
  86628. * @param distance
  86629. */
  86630. setHitDistance(distance: number): void;
  86631. /**
  86632. * Calculates the distance manually
  86633. */
  86634. calculateHitDistance(): void;
  86635. /**
  86636. * Resets all the values to default
  86637. * @param from The from point on world space
  86638. * @param to The to point on world space
  86639. */
  86640. reset(from?: Vector3, to?: Vector3): void;
  86641. }
  86642. /**
  86643. * Interface for the size containing width and height
  86644. */
  86645. interface IXYZ {
  86646. /**
  86647. * X
  86648. */
  86649. x: number;
  86650. /**
  86651. * Y
  86652. */
  86653. y: number;
  86654. /**
  86655. * Z
  86656. */
  86657. z: number;
  86658. }
  86659. }
  86660. declare module BABYLON {
  86661. /**
  86662. * Interface used to describe a physics joint
  86663. */
  86664. export interface PhysicsImpostorJoint {
  86665. /** Defines the main impostor to which the joint is linked */
  86666. mainImpostor: PhysicsImpostor;
  86667. /** Defines the impostor that is connected to the main impostor using this joint */
  86668. connectedImpostor: PhysicsImpostor;
  86669. /** Defines the joint itself */
  86670. joint: PhysicsJoint;
  86671. }
  86672. /** @hidden */
  86673. export interface IPhysicsEnginePlugin {
  86674. world: any;
  86675. name: string;
  86676. setGravity(gravity: Vector3): void;
  86677. setTimeStep(timeStep: number): void;
  86678. getTimeStep(): number;
  86679. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  86680. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  86681. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  86682. generatePhysicsBody(impostor: PhysicsImpostor): void;
  86683. removePhysicsBody(impostor: PhysicsImpostor): void;
  86684. generateJoint(joint: PhysicsImpostorJoint): void;
  86685. removeJoint(joint: PhysicsImpostorJoint): void;
  86686. isSupported(): boolean;
  86687. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  86688. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  86689. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  86690. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  86691. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  86692. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  86693. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  86694. getBodyMass(impostor: PhysicsImpostor): number;
  86695. getBodyFriction(impostor: PhysicsImpostor): number;
  86696. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  86697. getBodyRestitution(impostor: PhysicsImpostor): number;
  86698. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  86699. getBodyPressure?(impostor: PhysicsImpostor): number;
  86700. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  86701. getBodyStiffness?(impostor: PhysicsImpostor): number;
  86702. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  86703. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  86704. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  86705. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  86706. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  86707. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  86708. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  86709. sleepBody(impostor: PhysicsImpostor): void;
  86710. wakeUpBody(impostor: PhysicsImpostor): void;
  86711. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  86712. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  86713. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  86714. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  86715. getRadius(impostor: PhysicsImpostor): number;
  86716. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  86717. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  86718. dispose(): void;
  86719. }
  86720. /**
  86721. * Interface used to define a physics engine
  86722. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  86723. */
  86724. export interface IPhysicsEngine {
  86725. /**
  86726. * Gets the gravity vector used by the simulation
  86727. */
  86728. gravity: Vector3;
  86729. /**
  86730. * Sets the gravity vector used by the simulation
  86731. * @param gravity defines the gravity vector to use
  86732. */
  86733. setGravity(gravity: Vector3): void;
  86734. /**
  86735. * Set the time step of the physics engine.
  86736. * Default is 1/60.
  86737. * To slow it down, enter 1/600 for example.
  86738. * To speed it up, 1/30
  86739. * @param newTimeStep the new timestep to apply to this world.
  86740. */
  86741. setTimeStep(newTimeStep: number): void;
  86742. /**
  86743. * Get the time step of the physics engine.
  86744. * @returns the current time step
  86745. */
  86746. getTimeStep(): number;
  86747. /**
  86748. * Release all resources
  86749. */
  86750. dispose(): void;
  86751. /**
  86752. * Gets the name of the current physics plugin
  86753. * @returns the name of the plugin
  86754. */
  86755. getPhysicsPluginName(): string;
  86756. /**
  86757. * Adding a new impostor for the impostor tracking.
  86758. * This will be done by the impostor itself.
  86759. * @param impostor the impostor to add
  86760. */
  86761. addImpostor(impostor: PhysicsImpostor): void;
  86762. /**
  86763. * Remove an impostor from the engine.
  86764. * This impostor and its mesh will not longer be updated by the physics engine.
  86765. * @param impostor the impostor to remove
  86766. */
  86767. removeImpostor(impostor: PhysicsImpostor): void;
  86768. /**
  86769. * Add a joint to the physics engine
  86770. * @param mainImpostor defines the main impostor to which the joint is added.
  86771. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  86772. * @param joint defines the joint that will connect both impostors.
  86773. */
  86774. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  86775. /**
  86776. * Removes a joint from the simulation
  86777. * @param mainImpostor defines the impostor used with the joint
  86778. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  86779. * @param joint defines the joint to remove
  86780. */
  86781. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  86782. /**
  86783. * Gets the current plugin used to run the simulation
  86784. * @returns current plugin
  86785. */
  86786. getPhysicsPlugin(): IPhysicsEnginePlugin;
  86787. /**
  86788. * Gets the list of physic impostors
  86789. * @returns an array of PhysicsImpostor
  86790. */
  86791. getImpostors(): Array<PhysicsImpostor>;
  86792. /**
  86793. * Gets the impostor for a physics enabled object
  86794. * @param object defines the object impersonated by the impostor
  86795. * @returns the PhysicsImpostor or null if not found
  86796. */
  86797. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  86798. /**
  86799. * Gets the impostor for a physics body object
  86800. * @param body defines physics body used by the impostor
  86801. * @returns the PhysicsImpostor or null if not found
  86802. */
  86803. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  86804. /**
  86805. * Does a raycast in the physics world
  86806. * @param from when should the ray start?
  86807. * @param to when should the ray end?
  86808. * @returns PhysicsRaycastResult
  86809. */
  86810. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  86811. /**
  86812. * Called by the scene. No need to call it.
  86813. * @param delta defines the timespam between frames
  86814. */
  86815. _step(delta: number): void;
  86816. }
  86817. }
  86818. declare module BABYLON {
  86819. /**
  86820. * The interface for the physics imposter parameters
  86821. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86822. */
  86823. export interface PhysicsImpostorParameters {
  86824. /**
  86825. * The mass of the physics imposter
  86826. */
  86827. mass: number;
  86828. /**
  86829. * The friction of the physics imposter
  86830. */
  86831. friction?: number;
  86832. /**
  86833. * The coefficient of restitution of the physics imposter
  86834. */
  86835. restitution?: number;
  86836. /**
  86837. * The native options of the physics imposter
  86838. */
  86839. nativeOptions?: any;
  86840. /**
  86841. * Specifies if the parent should be ignored
  86842. */
  86843. ignoreParent?: boolean;
  86844. /**
  86845. * Specifies if bi-directional transformations should be disabled
  86846. */
  86847. disableBidirectionalTransformation?: boolean;
  86848. /**
  86849. * The pressure inside the physics imposter, soft object only
  86850. */
  86851. pressure?: number;
  86852. /**
  86853. * The stiffness the physics imposter, soft object only
  86854. */
  86855. stiffness?: number;
  86856. /**
  86857. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  86858. */
  86859. velocityIterations?: number;
  86860. /**
  86861. * The number of iterations used in maintaining consistent vertex positions, soft object only
  86862. */
  86863. positionIterations?: number;
  86864. /**
  86865. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  86866. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  86867. * Add to fix multiple points
  86868. */
  86869. fixedPoints?: number;
  86870. /**
  86871. * The collision margin around a soft object
  86872. */
  86873. margin?: number;
  86874. /**
  86875. * The collision margin around a soft object
  86876. */
  86877. damping?: number;
  86878. /**
  86879. * The path for a rope based on an extrusion
  86880. */
  86881. path?: any;
  86882. /**
  86883. * The shape of an extrusion used for a rope based on an extrusion
  86884. */
  86885. shape?: any;
  86886. }
  86887. /**
  86888. * Interface for a physics-enabled object
  86889. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86890. */
  86891. export interface IPhysicsEnabledObject {
  86892. /**
  86893. * The position of the physics-enabled object
  86894. */
  86895. position: Vector3;
  86896. /**
  86897. * The rotation of the physics-enabled object
  86898. */
  86899. rotationQuaternion: Nullable<Quaternion>;
  86900. /**
  86901. * The scale of the physics-enabled object
  86902. */
  86903. scaling: Vector3;
  86904. /**
  86905. * The rotation of the physics-enabled object
  86906. */
  86907. rotation?: Vector3;
  86908. /**
  86909. * The parent of the physics-enabled object
  86910. */
  86911. parent?: any;
  86912. /**
  86913. * The bounding info of the physics-enabled object
  86914. * @returns The bounding info of the physics-enabled object
  86915. */
  86916. getBoundingInfo(): BoundingInfo;
  86917. /**
  86918. * Computes the world matrix
  86919. * @param force Specifies if the world matrix should be computed by force
  86920. * @returns A world matrix
  86921. */
  86922. computeWorldMatrix(force: boolean): Matrix;
  86923. /**
  86924. * Gets the world matrix
  86925. * @returns A world matrix
  86926. */
  86927. getWorldMatrix?(): Matrix;
  86928. /**
  86929. * Gets the child meshes
  86930. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  86931. * @returns An array of abstract meshes
  86932. */
  86933. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  86934. /**
  86935. * Gets the vertex data
  86936. * @param kind The type of vertex data
  86937. * @returns A nullable array of numbers, or a float32 array
  86938. */
  86939. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  86940. /**
  86941. * Gets the indices from the mesh
  86942. * @returns A nullable array of index arrays
  86943. */
  86944. getIndices?(): Nullable<IndicesArray>;
  86945. /**
  86946. * Gets the scene from the mesh
  86947. * @returns the indices array or null
  86948. */
  86949. getScene?(): Scene;
  86950. /**
  86951. * Gets the absolute position from the mesh
  86952. * @returns the absolute position
  86953. */
  86954. getAbsolutePosition(): Vector3;
  86955. /**
  86956. * Gets the absolute pivot point from the mesh
  86957. * @returns the absolute pivot point
  86958. */
  86959. getAbsolutePivotPoint(): Vector3;
  86960. /**
  86961. * Rotates the mesh
  86962. * @param axis The axis of rotation
  86963. * @param amount The amount of rotation
  86964. * @param space The space of the rotation
  86965. * @returns The rotation transform node
  86966. */
  86967. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  86968. /**
  86969. * Translates the mesh
  86970. * @param axis The axis of translation
  86971. * @param distance The distance of translation
  86972. * @param space The space of the translation
  86973. * @returns The transform node
  86974. */
  86975. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  86976. /**
  86977. * Sets the absolute position of the mesh
  86978. * @param absolutePosition The absolute position of the mesh
  86979. * @returns The transform node
  86980. */
  86981. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  86982. /**
  86983. * Gets the class name of the mesh
  86984. * @returns The class name
  86985. */
  86986. getClassName(): string;
  86987. }
  86988. /**
  86989. * Represents a physics imposter
  86990. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  86991. */
  86992. export class PhysicsImpostor {
  86993. /**
  86994. * The physics-enabled object used as the physics imposter
  86995. */
  86996. object: IPhysicsEnabledObject;
  86997. /**
  86998. * The type of the physics imposter
  86999. */
  87000. type: number;
  87001. private _options;
  87002. private _scene?;
  87003. /**
  87004. * The default object size of the imposter
  87005. */
  87006. static DEFAULT_OBJECT_SIZE: Vector3;
  87007. /**
  87008. * The identity quaternion of the imposter
  87009. */
  87010. static IDENTITY_QUATERNION: Quaternion;
  87011. /** @hidden */
  87012. _pluginData: any;
  87013. private _physicsEngine;
  87014. private _physicsBody;
  87015. private _bodyUpdateRequired;
  87016. private _onBeforePhysicsStepCallbacks;
  87017. private _onAfterPhysicsStepCallbacks;
  87018. /** @hidden */
  87019. _onPhysicsCollideCallbacks: Array<{
  87020. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  87021. otherImpostors: Array<PhysicsImpostor>;
  87022. }>;
  87023. private _deltaPosition;
  87024. private _deltaRotation;
  87025. private _deltaRotationConjugated;
  87026. /** @hidden */
  87027. _isFromLine: boolean;
  87028. private _parent;
  87029. private _isDisposed;
  87030. private static _tmpVecs;
  87031. private static _tmpQuat;
  87032. /**
  87033. * Specifies if the physics imposter is disposed
  87034. */
  87035. readonly isDisposed: boolean;
  87036. /**
  87037. * Gets the mass of the physics imposter
  87038. */
  87039. mass: number;
  87040. /**
  87041. * Gets the coefficient of friction
  87042. */
  87043. /**
  87044. * Sets the coefficient of friction
  87045. */
  87046. friction: number;
  87047. /**
  87048. * Gets the coefficient of restitution
  87049. */
  87050. /**
  87051. * Sets the coefficient of restitution
  87052. */
  87053. restitution: number;
  87054. /**
  87055. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  87056. */
  87057. /**
  87058. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  87059. */
  87060. pressure: number;
  87061. /**
  87062. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  87063. */
  87064. /**
  87065. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  87066. */
  87067. stiffness: number;
  87068. /**
  87069. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  87070. */
  87071. /**
  87072. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  87073. */
  87074. velocityIterations: number;
  87075. /**
  87076. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  87077. */
  87078. /**
  87079. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  87080. */
  87081. positionIterations: number;
  87082. /**
  87083. * The unique id of the physics imposter
  87084. * set by the physics engine when adding this impostor to the array
  87085. */
  87086. uniqueId: number;
  87087. /**
  87088. * @hidden
  87089. */
  87090. soft: boolean;
  87091. /**
  87092. * @hidden
  87093. */
  87094. segments: number;
  87095. private _joints;
  87096. /**
  87097. * Initializes the physics imposter
  87098. * @param object The physics-enabled object used as the physics imposter
  87099. * @param type The type of the physics imposter
  87100. * @param _options The options for the physics imposter
  87101. * @param _scene The Babylon scene
  87102. */
  87103. constructor(
  87104. /**
  87105. * The physics-enabled object used as the physics imposter
  87106. */
  87107. object: IPhysicsEnabledObject,
  87108. /**
  87109. * The type of the physics imposter
  87110. */
  87111. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  87112. /**
  87113. * This function will completly initialize this impostor.
  87114. * It will create a new body - but only if this mesh has no parent.
  87115. * If it has, this impostor will not be used other than to define the impostor
  87116. * of the child mesh.
  87117. * @hidden
  87118. */
  87119. _init(): void;
  87120. private _getPhysicsParent;
  87121. /**
  87122. * Should a new body be generated.
  87123. * @returns boolean specifying if body initialization is required
  87124. */
  87125. isBodyInitRequired(): boolean;
  87126. /**
  87127. * Sets the updated scaling
  87128. * @param updated Specifies if the scaling is updated
  87129. */
  87130. setScalingUpdated(): void;
  87131. /**
  87132. * Force a regeneration of this or the parent's impostor's body.
  87133. * Use under cautious - This will remove all joints already implemented.
  87134. */
  87135. forceUpdate(): void;
  87136. /**
  87137. * Gets the body that holds this impostor. Either its own, or its parent.
  87138. */
  87139. /**
  87140. * Set the physics body. Used mainly by the physics engine/plugin
  87141. */
  87142. physicsBody: any;
  87143. /**
  87144. * Get the parent of the physics imposter
  87145. * @returns Physics imposter or null
  87146. */
  87147. /**
  87148. * Sets the parent of the physics imposter
  87149. */
  87150. parent: Nullable<PhysicsImpostor>;
  87151. /**
  87152. * Resets the update flags
  87153. */
  87154. resetUpdateFlags(): void;
  87155. /**
  87156. * Gets the object extend size
  87157. * @returns the object extend size
  87158. */
  87159. getObjectExtendSize(): Vector3;
  87160. /**
  87161. * Gets the object center
  87162. * @returns The object center
  87163. */
  87164. getObjectCenter(): Vector3;
  87165. /**
  87166. * Get a specific parametes from the options parameter
  87167. * @param paramName The object parameter name
  87168. * @returns The object parameter
  87169. */
  87170. getParam(paramName: string): any;
  87171. /**
  87172. * Sets a specific parameter in the options given to the physics plugin
  87173. * @param paramName The parameter name
  87174. * @param value The value of the parameter
  87175. */
  87176. setParam(paramName: string, value: number): void;
  87177. /**
  87178. * Specifically change the body's mass option. Won't recreate the physics body object
  87179. * @param mass The mass of the physics imposter
  87180. */
  87181. setMass(mass: number): void;
  87182. /**
  87183. * Gets the linear velocity
  87184. * @returns linear velocity or null
  87185. */
  87186. getLinearVelocity(): Nullable<Vector3>;
  87187. /**
  87188. * Sets the linear velocity
  87189. * @param velocity linear velocity or null
  87190. */
  87191. setLinearVelocity(velocity: Nullable<Vector3>): void;
  87192. /**
  87193. * Gets the angular velocity
  87194. * @returns angular velocity or null
  87195. */
  87196. getAngularVelocity(): Nullable<Vector3>;
  87197. /**
  87198. * Sets the angular velocity
  87199. * @param velocity The velocity or null
  87200. */
  87201. setAngularVelocity(velocity: Nullable<Vector3>): void;
  87202. /**
  87203. * Execute a function with the physics plugin native code
  87204. * Provide a function the will have two variables - the world object and the physics body object
  87205. * @param func The function to execute with the physics plugin native code
  87206. */
  87207. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  87208. /**
  87209. * Register a function that will be executed before the physics world is stepping forward
  87210. * @param func The function to execute before the physics world is stepped forward
  87211. */
  87212. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  87213. /**
  87214. * Unregister a function that will be executed before the physics world is stepping forward
  87215. * @param func The function to execute before the physics world is stepped forward
  87216. */
  87217. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  87218. /**
  87219. * Register a function that will be executed after the physics step
  87220. * @param func The function to execute after physics step
  87221. */
  87222. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  87223. /**
  87224. * Unregisters a function that will be executed after the physics step
  87225. * @param func The function to execute after physics step
  87226. */
  87227. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  87228. /**
  87229. * register a function that will be executed when this impostor collides against a different body
  87230. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  87231. * @param func Callback that is executed on collision
  87232. */
  87233. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  87234. /**
  87235. * Unregisters the physics imposter on contact
  87236. * @param collideAgainst The physics object to collide against
  87237. * @param func Callback to execute on collision
  87238. */
  87239. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  87240. private _tmpQuat;
  87241. private _tmpQuat2;
  87242. /**
  87243. * Get the parent rotation
  87244. * @returns The parent rotation
  87245. */
  87246. getParentsRotation(): Quaternion;
  87247. /**
  87248. * this function is executed by the physics engine.
  87249. */
  87250. beforeStep: () => void;
  87251. /**
  87252. * this function is executed by the physics engine
  87253. */
  87254. afterStep: () => void;
  87255. /**
  87256. * Legacy collision detection event support
  87257. */
  87258. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  87259. /**
  87260. * event and body object due to cannon's event-based architecture.
  87261. */
  87262. onCollide: (e: {
  87263. body: any;
  87264. }) => void;
  87265. /**
  87266. * Apply a force
  87267. * @param force The force to apply
  87268. * @param contactPoint The contact point for the force
  87269. * @returns The physics imposter
  87270. */
  87271. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  87272. /**
  87273. * Apply an impulse
  87274. * @param force The impulse force
  87275. * @param contactPoint The contact point for the impulse force
  87276. * @returns The physics imposter
  87277. */
  87278. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  87279. /**
  87280. * A help function to create a joint
  87281. * @param otherImpostor A physics imposter used to create a joint
  87282. * @param jointType The type of joint
  87283. * @param jointData The data for the joint
  87284. * @returns The physics imposter
  87285. */
  87286. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  87287. /**
  87288. * Add a joint to this impostor with a different impostor
  87289. * @param otherImpostor A physics imposter used to add a joint
  87290. * @param joint The joint to add
  87291. * @returns The physics imposter
  87292. */
  87293. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  87294. /**
  87295. * Add an anchor to a cloth impostor
  87296. * @param otherImpostor rigid impostor to anchor to
  87297. * @param width ratio across width from 0 to 1
  87298. * @param height ratio up height from 0 to 1
  87299. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  87300. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  87301. * @returns impostor the soft imposter
  87302. */
  87303. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  87304. /**
  87305. * Add a hook to a rope impostor
  87306. * @param otherImpostor rigid impostor to anchor to
  87307. * @param length ratio across rope from 0 to 1
  87308. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  87309. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  87310. * @returns impostor the rope imposter
  87311. */
  87312. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  87313. /**
  87314. * Will keep this body still, in a sleep mode.
  87315. * @returns the physics imposter
  87316. */
  87317. sleep(): PhysicsImpostor;
  87318. /**
  87319. * Wake the body up.
  87320. * @returns The physics imposter
  87321. */
  87322. wakeUp(): PhysicsImpostor;
  87323. /**
  87324. * Clones the physics imposter
  87325. * @param newObject The physics imposter clones to this physics-enabled object
  87326. * @returns A nullable physics imposter
  87327. */
  87328. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  87329. /**
  87330. * Disposes the physics imposter
  87331. */
  87332. dispose(): void;
  87333. /**
  87334. * Sets the delta position
  87335. * @param position The delta position amount
  87336. */
  87337. setDeltaPosition(position: Vector3): void;
  87338. /**
  87339. * Sets the delta rotation
  87340. * @param rotation The delta rotation amount
  87341. */
  87342. setDeltaRotation(rotation: Quaternion): void;
  87343. /**
  87344. * Gets the box size of the physics imposter and stores the result in the input parameter
  87345. * @param result Stores the box size
  87346. * @returns The physics imposter
  87347. */
  87348. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  87349. /**
  87350. * Gets the radius of the physics imposter
  87351. * @returns Radius of the physics imposter
  87352. */
  87353. getRadius(): number;
  87354. /**
  87355. * Sync a bone with this impostor
  87356. * @param bone The bone to sync to the impostor.
  87357. * @param boneMesh The mesh that the bone is influencing.
  87358. * @param jointPivot The pivot of the joint / bone in local space.
  87359. * @param distToJoint Optional distance from the impostor to the joint.
  87360. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  87361. */
  87362. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  87363. /**
  87364. * Sync impostor to a bone
  87365. * @param bone The bone that the impostor will be synced to.
  87366. * @param boneMesh The mesh that the bone is influencing.
  87367. * @param jointPivot The pivot of the joint / bone in local space.
  87368. * @param distToJoint Optional distance from the impostor to the joint.
  87369. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  87370. * @param boneAxis Optional vector3 axis the bone is aligned with
  87371. */
  87372. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  87373. /**
  87374. * No-Imposter type
  87375. */
  87376. static NoImpostor: number;
  87377. /**
  87378. * Sphere-Imposter type
  87379. */
  87380. static SphereImpostor: number;
  87381. /**
  87382. * Box-Imposter type
  87383. */
  87384. static BoxImpostor: number;
  87385. /**
  87386. * Plane-Imposter type
  87387. */
  87388. static PlaneImpostor: number;
  87389. /**
  87390. * Mesh-imposter type
  87391. */
  87392. static MeshImpostor: number;
  87393. /**
  87394. * Capsule-Impostor type (Ammo.js plugin only)
  87395. */
  87396. static CapsuleImpostor: number;
  87397. /**
  87398. * Cylinder-Imposter type
  87399. */
  87400. static CylinderImpostor: number;
  87401. /**
  87402. * Particle-Imposter type
  87403. */
  87404. static ParticleImpostor: number;
  87405. /**
  87406. * Heightmap-Imposter type
  87407. */
  87408. static HeightmapImpostor: number;
  87409. /**
  87410. * ConvexHull-Impostor type (Ammo.js plugin only)
  87411. */
  87412. static ConvexHullImpostor: number;
  87413. /**
  87414. * Rope-Imposter type
  87415. */
  87416. static RopeImpostor: number;
  87417. /**
  87418. * Cloth-Imposter type
  87419. */
  87420. static ClothImpostor: number;
  87421. /**
  87422. * Softbody-Imposter type
  87423. */
  87424. static SoftbodyImpostor: number;
  87425. }
  87426. }
  87427. declare module BABYLON {
  87428. /**
  87429. * @hidden
  87430. **/
  87431. export class _CreationDataStorage {
  87432. closePath?: boolean;
  87433. closeArray?: boolean;
  87434. idx: number[];
  87435. dashSize: number;
  87436. gapSize: number;
  87437. path3D: Path3D;
  87438. pathArray: Vector3[][];
  87439. arc: number;
  87440. radius: number;
  87441. cap: number;
  87442. tessellation: number;
  87443. }
  87444. /**
  87445. * @hidden
  87446. **/
  87447. class _InstanceDataStorage {
  87448. visibleInstances: any;
  87449. batchCache: _InstancesBatch;
  87450. instancesBufferSize: number;
  87451. instancesBuffer: Nullable<Buffer>;
  87452. instancesData: Float32Array;
  87453. overridenInstanceCount: number;
  87454. isFrozen: boolean;
  87455. previousBatch: Nullable<_InstancesBatch>;
  87456. hardwareInstancedRendering: boolean;
  87457. sideOrientation: number;
  87458. }
  87459. /**
  87460. * @hidden
  87461. **/
  87462. export class _InstancesBatch {
  87463. mustReturn: boolean;
  87464. visibleInstances: Nullable<InstancedMesh[]>[];
  87465. renderSelf: boolean[];
  87466. hardwareInstancedRendering: boolean[];
  87467. }
  87468. /**
  87469. * Class used to represent renderable models
  87470. */
  87471. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  87472. /**
  87473. * Mesh side orientation : usually the external or front surface
  87474. */
  87475. static readonly FRONTSIDE: number;
  87476. /**
  87477. * Mesh side orientation : usually the internal or back surface
  87478. */
  87479. static readonly BACKSIDE: number;
  87480. /**
  87481. * Mesh side orientation : both internal and external or front and back surfaces
  87482. */
  87483. static readonly DOUBLESIDE: number;
  87484. /**
  87485. * Mesh side orientation : by default, `FRONTSIDE`
  87486. */
  87487. static readonly DEFAULTSIDE: number;
  87488. /**
  87489. * Mesh cap setting : no cap
  87490. */
  87491. static readonly NO_CAP: number;
  87492. /**
  87493. * Mesh cap setting : one cap at the beginning of the mesh
  87494. */
  87495. static readonly CAP_START: number;
  87496. /**
  87497. * Mesh cap setting : one cap at the end of the mesh
  87498. */
  87499. static readonly CAP_END: number;
  87500. /**
  87501. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  87502. */
  87503. static readonly CAP_ALL: number;
  87504. /**
  87505. * Mesh pattern setting : no flip or rotate
  87506. */
  87507. static readonly NO_FLIP: number;
  87508. /**
  87509. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  87510. */
  87511. static readonly FLIP_TILE: number;
  87512. /**
  87513. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  87514. */
  87515. static readonly ROTATE_TILE: number;
  87516. /**
  87517. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  87518. */
  87519. static readonly FLIP_ROW: number;
  87520. /**
  87521. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  87522. */
  87523. static readonly ROTATE_ROW: number;
  87524. /**
  87525. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  87526. */
  87527. static readonly FLIP_N_ROTATE_TILE: number;
  87528. /**
  87529. * Mesh pattern setting : rotate pattern and rotate
  87530. */
  87531. static readonly FLIP_N_ROTATE_ROW: number;
  87532. /**
  87533. * Mesh tile positioning : part tiles same on left/right or top/bottom
  87534. */
  87535. static readonly CENTER: number;
  87536. /**
  87537. * Mesh tile positioning : part tiles on left
  87538. */
  87539. static readonly LEFT: number;
  87540. /**
  87541. * Mesh tile positioning : part tiles on right
  87542. */
  87543. static readonly RIGHT: number;
  87544. /**
  87545. * Mesh tile positioning : part tiles on top
  87546. */
  87547. static readonly TOP: number;
  87548. /**
  87549. * Mesh tile positioning : part tiles on bottom
  87550. */
  87551. static readonly BOTTOM: number;
  87552. /**
  87553. * Gets the default side orientation.
  87554. * @param orientation the orientation to value to attempt to get
  87555. * @returns the default orientation
  87556. * @hidden
  87557. */
  87558. static _GetDefaultSideOrientation(orientation?: number): number;
  87559. private _internalMeshDataInfo;
  87560. /**
  87561. * An event triggered before rendering the mesh
  87562. */
  87563. readonly onBeforeRenderObservable: Observable<Mesh>;
  87564. /**
  87565. * An event triggered before binding the mesh
  87566. */
  87567. readonly onBeforeBindObservable: Observable<Mesh>;
  87568. /**
  87569. * An event triggered after rendering the mesh
  87570. */
  87571. readonly onAfterRenderObservable: Observable<Mesh>;
  87572. /**
  87573. * An event triggered before drawing the mesh
  87574. */
  87575. readonly onBeforeDrawObservable: Observable<Mesh>;
  87576. private _onBeforeDrawObserver;
  87577. /**
  87578. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  87579. */
  87580. onBeforeDraw: () => void;
  87581. /**
  87582. * Gets the delay loading state of the mesh (when delay loading is turned on)
  87583. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  87584. */
  87585. delayLoadState: number;
  87586. /**
  87587. * Gets the list of instances created from this mesh
  87588. * it is not supposed to be modified manually.
  87589. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  87590. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  87591. */
  87592. instances: InstancedMesh[];
  87593. /**
  87594. * Gets the file containing delay loading data for this mesh
  87595. */
  87596. delayLoadingFile: string;
  87597. /** @hidden */
  87598. _binaryInfo: any;
  87599. /**
  87600. * User defined function used to change how LOD level selection is done
  87601. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  87602. */
  87603. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  87604. /**
  87605. * Gets or sets the morph target manager
  87606. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  87607. */
  87608. morphTargetManager: Nullable<MorphTargetManager>;
  87609. /** @hidden */
  87610. _creationDataStorage: Nullable<_CreationDataStorage>;
  87611. /** @hidden */
  87612. _geometry: Nullable<Geometry>;
  87613. /** @hidden */
  87614. _delayInfo: Array<string>;
  87615. /** @hidden */
  87616. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  87617. /** @hidden */
  87618. _instanceDataStorage: _InstanceDataStorage;
  87619. private _effectiveMaterial;
  87620. /** @hidden */
  87621. _shouldGenerateFlatShading: boolean;
  87622. /** @hidden */
  87623. _originalBuilderSideOrientation: number;
  87624. /**
  87625. * Use this property to change the original side orientation defined at construction time
  87626. */
  87627. overrideMaterialSideOrientation: Nullable<number>;
  87628. /**
  87629. * Gets the source mesh (the one used to clone this one from)
  87630. */
  87631. readonly source: Nullable<Mesh>;
  87632. /**
  87633. * Gets or sets a boolean indicating that this mesh does not use index buffer
  87634. */
  87635. isUnIndexed: boolean;
  87636. /**
  87637. * @constructor
  87638. * @param name The value used by scene.getMeshByName() to do a lookup.
  87639. * @param scene The scene to add this mesh to.
  87640. * @param parent The parent of this mesh, if it has one
  87641. * @param source An optional Mesh from which geometry is shared, cloned.
  87642. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  87643. * When false, achieved by calling a clone(), also passing False.
  87644. * This will make creation of children, recursive.
  87645. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  87646. */
  87647. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  87648. /**
  87649. * Gets the class name
  87650. * @returns the string "Mesh".
  87651. */
  87652. getClassName(): string;
  87653. /** @hidden */
  87654. readonly _isMesh: boolean;
  87655. /**
  87656. * Returns a description of this mesh
  87657. * @param fullDetails define if full details about this mesh must be used
  87658. * @returns a descriptive string representing this mesh
  87659. */
  87660. toString(fullDetails?: boolean): string;
  87661. /** @hidden */
  87662. _unBindEffect(): void;
  87663. /**
  87664. * Gets a boolean indicating if this mesh has LOD
  87665. */
  87666. readonly hasLODLevels: boolean;
  87667. /**
  87668. * Gets the list of MeshLODLevel associated with the current mesh
  87669. * @returns an array of MeshLODLevel
  87670. */
  87671. getLODLevels(): MeshLODLevel[];
  87672. private _sortLODLevels;
  87673. /**
  87674. * Add a mesh as LOD level triggered at the given distance.
  87675. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  87676. * @param distance The distance from the center of the object to show this level
  87677. * @param mesh The mesh to be added as LOD level (can be null)
  87678. * @return This mesh (for chaining)
  87679. */
  87680. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  87681. /**
  87682. * Returns the LOD level mesh at the passed distance or null if not found.
  87683. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  87684. * @param distance The distance from the center of the object to show this level
  87685. * @returns a Mesh or `null`
  87686. */
  87687. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  87688. /**
  87689. * Remove a mesh from the LOD array
  87690. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  87691. * @param mesh defines the mesh to be removed
  87692. * @return This mesh (for chaining)
  87693. */
  87694. removeLODLevel(mesh: Mesh): Mesh;
  87695. /**
  87696. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  87697. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  87698. * @param camera defines the camera to use to compute distance
  87699. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  87700. * @return This mesh (for chaining)
  87701. */
  87702. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  87703. /**
  87704. * Gets the mesh internal Geometry object
  87705. */
  87706. readonly geometry: Nullable<Geometry>;
  87707. /**
  87708. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  87709. * @returns the total number of vertices
  87710. */
  87711. getTotalVertices(): number;
  87712. /**
  87713. * Returns the content of an associated vertex buffer
  87714. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  87715. * - VertexBuffer.PositionKind
  87716. * - VertexBuffer.UVKind
  87717. * - VertexBuffer.UV2Kind
  87718. * - VertexBuffer.UV3Kind
  87719. * - VertexBuffer.UV4Kind
  87720. * - VertexBuffer.UV5Kind
  87721. * - VertexBuffer.UV6Kind
  87722. * - VertexBuffer.ColorKind
  87723. * - VertexBuffer.MatricesIndicesKind
  87724. * - VertexBuffer.MatricesIndicesExtraKind
  87725. * - VertexBuffer.MatricesWeightsKind
  87726. * - VertexBuffer.MatricesWeightsExtraKind
  87727. * @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
  87728. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  87729. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  87730. */
  87731. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  87732. /**
  87733. * Returns the mesh VertexBuffer object from the requested `kind`
  87734. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  87735. * - VertexBuffer.PositionKind
  87736. * - VertexBuffer.NormalKind
  87737. * - VertexBuffer.UVKind
  87738. * - VertexBuffer.UV2Kind
  87739. * - VertexBuffer.UV3Kind
  87740. * - VertexBuffer.UV4Kind
  87741. * - VertexBuffer.UV5Kind
  87742. * - VertexBuffer.UV6Kind
  87743. * - VertexBuffer.ColorKind
  87744. * - VertexBuffer.MatricesIndicesKind
  87745. * - VertexBuffer.MatricesIndicesExtraKind
  87746. * - VertexBuffer.MatricesWeightsKind
  87747. * - VertexBuffer.MatricesWeightsExtraKind
  87748. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  87749. */
  87750. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  87751. /**
  87752. * Tests if a specific vertex buffer is associated with this mesh
  87753. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  87754. * - VertexBuffer.PositionKind
  87755. * - VertexBuffer.NormalKind
  87756. * - VertexBuffer.UVKind
  87757. * - VertexBuffer.UV2Kind
  87758. * - VertexBuffer.UV3Kind
  87759. * - VertexBuffer.UV4Kind
  87760. * - VertexBuffer.UV5Kind
  87761. * - VertexBuffer.UV6Kind
  87762. * - VertexBuffer.ColorKind
  87763. * - VertexBuffer.MatricesIndicesKind
  87764. * - VertexBuffer.MatricesIndicesExtraKind
  87765. * - VertexBuffer.MatricesWeightsKind
  87766. * - VertexBuffer.MatricesWeightsExtraKind
  87767. * @returns a boolean
  87768. */
  87769. isVerticesDataPresent(kind: string): boolean;
  87770. /**
  87771. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  87772. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  87773. * - VertexBuffer.PositionKind
  87774. * - VertexBuffer.UVKind
  87775. * - VertexBuffer.UV2Kind
  87776. * - VertexBuffer.UV3Kind
  87777. * - VertexBuffer.UV4Kind
  87778. * - VertexBuffer.UV5Kind
  87779. * - VertexBuffer.UV6Kind
  87780. * - VertexBuffer.ColorKind
  87781. * - VertexBuffer.MatricesIndicesKind
  87782. * - VertexBuffer.MatricesIndicesExtraKind
  87783. * - VertexBuffer.MatricesWeightsKind
  87784. * - VertexBuffer.MatricesWeightsExtraKind
  87785. * @returns a boolean
  87786. */
  87787. isVertexBufferUpdatable(kind: string): boolean;
  87788. /**
  87789. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  87790. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  87791. * - VertexBuffer.PositionKind
  87792. * - VertexBuffer.NormalKind
  87793. * - VertexBuffer.UVKind
  87794. * - VertexBuffer.UV2Kind
  87795. * - VertexBuffer.UV3Kind
  87796. * - VertexBuffer.UV4Kind
  87797. * - VertexBuffer.UV5Kind
  87798. * - VertexBuffer.UV6Kind
  87799. * - VertexBuffer.ColorKind
  87800. * - VertexBuffer.MatricesIndicesKind
  87801. * - VertexBuffer.MatricesIndicesExtraKind
  87802. * - VertexBuffer.MatricesWeightsKind
  87803. * - VertexBuffer.MatricesWeightsExtraKind
  87804. * @returns an array of strings
  87805. */
  87806. getVerticesDataKinds(): string[];
  87807. /**
  87808. * Returns a positive integer : the total number of indices in this mesh geometry.
  87809. * @returns the numner of indices or zero if the mesh has no geometry.
  87810. */
  87811. getTotalIndices(): number;
  87812. /**
  87813. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  87814. * @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.
  87815. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  87816. * @returns the indices array or an empty array if the mesh has no geometry
  87817. */
  87818. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  87819. readonly isBlocked: boolean;
  87820. /**
  87821. * Determine if the current mesh is ready to be rendered
  87822. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  87823. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  87824. * @returns true if all associated assets are ready (material, textures, shaders)
  87825. */
  87826. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  87827. /**
  87828. * 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.
  87829. */
  87830. readonly areNormalsFrozen: boolean;
  87831. /**
  87832. * 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.
  87833. * @returns the current mesh
  87834. */
  87835. freezeNormals(): Mesh;
  87836. /**
  87837. * 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
  87838. * @returns the current mesh
  87839. */
  87840. unfreezeNormals(): Mesh;
  87841. /**
  87842. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  87843. */
  87844. overridenInstanceCount: number;
  87845. /** @hidden */
  87846. _preActivate(): Mesh;
  87847. /** @hidden */
  87848. _preActivateForIntermediateRendering(renderId: number): Mesh;
  87849. /** @hidden */
  87850. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  87851. /**
  87852. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  87853. * This means the mesh underlying bounding box and sphere are recomputed.
  87854. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  87855. * @returns the current mesh
  87856. */
  87857. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  87858. /** @hidden */
  87859. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  87860. /**
  87861. * This function will subdivide the mesh into multiple submeshes
  87862. * @param count defines the expected number of submeshes
  87863. */
  87864. subdivide(count: number): void;
  87865. /**
  87866. * Copy a FloatArray into a specific associated vertex buffer
  87867. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  87868. * - VertexBuffer.PositionKind
  87869. * - VertexBuffer.UVKind
  87870. * - VertexBuffer.UV2Kind
  87871. * - VertexBuffer.UV3Kind
  87872. * - VertexBuffer.UV4Kind
  87873. * - VertexBuffer.UV5Kind
  87874. * - VertexBuffer.UV6Kind
  87875. * - VertexBuffer.ColorKind
  87876. * - VertexBuffer.MatricesIndicesKind
  87877. * - VertexBuffer.MatricesIndicesExtraKind
  87878. * - VertexBuffer.MatricesWeightsKind
  87879. * - VertexBuffer.MatricesWeightsExtraKind
  87880. * @param data defines the data source
  87881. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  87882. * @param stride defines the data stride size (can be null)
  87883. * @returns the current mesh
  87884. */
  87885. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): Mesh;
  87886. /**
  87887. * Flags an associated vertex buffer as updatable
  87888. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  87889. * - VertexBuffer.PositionKind
  87890. * - VertexBuffer.UVKind
  87891. * - VertexBuffer.UV2Kind
  87892. * - VertexBuffer.UV3Kind
  87893. * - VertexBuffer.UV4Kind
  87894. * - VertexBuffer.UV5Kind
  87895. * - VertexBuffer.UV6Kind
  87896. * - VertexBuffer.ColorKind
  87897. * - VertexBuffer.MatricesIndicesKind
  87898. * - VertexBuffer.MatricesIndicesExtraKind
  87899. * - VertexBuffer.MatricesWeightsKind
  87900. * - VertexBuffer.MatricesWeightsExtraKind
  87901. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  87902. */
  87903. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  87904. /**
  87905. * Sets the mesh global Vertex Buffer
  87906. * @param buffer defines the buffer to use
  87907. * @returns the current mesh
  87908. */
  87909. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  87910. /**
  87911. * Update a specific associated vertex buffer
  87912. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  87913. * - VertexBuffer.PositionKind
  87914. * - VertexBuffer.UVKind
  87915. * - VertexBuffer.UV2Kind
  87916. * - VertexBuffer.UV3Kind
  87917. * - VertexBuffer.UV4Kind
  87918. * - VertexBuffer.UV5Kind
  87919. * - VertexBuffer.UV6Kind
  87920. * - VertexBuffer.ColorKind
  87921. * - VertexBuffer.MatricesIndicesKind
  87922. * - VertexBuffer.MatricesIndicesExtraKind
  87923. * - VertexBuffer.MatricesWeightsKind
  87924. * - VertexBuffer.MatricesWeightsExtraKind
  87925. * @param data defines the data source
  87926. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  87927. * @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)
  87928. * @returns the current mesh
  87929. */
  87930. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  87931. /**
  87932. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  87933. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  87934. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  87935. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  87936. * @returns the current mesh
  87937. */
  87938. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  87939. /**
  87940. * Creates a un-shared specific occurence of the geometry for the mesh.
  87941. * @returns the current mesh
  87942. */
  87943. makeGeometryUnique(): Mesh;
  87944. /**
  87945. * Set the index buffer of this mesh
  87946. * @param indices defines the source data
  87947. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  87948. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  87949. * @returns the current mesh
  87950. */
  87951. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): Mesh;
  87952. /**
  87953. * Update the current index buffer
  87954. * @param indices defines the source data
  87955. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  87956. * @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)
  87957. * @returns the current mesh
  87958. */
  87959. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): Mesh;
  87960. /**
  87961. * Invert the geometry to move from a right handed system to a left handed one.
  87962. * @returns the current mesh
  87963. */
  87964. toLeftHanded(): Mesh;
  87965. /** @hidden */
  87966. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  87967. /** @hidden */
  87968. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  87969. /**
  87970. * Registers for this mesh a javascript function called just before the rendering process
  87971. * @param func defines the function to call before rendering this mesh
  87972. * @returns the current mesh
  87973. */
  87974. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  87975. /**
  87976. * Disposes a previously registered javascript function called before the rendering
  87977. * @param func defines the function to remove
  87978. * @returns the current mesh
  87979. */
  87980. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  87981. /**
  87982. * Registers for this mesh a javascript function called just after the rendering is complete
  87983. * @param func defines the function to call after rendering this mesh
  87984. * @returns the current mesh
  87985. */
  87986. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  87987. /**
  87988. * Disposes a previously registered javascript function called after the rendering.
  87989. * @param func defines the function to remove
  87990. * @returns the current mesh
  87991. */
  87992. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  87993. /** @hidden */
  87994. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  87995. /** @hidden */
  87996. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  87997. /** @hidden */
  87998. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  87999. /** @hidden */
  88000. _rebuild(): void;
  88001. /** @hidden */
  88002. _freeze(): void;
  88003. /** @hidden */
  88004. _unFreeze(): void;
  88005. /**
  88006. * 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
  88007. * @param subMesh defines the subMesh to render
  88008. * @param enableAlphaMode defines if alpha mode can be changed
  88009. * @returns the current mesh
  88010. */
  88011. render(subMesh: SubMesh, enableAlphaMode: boolean): Mesh;
  88012. private _onBeforeDraw;
  88013. /**
  88014. * Renormalize the mesh and patch it up if there are no weights
  88015. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  88016. * However in the case of zero weights then we set just a single influence to 1.
  88017. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  88018. */
  88019. cleanMatrixWeights(): void;
  88020. private normalizeSkinFourWeights;
  88021. private normalizeSkinWeightsAndExtra;
  88022. /**
  88023. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  88024. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  88025. * the user know there was an issue with importing the mesh
  88026. * @returns a validation object with skinned, valid and report string
  88027. */
  88028. validateSkinning(): {
  88029. skinned: boolean;
  88030. valid: boolean;
  88031. report: string;
  88032. };
  88033. /** @hidden */
  88034. _checkDelayState(): Mesh;
  88035. private _queueLoad;
  88036. /**
  88037. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  88038. * A mesh is in the frustum if its bounding box intersects the frustum
  88039. * @param frustumPlanes defines the frustum to test
  88040. * @returns true if the mesh is in the frustum planes
  88041. */
  88042. isInFrustum(frustumPlanes: Plane[]): boolean;
  88043. /**
  88044. * Sets the mesh material by the material or multiMaterial `id` property
  88045. * @param id is a string identifying the material or the multiMaterial
  88046. * @returns the current mesh
  88047. */
  88048. setMaterialByID(id: string): Mesh;
  88049. /**
  88050. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  88051. * @returns an array of IAnimatable
  88052. */
  88053. getAnimatables(): IAnimatable[];
  88054. /**
  88055. * Modifies the mesh geometry according to the passed transformation matrix.
  88056. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  88057. * The mesh normals are modified using the same transformation.
  88058. * Note that, under the hood, this method sets a new VertexBuffer each call.
  88059. * @param transform defines the transform matrix to use
  88060. * @see http://doc.babylonjs.com/resources/baking_transformations
  88061. * @returns the current mesh
  88062. */
  88063. bakeTransformIntoVertices(transform: Matrix): Mesh;
  88064. /**
  88065. * Modifies the mesh geometry according to its own current World Matrix.
  88066. * The mesh World Matrix is then reset.
  88067. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  88068. * Note that, under the hood, this method sets a new VertexBuffer each call.
  88069. * @see http://doc.babylonjs.com/resources/baking_transformations
  88070. * @returns the current mesh
  88071. */
  88072. bakeCurrentTransformIntoVertices(): Mesh;
  88073. /** @hidden */
  88074. readonly _positions: Nullable<Vector3[]>;
  88075. /** @hidden */
  88076. _resetPointsArrayCache(): Mesh;
  88077. /** @hidden */
  88078. _generatePointsArray(): boolean;
  88079. /**
  88080. * Returns a new Mesh object generated from the current mesh properties.
  88081. * This method must not get confused with createInstance()
  88082. * @param name is a string, the name given to the new mesh
  88083. * @param newParent can be any Node object (default `null`)
  88084. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  88085. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  88086. * @returns a new mesh
  88087. */
  88088. clone(name?: string, newParent?: Node, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  88089. /**
  88090. * Releases resources associated with this mesh.
  88091. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  88092. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  88093. */
  88094. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  88095. /**
  88096. * Modifies the mesh geometry according to a displacement map.
  88097. * 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.
  88098. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  88099. * @param url is a string, the URL from the image file is to be downloaded.
  88100. * @param minHeight is the lower limit of the displacement.
  88101. * @param maxHeight is the upper limit of the displacement.
  88102. * @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.
  88103. * @param uvOffset is an optional vector2 used to offset UV.
  88104. * @param uvScale is an optional vector2 used to scale UV.
  88105. * @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.
  88106. * @returns the Mesh.
  88107. */
  88108. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  88109. /**
  88110. * Modifies the mesh geometry according to a displacementMap buffer.
  88111. * 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.
  88112. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  88113. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  88114. * @param heightMapWidth is the width of the buffer image.
  88115. * @param heightMapHeight is the height of the buffer image.
  88116. * @param minHeight is the lower limit of the displacement.
  88117. * @param maxHeight is the upper limit of the displacement.
  88118. * @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.
  88119. * @param uvOffset is an optional vector2 used to offset UV.
  88120. * @param uvScale is an optional vector2 used to scale UV.
  88121. * @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.
  88122. * @returns the Mesh.
  88123. */
  88124. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  88125. /**
  88126. * Modify the mesh to get a flat shading rendering.
  88127. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  88128. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  88129. * @returns current mesh
  88130. */
  88131. convertToFlatShadedMesh(): Mesh;
  88132. /**
  88133. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  88134. * In other words, more vertices, no more indices and a single bigger VBO.
  88135. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  88136. * @returns current mesh
  88137. */
  88138. convertToUnIndexedMesh(): Mesh;
  88139. /**
  88140. * Inverses facet orientations.
  88141. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  88142. * @param flipNormals will also inverts the normals
  88143. * @returns current mesh
  88144. */
  88145. flipFaces(flipNormals?: boolean): Mesh;
  88146. /**
  88147. * Increase the number of facets and hence vertices in a mesh
  88148. * Vertex normals are interpolated from existing vertex normals
  88149. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  88150. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  88151. */
  88152. increaseVertices(numberPerEdge: number): void;
  88153. /**
  88154. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  88155. * This will undo any application of covertToFlatShadedMesh
  88156. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  88157. */
  88158. forceSharedVertices(): void;
  88159. /** @hidden */
  88160. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  88161. /** @hidden */
  88162. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  88163. /**
  88164. * Creates a new InstancedMesh object from the mesh model.
  88165. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  88166. * @param name defines the name of the new instance
  88167. * @returns a new InstancedMesh
  88168. */
  88169. createInstance(name: string): InstancedMesh;
  88170. /**
  88171. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  88172. * After this call, all the mesh instances have the same submeshes than the current mesh.
  88173. * @returns the current mesh
  88174. */
  88175. synchronizeInstances(): Mesh;
  88176. /**
  88177. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  88178. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  88179. * This should be used together with the simplification to avoid disappearing triangles.
  88180. * @param successCallback an optional success callback to be called after the optimization finished.
  88181. * @returns the current mesh
  88182. */
  88183. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  88184. /**
  88185. * Serialize current mesh
  88186. * @param serializationObject defines the object which will receive the serialization data
  88187. */
  88188. serialize(serializationObject: any): void;
  88189. /** @hidden */
  88190. _syncGeometryWithMorphTargetManager(): void;
  88191. /** @hidden */
  88192. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  88193. /**
  88194. * Returns a new Mesh object parsed from the source provided.
  88195. * @param parsedMesh is the source
  88196. * @param scene defines the hosting scene
  88197. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  88198. * @returns a new Mesh
  88199. */
  88200. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  88201. /**
  88202. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  88203. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  88204. * @param name defines the name of the mesh to create
  88205. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  88206. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  88207. * @param closePath creates a seam between the first and the last points of each path of the path array
  88208. * @param offset is taken in account only if the `pathArray` is containing a single path
  88209. * @param scene defines the hosting scene
  88210. * @param updatable defines if the mesh must be flagged as updatable
  88211. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88212. * @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)
  88213. * @returns a new Mesh
  88214. */
  88215. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  88216. /**
  88217. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  88218. * @param name defines the name of the mesh to create
  88219. * @param radius sets the radius size (float) of the polygon (default 0.5)
  88220. * @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
  88221. * @param scene defines the hosting scene
  88222. * @param updatable defines if the mesh must be flagged as updatable
  88223. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88224. * @returns a new Mesh
  88225. */
  88226. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  88227. /**
  88228. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  88229. * @param name defines the name of the mesh to create
  88230. * @param size sets the size (float) of each box side (default 1)
  88231. * @param scene defines the hosting scene
  88232. * @param updatable defines if the mesh must be flagged as updatable
  88233. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88234. * @returns a new Mesh
  88235. */
  88236. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  88237. /**
  88238. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  88239. * @param name defines the name of the mesh to create
  88240. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  88241. * @param diameter sets the diameter size (float) of the sphere (default 1)
  88242. * @param scene defines the hosting scene
  88243. * @param updatable defines if the mesh must be flagged as updatable
  88244. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88245. * @returns a new Mesh
  88246. */
  88247. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  88248. /**
  88249. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  88250. * @param name defines the name of the mesh to create
  88251. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  88252. * @param diameter sets the diameter size (float) of the sphere (default 1)
  88253. * @param scene defines the hosting scene
  88254. * @returns a new Mesh
  88255. */
  88256. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  88257. /**
  88258. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  88259. * @param name defines the name of the mesh to create
  88260. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  88261. * @param diameterTop set the top cap diameter (floats, default 1)
  88262. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  88263. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  88264. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  88265. * @param scene defines the hosting scene
  88266. * @param updatable defines if the mesh must be flagged as updatable
  88267. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88268. * @returns a new Mesh
  88269. */
  88270. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  88271. /**
  88272. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  88273. * @param name defines the name of the mesh to create
  88274. * @param diameter sets the diameter size (float) of the torus (default 1)
  88275. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  88276. * @param tessellation sets the number of torus sides (postive integer, default 16)
  88277. * @param scene defines the hosting scene
  88278. * @param updatable defines if the mesh must be flagged as updatable
  88279. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88280. * @returns a new Mesh
  88281. */
  88282. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  88283. /**
  88284. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  88285. * @param name defines the name of the mesh to create
  88286. * @param radius sets the global radius size (float) of the torus knot (default 2)
  88287. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  88288. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  88289. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  88290. * @param p the number of windings on X axis (positive integers, default 2)
  88291. * @param q the number of windings on Y axis (positive integers, default 3)
  88292. * @param scene defines the hosting scene
  88293. * @param updatable defines if the mesh must be flagged as updatable
  88294. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88295. * @returns a new Mesh
  88296. */
  88297. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  88298. /**
  88299. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  88300. * @param name defines the name of the mesh to create
  88301. * @param points is an array successive Vector3
  88302. * @param scene defines the hosting scene
  88303. * @param updatable defines if the mesh must be flagged as updatable
  88304. * @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).
  88305. * @returns a new Mesh
  88306. */
  88307. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  88308. /**
  88309. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  88310. * @param name defines the name of the mesh to create
  88311. * @param points is an array successive Vector3
  88312. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  88313. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  88314. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  88315. * @param scene defines the hosting scene
  88316. * @param updatable defines if the mesh must be flagged as updatable
  88317. * @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)
  88318. * @returns a new Mesh
  88319. */
  88320. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  88321. /**
  88322. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  88323. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  88324. * 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.
  88325. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  88326. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  88327. * Remember you can only change the shape positions, not their number when updating a polygon.
  88328. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  88329. * @param name defines the name of the mesh to create
  88330. * @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
  88331. * @param scene defines the hosting scene
  88332. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  88333. * @param updatable defines if the mesh must be flagged as updatable
  88334. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88335. * @param earcutInjection can be used to inject your own earcut reference
  88336. * @returns a new Mesh
  88337. */
  88338. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  88339. /**
  88340. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  88341. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  88342. * @param name defines the name of the mesh to create
  88343. * @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
  88344. * @param depth defines the height of extrusion
  88345. * @param scene defines the hosting scene
  88346. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  88347. * @param updatable defines if the mesh must be flagged as updatable
  88348. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88349. * @param earcutInjection can be used to inject your own earcut reference
  88350. * @returns a new Mesh
  88351. */
  88352. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  88353. /**
  88354. * Creates an extruded shape mesh.
  88355. * 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
  88356. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  88357. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  88358. * @param name defines the name of the mesh to create
  88359. * @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
  88360. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  88361. * @param scale is the value to scale the shape
  88362. * @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
  88363. * @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
  88364. * @param scene defines the hosting scene
  88365. * @param updatable defines if the mesh must be flagged as updatable
  88366. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88367. * @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)
  88368. * @returns a new Mesh
  88369. */
  88370. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  88371. /**
  88372. * Creates an custom extruded shape mesh.
  88373. * The custom extrusion is a parametric shape.
  88374. * It has no predefined shape. Its final shape will depend on the input parameters.
  88375. * Please consider using the same method from the MeshBuilder class instead
  88376. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  88377. * @param name defines the name of the mesh to create
  88378. * @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
  88379. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  88380. * @param scaleFunction is a custom Javascript function called on each path point
  88381. * @param rotationFunction is a custom Javascript function called on each path point
  88382. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  88383. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  88384. * @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
  88385. * @param scene defines the hosting scene
  88386. * @param updatable defines if the mesh must be flagged as updatable
  88387. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88388. * @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)
  88389. * @returns a new Mesh
  88390. */
  88391. 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;
  88392. /**
  88393. * Creates lathe mesh.
  88394. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  88395. * Please consider using the same method from the MeshBuilder class instead
  88396. * @param name defines the name of the mesh to create
  88397. * @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
  88398. * @param radius is the radius value of the lathe
  88399. * @param tessellation is the side number of the lathe.
  88400. * @param scene defines the hosting scene
  88401. * @param updatable defines if the mesh must be flagged as updatable
  88402. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88403. * @returns a new Mesh
  88404. */
  88405. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  88406. /**
  88407. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  88408. * @param name defines the name of the mesh to create
  88409. * @param size sets the size (float) of both sides of the plane at once (default 1)
  88410. * @param scene defines the hosting scene
  88411. * @param updatable defines if the mesh must be flagged as updatable
  88412. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88413. * @returns a new Mesh
  88414. */
  88415. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  88416. /**
  88417. * Creates a ground mesh.
  88418. * Please consider using the same method from the MeshBuilder class instead
  88419. * @param name defines the name of the mesh to create
  88420. * @param width set the width of the ground
  88421. * @param height set the height of the ground
  88422. * @param subdivisions sets the number of subdivisions per side
  88423. * @param scene defines the hosting scene
  88424. * @param updatable defines if the mesh must be flagged as updatable
  88425. * @returns a new Mesh
  88426. */
  88427. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  88428. /**
  88429. * Creates a tiled ground mesh.
  88430. * Please consider using the same method from the MeshBuilder class instead
  88431. * @param name defines the name of the mesh to create
  88432. * @param xmin set the ground minimum X coordinate
  88433. * @param zmin set the ground minimum Y coordinate
  88434. * @param xmax set the ground maximum X coordinate
  88435. * @param zmax set the ground maximum Z coordinate
  88436. * @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
  88437. * @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
  88438. * @param scene defines the hosting scene
  88439. * @param updatable defines if the mesh must be flagged as updatable
  88440. * @returns a new Mesh
  88441. */
  88442. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  88443. w: number;
  88444. h: number;
  88445. }, precision: {
  88446. w: number;
  88447. h: number;
  88448. }, scene: Scene, updatable?: boolean): Mesh;
  88449. /**
  88450. * Creates a ground mesh from a height map.
  88451. * Please consider using the same method from the MeshBuilder class instead
  88452. * @see http://doc.babylonjs.com/babylon101/height_map
  88453. * @param name defines the name of the mesh to create
  88454. * @param url sets the URL of the height map image resource
  88455. * @param width set the ground width size
  88456. * @param height set the ground height size
  88457. * @param subdivisions sets the number of subdivision per side
  88458. * @param minHeight is the minimum altitude on the ground
  88459. * @param maxHeight is the maximum altitude on the ground
  88460. * @param scene defines the hosting scene
  88461. * @param updatable defines if the mesh must be flagged as updatable
  88462. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  88463. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  88464. * @returns a new Mesh
  88465. */
  88466. 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;
  88467. /**
  88468. * Creates a tube mesh.
  88469. * The tube is a parametric shape.
  88470. * It has no predefined shape. Its final shape will depend on the input parameters.
  88471. * Please consider using the same method from the MeshBuilder class instead
  88472. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  88473. * @param name defines the name of the mesh to create
  88474. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  88475. * @param radius sets the tube radius size
  88476. * @param tessellation is the number of sides on the tubular surface
  88477. * @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
  88478. * @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
  88479. * @param scene defines the hosting scene
  88480. * @param updatable defines if the mesh must be flagged as updatable
  88481. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  88482. * @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)
  88483. * @returns a new Mesh
  88484. */
  88485. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  88486. (i: number, distance: number): number;
  88487. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  88488. /**
  88489. * Creates a polyhedron mesh.
  88490. * Please consider using the same method from the MeshBuilder class instead.
  88491. * * 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
  88492. * * The parameter `size` (positive float, default 1) sets the polygon size
  88493. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  88494. * * 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`
  88495. * * 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
  88496. * * 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)`)
  88497. * * 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
  88498. * * 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
  88499. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  88500. * * If you create a double-sided mesh, you can choose what parts of 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
  88501. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  88502. * @param name defines the name of the mesh to create
  88503. * @param options defines the options used to create the mesh
  88504. * @param scene defines the hosting scene
  88505. * @returns a new Mesh
  88506. */
  88507. static CreatePolyhedron(name: string, options: {
  88508. type?: number;
  88509. size?: number;
  88510. sizeX?: number;
  88511. sizeY?: number;
  88512. sizeZ?: number;
  88513. custom?: any;
  88514. faceUV?: Vector4[];
  88515. faceColors?: Color4[];
  88516. updatable?: boolean;
  88517. sideOrientation?: number;
  88518. }, scene: Scene): Mesh;
  88519. /**
  88520. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  88521. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  88522. * * 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`)
  88523. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  88524. * * 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
  88525. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  88526. * * If you create a double-sided mesh, you can choose what parts of 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
  88527. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  88528. * @param name defines the name of the mesh
  88529. * @param options defines the options used to create the mesh
  88530. * @param scene defines the hosting scene
  88531. * @returns a new Mesh
  88532. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  88533. */
  88534. static CreateIcoSphere(name: string, options: {
  88535. radius?: number;
  88536. flat?: boolean;
  88537. subdivisions?: number;
  88538. sideOrientation?: number;
  88539. updatable?: boolean;
  88540. }, scene: Scene): Mesh;
  88541. /**
  88542. * Creates a decal mesh.
  88543. * Please consider using the same method from the MeshBuilder class instead.
  88544. * A decal is a mesh usually applied as a model onto the surface of another mesh
  88545. * @param name defines the name of the mesh
  88546. * @param sourceMesh defines the mesh receiving the decal
  88547. * @param position sets the position of the decal in world coordinates
  88548. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  88549. * @param size sets the decal scaling
  88550. * @param angle sets the angle to rotate the decal
  88551. * @returns a new Mesh
  88552. */
  88553. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  88554. /**
  88555. * Prepare internal position array for software CPU skinning
  88556. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  88557. */
  88558. setPositionsForCPUSkinning(): Float32Array;
  88559. /**
  88560. * Prepare internal normal array for software CPU skinning
  88561. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  88562. */
  88563. setNormalsForCPUSkinning(): Float32Array;
  88564. /**
  88565. * Updates the vertex buffer by applying transformation from the bones
  88566. * @param skeleton defines the skeleton to apply to current mesh
  88567. * @returns the current mesh
  88568. */
  88569. applySkeleton(skeleton: Skeleton): Mesh;
  88570. /**
  88571. * 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
  88572. * @param meshes defines the list of meshes to scan
  88573. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  88574. */
  88575. static MinMax(meshes: AbstractMesh[]): {
  88576. min: Vector3;
  88577. max: Vector3;
  88578. };
  88579. /**
  88580. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  88581. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  88582. * @returns a vector3
  88583. */
  88584. static Center(meshesOrMinMaxVector: {
  88585. min: Vector3;
  88586. max: Vector3;
  88587. } | AbstractMesh[]): Vector3;
  88588. /**
  88589. * Merge the array of meshes into a single mesh for performance reasons.
  88590. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  88591. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  88592. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  88593. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  88594. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  88595. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  88596. * @returns a new mesh
  88597. */
  88598. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  88599. /** @hidden */
  88600. addInstance(instance: InstancedMesh): void;
  88601. /** @hidden */
  88602. removeInstance(instance: InstancedMesh): void;
  88603. }
  88604. }
  88605. declare module BABYLON {
  88606. /**
  88607. * This is the base class of all the camera used in the application.
  88608. * @see http://doc.babylonjs.com/features/cameras
  88609. */
  88610. export class Camera extends Node {
  88611. /** @hidden */
  88612. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  88613. /**
  88614. * This is the default projection mode used by the cameras.
  88615. * It helps recreating a feeling of perspective and better appreciate depth.
  88616. * This is the best way to simulate real life cameras.
  88617. */
  88618. static readonly PERSPECTIVE_CAMERA: number;
  88619. /**
  88620. * This helps creating camera with an orthographic mode.
  88621. * 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.
  88622. */
  88623. static readonly ORTHOGRAPHIC_CAMERA: number;
  88624. /**
  88625. * This is the default FOV mode for perspective cameras.
  88626. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  88627. */
  88628. static readonly FOVMODE_VERTICAL_FIXED: number;
  88629. /**
  88630. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  88631. */
  88632. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  88633. /**
  88634. * This specifies ther is no need for a camera rig.
  88635. * Basically only one eye is rendered corresponding to the camera.
  88636. */
  88637. static readonly RIG_MODE_NONE: number;
  88638. /**
  88639. * Simulates a camera Rig with one blue eye and one red eye.
  88640. * This can be use with 3d blue and red glasses.
  88641. */
  88642. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  88643. /**
  88644. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  88645. */
  88646. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  88647. /**
  88648. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  88649. */
  88650. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  88651. /**
  88652. * Defines that both eyes of the camera will be rendered over under each other.
  88653. */
  88654. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  88655. /**
  88656. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  88657. */
  88658. static readonly RIG_MODE_VR: number;
  88659. /**
  88660. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  88661. */
  88662. static readonly RIG_MODE_WEBVR: number;
  88663. /**
  88664. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  88665. */
  88666. static readonly RIG_MODE_CUSTOM: number;
  88667. /**
  88668. * Defines if by default attaching controls should prevent the default javascript event to continue.
  88669. */
  88670. static ForceAttachControlToAlwaysPreventDefault: boolean;
  88671. /**
  88672. * Define the input manager associated with the camera.
  88673. */
  88674. inputs: CameraInputsManager<Camera>;
  88675. /** @hidden */
  88676. _position: Vector3;
  88677. /**
  88678. * Define the current local position of the camera in the scene
  88679. */
  88680. position: Vector3;
  88681. /**
  88682. * The vector the camera should consider as up.
  88683. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  88684. */
  88685. upVector: Vector3;
  88686. /**
  88687. * Define the current limit on the left side for an orthographic camera
  88688. * In scene unit
  88689. */
  88690. orthoLeft: Nullable<number>;
  88691. /**
  88692. * Define the current limit on the right side for an orthographic camera
  88693. * In scene unit
  88694. */
  88695. orthoRight: Nullable<number>;
  88696. /**
  88697. * Define the current limit on the bottom side for an orthographic camera
  88698. * In scene unit
  88699. */
  88700. orthoBottom: Nullable<number>;
  88701. /**
  88702. * Define the current limit on the top side for an orthographic camera
  88703. * In scene unit
  88704. */
  88705. orthoTop: Nullable<number>;
  88706. /**
  88707. * Field Of View is set in Radians. (default is 0.8)
  88708. */
  88709. fov: number;
  88710. /**
  88711. * Define the minimum distance the camera can see from.
  88712. * This is important to note that the depth buffer are not infinite and the closer it starts
  88713. * the more your scene might encounter depth fighting issue.
  88714. */
  88715. minZ: number;
  88716. /**
  88717. * Define the maximum distance the camera can see to.
  88718. * This is important to note that the depth buffer are not infinite and the further it end
  88719. * the more your scene might encounter depth fighting issue.
  88720. */
  88721. maxZ: number;
  88722. /**
  88723. * Define the default inertia of the camera.
  88724. * This helps giving a smooth feeling to the camera movement.
  88725. */
  88726. inertia: number;
  88727. /**
  88728. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  88729. */
  88730. mode: number;
  88731. /**
  88732. * Define wether the camera is intermediate.
  88733. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  88734. */
  88735. isIntermediate: boolean;
  88736. /**
  88737. * Define the viewport of the camera.
  88738. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  88739. */
  88740. viewport: Viewport;
  88741. /**
  88742. * Restricts the camera to viewing objects with the same layerMask.
  88743. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  88744. */
  88745. layerMask: number;
  88746. /**
  88747. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  88748. */
  88749. fovMode: number;
  88750. /**
  88751. * Rig mode of the camera.
  88752. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  88753. * This is normally controlled byt the camera themselves as internal use.
  88754. */
  88755. cameraRigMode: number;
  88756. /**
  88757. * Defines the distance between both "eyes" in case of a RIG
  88758. */
  88759. interaxialDistance: number;
  88760. /**
  88761. * Defines if stereoscopic rendering is done side by side or over under.
  88762. */
  88763. isStereoscopicSideBySide: boolean;
  88764. /**
  88765. * 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
  88766. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  88767. * else in the scene. (Eg. security camera)
  88768. *
  88769. * 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)
  88770. */
  88771. customRenderTargets: RenderTargetTexture[];
  88772. /**
  88773. * When set, the camera will render to this render target instead of the default canvas
  88774. *
  88775. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  88776. */
  88777. outputRenderTarget: Nullable<RenderTargetTexture>;
  88778. /**
  88779. * Observable triggered when the camera view matrix has changed.
  88780. */
  88781. onViewMatrixChangedObservable: Observable<Camera>;
  88782. /**
  88783. * Observable triggered when the camera Projection matrix has changed.
  88784. */
  88785. onProjectionMatrixChangedObservable: Observable<Camera>;
  88786. /**
  88787. * Observable triggered when the inputs have been processed.
  88788. */
  88789. onAfterCheckInputsObservable: Observable<Camera>;
  88790. /**
  88791. * Observable triggered when reset has been called and applied to the camera.
  88792. */
  88793. onRestoreStateObservable: Observable<Camera>;
  88794. /** @hidden */
  88795. _cameraRigParams: any;
  88796. /** @hidden */
  88797. _rigCameras: Camera[];
  88798. /** @hidden */
  88799. _rigPostProcess: Nullable<PostProcess>;
  88800. protected _webvrViewMatrix: Matrix;
  88801. /** @hidden */
  88802. _skipRendering: boolean;
  88803. /** @hidden */
  88804. _projectionMatrix: Matrix;
  88805. /** @hidden */
  88806. _postProcesses: Nullable<PostProcess>[];
  88807. /** @hidden */
  88808. _activeMeshes: SmartArray<AbstractMesh>;
  88809. protected _globalPosition: Vector3;
  88810. /** @hidden */
  88811. _computedViewMatrix: Matrix;
  88812. private _doNotComputeProjectionMatrix;
  88813. private _transformMatrix;
  88814. private _frustumPlanes;
  88815. private _refreshFrustumPlanes;
  88816. private _storedFov;
  88817. private _stateStored;
  88818. /**
  88819. * Instantiates a new camera object.
  88820. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  88821. * @see http://doc.babylonjs.com/features/cameras
  88822. * @param name Defines the name of the camera in the scene
  88823. * @param position Defines the position of the camera
  88824. * @param scene Defines the scene the camera belongs too
  88825. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  88826. */
  88827. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  88828. /**
  88829. * Store current camera state (fov, position, etc..)
  88830. * @returns the camera
  88831. */
  88832. storeState(): Camera;
  88833. /**
  88834. * Restores the camera state values if it has been stored. You must call storeState() first
  88835. */
  88836. protected _restoreStateValues(): boolean;
  88837. /**
  88838. * Restored camera state. You must call storeState() first.
  88839. * @returns true if restored and false otherwise
  88840. */
  88841. restoreState(): boolean;
  88842. /**
  88843. * Gets the class name of the camera.
  88844. * @returns the class name
  88845. */
  88846. getClassName(): string;
  88847. /** @hidden */
  88848. readonly _isCamera: boolean;
  88849. /**
  88850. * Gets a string representation of the camera useful for debug purpose.
  88851. * @param fullDetails Defines that a more verboe level of logging is required
  88852. * @returns the string representation
  88853. */
  88854. toString(fullDetails?: boolean): string;
  88855. /**
  88856. * Gets the current world space position of the camera.
  88857. */
  88858. readonly globalPosition: Vector3;
  88859. /**
  88860. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  88861. * @returns the active meshe list
  88862. */
  88863. getActiveMeshes(): SmartArray<AbstractMesh>;
  88864. /**
  88865. * Check wether a mesh is part of the current active mesh list of the camera
  88866. * @param mesh Defines the mesh to check
  88867. * @returns true if active, false otherwise
  88868. */
  88869. isActiveMesh(mesh: Mesh): boolean;
  88870. /**
  88871. * Is this camera ready to be used/rendered
  88872. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  88873. * @return true if the camera is ready
  88874. */
  88875. isReady(completeCheck?: boolean): boolean;
  88876. /** @hidden */
  88877. _initCache(): void;
  88878. /** @hidden */
  88879. _updateCache(ignoreParentClass?: boolean): void;
  88880. /** @hidden */
  88881. _isSynchronized(): boolean;
  88882. /** @hidden */
  88883. _isSynchronizedViewMatrix(): boolean;
  88884. /** @hidden */
  88885. _isSynchronizedProjectionMatrix(): boolean;
  88886. /**
  88887. * Attach the input controls to a specific dom element to get the input from.
  88888. * @param element Defines the element the controls should be listened from
  88889. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  88890. */
  88891. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  88892. /**
  88893. * Detach the current controls from the specified dom element.
  88894. * @param element Defines the element to stop listening the inputs from
  88895. */
  88896. detachControl(element: HTMLElement): void;
  88897. /**
  88898. * Update the camera state according to the different inputs gathered during the frame.
  88899. */
  88900. update(): void;
  88901. /** @hidden */
  88902. _checkInputs(): void;
  88903. /** @hidden */
  88904. readonly rigCameras: Camera[];
  88905. /**
  88906. * Gets the post process used by the rig cameras
  88907. */
  88908. readonly rigPostProcess: Nullable<PostProcess>;
  88909. /**
  88910. * Internal, gets the first post proces.
  88911. * @returns the first post process to be run on this camera.
  88912. */
  88913. _getFirstPostProcess(): Nullable<PostProcess>;
  88914. private _cascadePostProcessesToRigCams;
  88915. /**
  88916. * Attach a post process to the camera.
  88917. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  88918. * @param postProcess The post process to attach to the camera
  88919. * @param insertAt The position of the post process in case several of them are in use in the scene
  88920. * @returns the position the post process has been inserted at
  88921. */
  88922. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  88923. /**
  88924. * Detach a post process to the camera.
  88925. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  88926. * @param postProcess The post process to detach from the camera
  88927. */
  88928. detachPostProcess(postProcess: PostProcess): void;
  88929. /**
  88930. * Gets the current world matrix of the camera
  88931. */
  88932. getWorldMatrix(): Matrix;
  88933. /** @hidden */
  88934. _getViewMatrix(): Matrix;
  88935. /**
  88936. * Gets the current view matrix of the camera.
  88937. * @param force forces the camera to recompute the matrix without looking at the cached state
  88938. * @returns the view matrix
  88939. */
  88940. getViewMatrix(force?: boolean): Matrix;
  88941. /**
  88942. * Freeze the projection matrix.
  88943. * It will prevent the cache check of the camera projection compute and can speed up perf
  88944. * if no parameter of the camera are meant to change
  88945. * @param projection Defines manually a projection if necessary
  88946. */
  88947. freezeProjectionMatrix(projection?: Matrix): void;
  88948. /**
  88949. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  88950. */
  88951. unfreezeProjectionMatrix(): void;
  88952. /**
  88953. * Gets the current projection matrix of the camera.
  88954. * @param force forces the camera to recompute the matrix without looking at the cached state
  88955. * @returns the projection matrix
  88956. */
  88957. getProjectionMatrix(force?: boolean): Matrix;
  88958. /**
  88959. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  88960. * @returns a Matrix
  88961. */
  88962. getTransformationMatrix(): Matrix;
  88963. private _updateFrustumPlanes;
  88964. /**
  88965. * Checks if a cullable object (mesh...) is in the camera frustum
  88966. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  88967. * @param target The object to check
  88968. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  88969. * @returns true if the object is in frustum otherwise false
  88970. */
  88971. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  88972. /**
  88973. * Checks if a cullable object (mesh...) is in the camera frustum
  88974. * Unlike isInFrustum this cheks the full bounding box
  88975. * @param target The object to check
  88976. * @returns true if the object is in frustum otherwise false
  88977. */
  88978. isCompletelyInFrustum(target: ICullable): boolean;
  88979. /**
  88980. * Gets a ray in the forward direction from the camera.
  88981. * @param length Defines the length of the ray to create
  88982. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  88983. * @param origin Defines the start point of the ray which defaults to the camera position
  88984. * @returns the forward ray
  88985. */
  88986. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  88987. /**
  88988. * Releases resources associated with this node.
  88989. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  88990. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  88991. */
  88992. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  88993. /** @hidden */
  88994. _isLeftCamera: boolean;
  88995. /**
  88996. * Gets the left camera of a rig setup in case of Rigged Camera
  88997. */
  88998. readonly isLeftCamera: boolean;
  88999. /** @hidden */
  89000. _isRightCamera: boolean;
  89001. /**
  89002. * Gets the right camera of a rig setup in case of Rigged Camera
  89003. */
  89004. readonly isRightCamera: boolean;
  89005. /**
  89006. * Gets the left camera of a rig setup in case of Rigged Camera
  89007. */
  89008. readonly leftCamera: Nullable<FreeCamera>;
  89009. /**
  89010. * Gets the right camera of a rig setup in case of Rigged Camera
  89011. */
  89012. readonly rightCamera: Nullable<FreeCamera>;
  89013. /**
  89014. * Gets the left camera target of a rig setup in case of Rigged Camera
  89015. * @returns the target position
  89016. */
  89017. getLeftTarget(): Nullable<Vector3>;
  89018. /**
  89019. * Gets the right camera target of a rig setup in case of Rigged Camera
  89020. * @returns the target position
  89021. */
  89022. getRightTarget(): Nullable<Vector3>;
  89023. /**
  89024. * @hidden
  89025. */
  89026. setCameraRigMode(mode: number, rigParams: any): void;
  89027. /** @hidden */
  89028. static _setStereoscopicRigMode(camera: Camera): void;
  89029. /** @hidden */
  89030. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  89031. /** @hidden */
  89032. static _setVRRigMode(camera: Camera, rigParams: any): void;
  89033. /** @hidden */
  89034. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  89035. /** @hidden */
  89036. _getVRProjectionMatrix(): Matrix;
  89037. protected _updateCameraRotationMatrix(): void;
  89038. protected _updateWebVRCameraRotationMatrix(): void;
  89039. /**
  89040. * This function MUST be overwritten by the different WebVR cameras available.
  89041. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  89042. * @hidden
  89043. */
  89044. _getWebVRProjectionMatrix(): Matrix;
  89045. /**
  89046. * This function MUST be overwritten by the different WebVR cameras available.
  89047. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  89048. * @hidden
  89049. */
  89050. _getWebVRViewMatrix(): Matrix;
  89051. /** @hidden */
  89052. setCameraRigParameter(name: string, value: any): void;
  89053. /**
  89054. * needs to be overridden by children so sub has required properties to be copied
  89055. * @hidden
  89056. */
  89057. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  89058. /**
  89059. * May need to be overridden by children
  89060. * @hidden
  89061. */
  89062. _updateRigCameras(): void;
  89063. /** @hidden */
  89064. _setupInputs(): void;
  89065. /**
  89066. * Serialiaze the camera setup to a json represention
  89067. * @returns the JSON representation
  89068. */
  89069. serialize(): any;
  89070. /**
  89071. * Clones the current camera.
  89072. * @param name The cloned camera name
  89073. * @returns the cloned camera
  89074. */
  89075. clone(name: string): Camera;
  89076. /**
  89077. * Gets the direction of the camera relative to a given local axis.
  89078. * @param localAxis Defines the reference axis to provide a relative direction.
  89079. * @return the direction
  89080. */
  89081. getDirection(localAxis: Vector3): Vector3;
  89082. /**
  89083. * Gets the direction of the camera relative to a given local axis into a passed vector.
  89084. * @param localAxis Defines the reference axis to provide a relative direction.
  89085. * @param result Defines the vector to store the result in
  89086. */
  89087. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  89088. /**
  89089. * Gets a camera constructor for a given camera type
  89090. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  89091. * @param name The name of the camera the result will be able to instantiate
  89092. * @param scene The scene the result will construct the camera in
  89093. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  89094. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  89095. * @returns a factory method to construc the camera
  89096. */
  89097. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  89098. /**
  89099. * Compute the world matrix of the camera.
  89100. * @returns the camera workd matrix
  89101. */
  89102. computeWorldMatrix(): Matrix;
  89103. /**
  89104. * Parse a JSON and creates the camera from the parsed information
  89105. * @param parsedCamera The JSON to parse
  89106. * @param scene The scene to instantiate the camera in
  89107. * @returns the newly constructed camera
  89108. */
  89109. static Parse(parsedCamera: any, scene: Scene): Camera;
  89110. }
  89111. }
  89112. declare module BABYLON {
  89113. /**
  89114. * Class containing static functions to help procedurally build meshes
  89115. */
  89116. export class DiscBuilder {
  89117. /**
  89118. * Creates a plane polygonal mesh. By default, this is a disc
  89119. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  89120. * * 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
  89121. * * 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
  89122. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  89123. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  89124. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  89125. * @param name defines the name of the mesh
  89126. * @param options defines the options used to create the mesh
  89127. * @param scene defines the hosting scene
  89128. * @returns the plane polygonal mesh
  89129. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  89130. */
  89131. static CreateDisc(name: string, options: {
  89132. radius?: number;
  89133. tessellation?: number;
  89134. arc?: number;
  89135. updatable?: boolean;
  89136. sideOrientation?: number;
  89137. frontUVs?: Vector4;
  89138. backUVs?: Vector4;
  89139. }, scene?: Nullable<Scene>): Mesh;
  89140. }
  89141. }
  89142. declare module BABYLON {
  89143. /**
  89144. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  89145. *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.
  89146. * The SPS is also a particle system. It provides some methods to manage the particles.
  89147. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  89148. *
  89149. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  89150. */
  89151. export class SolidParticleSystem implements IDisposable {
  89152. /**
  89153. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  89154. * Example : var p = SPS.particles[i];
  89155. */
  89156. particles: SolidParticle[];
  89157. /**
  89158. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  89159. */
  89160. nbParticles: number;
  89161. /**
  89162. * If the particles must ever face the camera (default false). Useful for planar particles.
  89163. */
  89164. billboard: boolean;
  89165. /**
  89166. * Recompute normals when adding a shape
  89167. */
  89168. recomputeNormals: boolean;
  89169. /**
  89170. * This a counter ofr your own usage. It's not set by any SPS functions.
  89171. */
  89172. counter: number;
  89173. /**
  89174. * The SPS name. This name is also given to the underlying mesh.
  89175. */
  89176. name: string;
  89177. /**
  89178. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  89179. */
  89180. mesh: Mesh;
  89181. /**
  89182. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  89183. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  89184. */
  89185. vars: any;
  89186. /**
  89187. * This array is populated when the SPS is set as 'pickable'.
  89188. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  89189. * Each element of this array is an object `{idx: int, faceId: int}`.
  89190. * `idx` is the picked particle index in the `SPS.particles` array
  89191. * `faceId` is the picked face index counted within this particle.
  89192. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  89193. */
  89194. pickedParticles: {
  89195. idx: number;
  89196. faceId: number;
  89197. }[];
  89198. /**
  89199. * This array is populated when `enableDepthSort` is set to true.
  89200. * Each element of this array is an instance of the class DepthSortedParticle.
  89201. */
  89202. depthSortedParticles: DepthSortedParticle[];
  89203. /**
  89204. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  89205. * @hidden
  89206. */
  89207. _bSphereOnly: boolean;
  89208. /**
  89209. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  89210. * @hidden
  89211. */
  89212. _bSphereRadiusFactor: number;
  89213. private _scene;
  89214. private _positions;
  89215. private _indices;
  89216. private _normals;
  89217. private _colors;
  89218. private _uvs;
  89219. private _indices32;
  89220. private _positions32;
  89221. private _normals32;
  89222. private _fixedNormal32;
  89223. private _colors32;
  89224. private _uvs32;
  89225. private _index;
  89226. private _updatable;
  89227. private _pickable;
  89228. private _isVisibilityBoxLocked;
  89229. private _alwaysVisible;
  89230. private _depthSort;
  89231. private _shapeCounter;
  89232. private _copy;
  89233. private _color;
  89234. private _computeParticleColor;
  89235. private _computeParticleTexture;
  89236. private _computeParticleRotation;
  89237. private _computeParticleVertex;
  89238. private _computeBoundingBox;
  89239. private _depthSortParticles;
  89240. private _camera;
  89241. private _mustUnrotateFixedNormals;
  89242. private _particlesIntersect;
  89243. private _needs32Bits;
  89244. /**
  89245. * Creates a SPS (Solid Particle System) object.
  89246. * @param name (String) is the SPS name, this will be the underlying mesh name.
  89247. * @param scene (Scene) is the scene in which the SPS is added.
  89248. * @param options defines the options of the sps e.g.
  89249. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  89250. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  89251. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  89252. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  89253. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  89254. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  89255. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  89256. */
  89257. constructor(name: string, scene: Scene, options?: {
  89258. updatable?: boolean;
  89259. isPickable?: boolean;
  89260. enableDepthSort?: boolean;
  89261. particleIntersection?: boolean;
  89262. boundingSphereOnly?: boolean;
  89263. bSphereRadiusFactor?: number;
  89264. });
  89265. /**
  89266. * Builds the SPS underlying mesh. Returns a standard Mesh.
  89267. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  89268. * @returns the created mesh
  89269. */
  89270. buildMesh(): Mesh;
  89271. /**
  89272. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  89273. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  89274. * Thus the particles generated from `digest()` have their property `position` set yet.
  89275. * @param mesh ( Mesh ) is the mesh to be digested
  89276. * @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
  89277. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  89278. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  89279. * @returns the current SPS
  89280. */
  89281. digest(mesh: Mesh, options?: {
  89282. facetNb?: number;
  89283. number?: number;
  89284. delta?: number;
  89285. }): SolidParticleSystem;
  89286. private _unrotateFixedNormals;
  89287. private _resetCopy;
  89288. private _meshBuilder;
  89289. private _posToShape;
  89290. private _uvsToShapeUV;
  89291. private _addParticle;
  89292. /**
  89293. * Adds some particles to the SPS from the model shape. Returns the shape id.
  89294. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  89295. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  89296. * @param nb (positive integer) the number of particles to be created from this model
  89297. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  89298. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  89299. * @returns the number of shapes in the system
  89300. */
  89301. addShape(mesh: Mesh, nb: number, options?: {
  89302. positionFunction?: any;
  89303. vertexFunction?: any;
  89304. }): number;
  89305. private _rebuildParticle;
  89306. /**
  89307. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  89308. * @returns the SPS.
  89309. */
  89310. rebuildMesh(): SolidParticleSystem;
  89311. /**
  89312. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  89313. * This method calls `updateParticle()` for each particle of the SPS.
  89314. * For an animated SPS, it is usually called within the render loop.
  89315. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  89316. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  89317. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  89318. * @returns the SPS.
  89319. */
  89320. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  89321. /**
  89322. * Disposes the SPS.
  89323. */
  89324. dispose(): void;
  89325. /**
  89326. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  89327. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  89328. * @returns the SPS.
  89329. */
  89330. refreshVisibleSize(): SolidParticleSystem;
  89331. /**
  89332. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  89333. * @param size the size (float) of the visibility box
  89334. * note : this doesn't lock the SPS mesh bounding box.
  89335. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  89336. */
  89337. setVisibilityBox(size: number): void;
  89338. /**
  89339. * Gets whether the SPS as always visible or not
  89340. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  89341. */
  89342. /**
  89343. * Sets the SPS as always visible or not
  89344. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  89345. */
  89346. isAlwaysVisible: boolean;
  89347. /**
  89348. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  89349. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  89350. */
  89351. /**
  89352. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  89353. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  89354. */
  89355. isVisibilityBoxLocked: boolean;
  89356. /**
  89357. * Tells to `setParticles()` to compute the particle rotations or not.
  89358. * Default value : true. The SPS is faster when it's set to false.
  89359. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  89360. */
  89361. /**
  89362. * Gets if `setParticles()` computes the particle rotations or not.
  89363. * Default value : true. The SPS is faster when it's set to false.
  89364. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  89365. */
  89366. computeParticleRotation: boolean;
  89367. /**
  89368. * Tells to `setParticles()` to compute the particle colors or not.
  89369. * Default value : true. The SPS is faster when it's set to false.
  89370. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  89371. */
  89372. /**
  89373. * Gets if `setParticles()` computes the particle colors or not.
  89374. * Default value : true. The SPS is faster when it's set to false.
  89375. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  89376. */
  89377. computeParticleColor: boolean;
  89378. /**
  89379. * Gets if `setParticles()` computes the particle textures or not.
  89380. * Default value : true. The SPS is faster when it's set to false.
  89381. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  89382. */
  89383. computeParticleTexture: boolean;
  89384. /**
  89385. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  89386. * Default value : false. The SPS is faster when it's set to false.
  89387. * Note : the particle custom vertex positions aren't stored values.
  89388. */
  89389. /**
  89390. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  89391. * Default value : false. The SPS is faster when it's set to false.
  89392. * Note : the particle custom vertex positions aren't stored values.
  89393. */
  89394. computeParticleVertex: boolean;
  89395. /**
  89396. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  89397. */
  89398. /**
  89399. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  89400. */
  89401. computeBoundingBox: boolean;
  89402. /**
  89403. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  89404. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  89405. * Default : `true`
  89406. */
  89407. /**
  89408. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  89409. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  89410. * Default : `true`
  89411. */
  89412. depthSortParticles: boolean;
  89413. /**
  89414. * This function does nothing. It may be overwritten to set all the particle first values.
  89415. * The SPS doesn't call this function, you may have to call it by your own.
  89416. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  89417. */
  89418. initParticles(): void;
  89419. /**
  89420. * This function does nothing. It may be overwritten to recycle a particle.
  89421. * The SPS doesn't call this function, you may have to call it by your own.
  89422. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  89423. * @param particle The particle to recycle
  89424. * @returns the recycled particle
  89425. */
  89426. recycleParticle(particle: SolidParticle): SolidParticle;
  89427. /**
  89428. * Updates a particle : this function should be overwritten by the user.
  89429. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  89430. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  89431. * @example : just set a particle position or velocity and recycle conditions
  89432. * @param particle The particle to update
  89433. * @returns the updated particle
  89434. */
  89435. updateParticle(particle: SolidParticle): SolidParticle;
  89436. /**
  89437. * Updates a vertex of a particle : it can be overwritten by the user.
  89438. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  89439. * @param particle the current particle
  89440. * @param vertex the current index of the current particle
  89441. * @param pt the index of the current vertex in the particle shape
  89442. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  89443. * @example : just set a vertex particle position
  89444. * @returns the updated vertex
  89445. */
  89446. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  89447. /**
  89448. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  89449. * This does nothing and may be overwritten by the user.
  89450. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  89451. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  89452. * @param update the boolean update value actually passed to setParticles()
  89453. */
  89454. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  89455. /**
  89456. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  89457. * This will be passed three parameters.
  89458. * This does nothing and may be overwritten by the user.
  89459. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  89460. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  89461. * @param update the boolean update value actually passed to setParticles()
  89462. */
  89463. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  89464. }
  89465. }
  89466. declare module BABYLON {
  89467. /**
  89468. * Represents one particle of a solid particle system.
  89469. */
  89470. export class SolidParticle {
  89471. /**
  89472. * particle global index
  89473. */
  89474. idx: number;
  89475. /**
  89476. * The color of the particle
  89477. */
  89478. color: Nullable<Color4>;
  89479. /**
  89480. * The world space position of the particle.
  89481. */
  89482. position: Vector3;
  89483. /**
  89484. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  89485. */
  89486. rotation: Vector3;
  89487. /**
  89488. * The world space rotation quaternion of the particle.
  89489. */
  89490. rotationQuaternion: Nullable<Quaternion>;
  89491. /**
  89492. * The scaling of the particle.
  89493. */
  89494. scaling: Vector3;
  89495. /**
  89496. * The uvs of the particle.
  89497. */
  89498. uvs: Vector4;
  89499. /**
  89500. * The current speed of the particle.
  89501. */
  89502. velocity: Vector3;
  89503. /**
  89504. * The pivot point in the particle local space.
  89505. */
  89506. pivot: Vector3;
  89507. /**
  89508. * Must the particle be translated from its pivot point in its local space ?
  89509. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  89510. * Default : false
  89511. */
  89512. translateFromPivot: boolean;
  89513. /**
  89514. * Is the particle active or not ?
  89515. */
  89516. alive: boolean;
  89517. /**
  89518. * Is the particle visible or not ?
  89519. */
  89520. isVisible: boolean;
  89521. /**
  89522. * Index of this particle in the global "positions" array (Internal use)
  89523. * @hidden
  89524. */
  89525. _pos: number;
  89526. /**
  89527. * @hidden Index of this particle in the global "indices" array (Internal use)
  89528. */
  89529. _ind: number;
  89530. /**
  89531. * @hidden ModelShape of this particle (Internal use)
  89532. */
  89533. _model: ModelShape;
  89534. /**
  89535. * ModelShape id of this particle
  89536. */
  89537. shapeId: number;
  89538. /**
  89539. * Index of the particle in its shape id (Internal use)
  89540. */
  89541. idxInShape: number;
  89542. /**
  89543. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  89544. */
  89545. _modelBoundingInfo: BoundingInfo;
  89546. /**
  89547. * @hidden Particle BoundingInfo object (Internal use)
  89548. */
  89549. _boundingInfo: BoundingInfo;
  89550. /**
  89551. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  89552. */
  89553. _sps: SolidParticleSystem;
  89554. /**
  89555. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  89556. */
  89557. _stillInvisible: boolean;
  89558. /**
  89559. * @hidden Last computed particle rotation matrix
  89560. */
  89561. _rotationMatrix: number[];
  89562. /**
  89563. * Parent particle Id, if any.
  89564. * Default null.
  89565. */
  89566. parentId: Nullable<number>;
  89567. /**
  89568. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  89569. * The possible values are :
  89570. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  89571. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  89572. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  89573. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  89574. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  89575. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  89576. * */
  89577. cullingStrategy: number;
  89578. /**
  89579. * @hidden Internal global position in the SPS.
  89580. */
  89581. _globalPosition: Vector3;
  89582. /**
  89583. * Creates a Solid Particle object.
  89584. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  89585. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  89586. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  89587. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  89588. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  89589. * @param shapeId (integer) is the model shape identifier in the SPS.
  89590. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  89591. * @param sps defines the sps it is associated to
  89592. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  89593. */
  89594. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  89595. /**
  89596. * Legacy support, changed scale to scaling
  89597. */
  89598. /**
  89599. * Legacy support, changed scale to scaling
  89600. */
  89601. scale: Vector3;
  89602. /**
  89603. * Legacy support, changed quaternion to rotationQuaternion
  89604. */
  89605. /**
  89606. * Legacy support, changed quaternion to rotationQuaternion
  89607. */
  89608. quaternion: Nullable<Quaternion>;
  89609. /**
  89610. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  89611. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  89612. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  89613. * @returns true if it intersects
  89614. */
  89615. intersectsMesh(target: Mesh | SolidParticle): boolean;
  89616. /**
  89617. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  89618. * A particle is in the frustum if its bounding box intersects the frustum
  89619. * @param frustumPlanes defines the frustum to test
  89620. * @returns true if the particle is in the frustum planes
  89621. */
  89622. isInFrustum(frustumPlanes: Plane[]): boolean;
  89623. /**
  89624. * get the rotation matrix of the particle
  89625. * @hidden
  89626. */
  89627. getRotationMatrix(m: Matrix): void;
  89628. }
  89629. /**
  89630. * Represents the shape of the model used by one particle of a solid particle system.
  89631. * SPS internal tool, don't use it manually.
  89632. */
  89633. export class ModelShape {
  89634. /**
  89635. * The shape id
  89636. * @hidden
  89637. */
  89638. shapeID: number;
  89639. /**
  89640. * flat array of model positions (internal use)
  89641. * @hidden
  89642. */
  89643. _shape: Vector3[];
  89644. /**
  89645. * flat array of model UVs (internal use)
  89646. * @hidden
  89647. */
  89648. _shapeUV: number[];
  89649. /**
  89650. * length of the shape in the model indices array (internal use)
  89651. * @hidden
  89652. */
  89653. _indicesLength: number;
  89654. /**
  89655. * Custom position function (internal use)
  89656. * @hidden
  89657. */
  89658. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  89659. /**
  89660. * Custom vertex function (internal use)
  89661. * @hidden
  89662. */
  89663. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  89664. /**
  89665. * 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.
  89666. * SPS internal tool, don't use it manually.
  89667. * @hidden
  89668. */
  89669. constructor(id: number, shape: Vector3[], indicesLength: number, shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  89670. }
  89671. /**
  89672. * Represents a Depth Sorted Particle in the solid particle system.
  89673. */
  89674. export class DepthSortedParticle {
  89675. /**
  89676. * Index of the particle in the "indices" array
  89677. */
  89678. ind: number;
  89679. /**
  89680. * Length of the particle shape in the "indices" array
  89681. */
  89682. indicesLength: number;
  89683. /**
  89684. * Squared distance from the particle to the camera
  89685. */
  89686. sqDistance: number;
  89687. }
  89688. }
  89689. declare module BABYLON {
  89690. /**
  89691. * @hidden
  89692. */
  89693. export class _MeshCollisionData {
  89694. _checkCollisions: boolean;
  89695. _collisionMask: number;
  89696. _collisionGroup: number;
  89697. _collider: Nullable<Collider>;
  89698. _oldPositionForCollisions: Vector3;
  89699. _diffPositionForCollisions: Vector3;
  89700. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  89701. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  89702. }
  89703. }
  89704. declare module BABYLON {
  89705. /** @hidden */
  89706. class _FacetDataStorage {
  89707. facetPositions: Vector3[];
  89708. facetNormals: Vector3[];
  89709. facetPartitioning: number[][];
  89710. facetNb: number;
  89711. partitioningSubdivisions: number;
  89712. partitioningBBoxRatio: number;
  89713. facetDataEnabled: boolean;
  89714. facetParameters: any;
  89715. bbSize: Vector3;
  89716. subDiv: {
  89717. max: number;
  89718. X: number;
  89719. Y: number;
  89720. Z: number;
  89721. };
  89722. facetDepthSort: boolean;
  89723. facetDepthSortEnabled: boolean;
  89724. depthSortedIndices: IndicesArray;
  89725. depthSortedFacets: {
  89726. ind: number;
  89727. sqDistance: number;
  89728. }[];
  89729. facetDepthSortFunction: (f1: {
  89730. ind: number;
  89731. sqDistance: number;
  89732. }, f2: {
  89733. ind: number;
  89734. sqDistance: number;
  89735. }) => number;
  89736. facetDepthSortFrom: Vector3;
  89737. facetDepthSortOrigin: Vector3;
  89738. invertedMatrix: Matrix;
  89739. }
  89740. /**
  89741. * @hidden
  89742. **/
  89743. class _InternalAbstractMeshDataInfo {
  89744. _hasVertexAlpha: boolean;
  89745. _useVertexColors: boolean;
  89746. _numBoneInfluencers: number;
  89747. _applyFog: boolean;
  89748. _receiveShadows: boolean;
  89749. _facetData: _FacetDataStorage;
  89750. _visibility: number;
  89751. _skeleton: Nullable<Skeleton>;
  89752. _layerMask: number;
  89753. _computeBonesUsingShaders: boolean;
  89754. _isActive: boolean;
  89755. _onlyForInstances: boolean;
  89756. _isActiveIntermediate: boolean;
  89757. _onlyForInstancesIntermediate: boolean;
  89758. }
  89759. /**
  89760. * Class used to store all common mesh properties
  89761. */
  89762. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  89763. /** No occlusion */
  89764. static OCCLUSION_TYPE_NONE: number;
  89765. /** Occlusion set to optimisitic */
  89766. static OCCLUSION_TYPE_OPTIMISTIC: number;
  89767. /** Occlusion set to strict */
  89768. static OCCLUSION_TYPE_STRICT: number;
  89769. /** Use an accurante occlusion algorithm */
  89770. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  89771. /** Use a conservative occlusion algorithm */
  89772. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  89773. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  89774. * Test order :
  89775. * Is the bounding sphere outside the frustum ?
  89776. * If not, are the bounding box vertices outside the frustum ?
  89777. * It not, then the cullable object is in the frustum.
  89778. */
  89779. static readonly CULLINGSTRATEGY_STANDARD: number;
  89780. /** Culling strategy : Bounding Sphere Only.
  89781. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  89782. * It's also less accurate than the standard because some not visible objects can still be selected.
  89783. * Test : is the bounding sphere outside the frustum ?
  89784. * If not, then the cullable object is in the frustum.
  89785. */
  89786. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  89787. /** Culling strategy : Optimistic Inclusion.
  89788. * This in an inclusion test first, then the standard exclusion test.
  89789. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  89790. * 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.
  89791. * Anyway, it's as accurate as the standard strategy.
  89792. * Test :
  89793. * Is the cullable object bounding sphere center in the frustum ?
  89794. * If not, apply the default culling strategy.
  89795. */
  89796. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  89797. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  89798. * This in an inclusion test first, then the bounding sphere only exclusion test.
  89799. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  89800. * 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.
  89801. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  89802. * Test :
  89803. * Is the cullable object bounding sphere center in the frustum ?
  89804. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  89805. */
  89806. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  89807. /**
  89808. * No billboard
  89809. */
  89810. static readonly BILLBOARDMODE_NONE: number;
  89811. /** Billboard on X axis */
  89812. static readonly BILLBOARDMODE_X: number;
  89813. /** Billboard on Y axis */
  89814. static readonly BILLBOARDMODE_Y: number;
  89815. /** Billboard on Z axis */
  89816. static readonly BILLBOARDMODE_Z: number;
  89817. /** Billboard on all axes */
  89818. static readonly BILLBOARDMODE_ALL: number;
  89819. /** Billboard on using position instead of orientation */
  89820. static readonly BILLBOARDMODE_USE_POSITION: number;
  89821. /** @hidden */
  89822. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  89823. /**
  89824. * The culling strategy to use to check whether the mesh must be rendered or not.
  89825. * This value can be changed at any time and will be used on the next render mesh selection.
  89826. * The possible values are :
  89827. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  89828. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  89829. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  89830. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  89831. * Please read each static variable documentation to get details about the culling process.
  89832. * */
  89833. cullingStrategy: number;
  89834. /**
  89835. * Gets the number of facets in the mesh
  89836. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  89837. */
  89838. readonly facetNb: number;
  89839. /**
  89840. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  89841. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  89842. */
  89843. partitioningSubdivisions: number;
  89844. /**
  89845. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  89846. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  89847. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  89848. */
  89849. partitioningBBoxRatio: number;
  89850. /**
  89851. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  89852. * Works only for updatable meshes.
  89853. * Doesn't work with multi-materials
  89854. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  89855. */
  89856. mustDepthSortFacets: boolean;
  89857. /**
  89858. * The location (Vector3) where the facet depth sort must be computed from.
  89859. * By default, the active camera position.
  89860. * Used only when facet depth sort is enabled
  89861. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  89862. */
  89863. facetDepthSortFrom: Vector3;
  89864. /**
  89865. * gets a boolean indicating if facetData is enabled
  89866. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  89867. */
  89868. readonly isFacetDataEnabled: boolean;
  89869. /** @hidden */
  89870. _updateNonUniformScalingState(value: boolean): boolean;
  89871. /**
  89872. * An event triggered when this mesh collides with another one
  89873. */
  89874. onCollideObservable: Observable<AbstractMesh>;
  89875. /** Set a function to call when this mesh collides with another one */
  89876. onCollide: () => void;
  89877. /**
  89878. * An event triggered when the collision's position changes
  89879. */
  89880. onCollisionPositionChangeObservable: Observable<Vector3>;
  89881. /** Set a function to call when the collision's position changes */
  89882. onCollisionPositionChange: () => void;
  89883. /**
  89884. * An event triggered when material is changed
  89885. */
  89886. onMaterialChangedObservable: Observable<AbstractMesh>;
  89887. /**
  89888. * Gets or sets the orientation for POV movement & rotation
  89889. */
  89890. definedFacingForward: boolean;
  89891. /** @hidden */
  89892. _occlusionQuery: Nullable<WebGLQuery>;
  89893. /** @hidden */
  89894. _renderingGroup: Nullable<RenderingGroup>;
  89895. /**
  89896. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  89897. */
  89898. /**
  89899. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  89900. */
  89901. visibility: number;
  89902. /** Gets or sets the alpha index used to sort transparent meshes
  89903. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  89904. */
  89905. alphaIndex: number;
  89906. /**
  89907. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  89908. */
  89909. isVisible: boolean;
  89910. /**
  89911. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  89912. */
  89913. isPickable: boolean;
  89914. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  89915. showSubMeshesBoundingBox: boolean;
  89916. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  89917. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  89918. */
  89919. isBlocker: boolean;
  89920. /**
  89921. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  89922. */
  89923. enablePointerMoveEvents: boolean;
  89924. /**
  89925. * Specifies the rendering group id for this mesh (0 by default)
  89926. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  89927. */
  89928. renderingGroupId: number;
  89929. private _material;
  89930. /** Gets or sets current material */
  89931. material: Nullable<Material>;
  89932. /**
  89933. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  89934. * @see http://doc.babylonjs.com/babylon101/shadows
  89935. */
  89936. receiveShadows: boolean;
  89937. /** Defines color to use when rendering outline */
  89938. outlineColor: Color3;
  89939. /** Define width to use when rendering outline */
  89940. outlineWidth: number;
  89941. /** Defines color to use when rendering overlay */
  89942. overlayColor: Color3;
  89943. /** Defines alpha to use when rendering overlay */
  89944. overlayAlpha: number;
  89945. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  89946. hasVertexAlpha: boolean;
  89947. /** 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) */
  89948. useVertexColors: boolean;
  89949. /**
  89950. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  89951. */
  89952. computeBonesUsingShaders: boolean;
  89953. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  89954. numBoneInfluencers: number;
  89955. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  89956. applyFog: boolean;
  89957. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  89958. useOctreeForRenderingSelection: boolean;
  89959. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  89960. useOctreeForPicking: boolean;
  89961. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  89962. useOctreeForCollisions: boolean;
  89963. /**
  89964. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  89965. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  89966. */
  89967. layerMask: number;
  89968. /**
  89969. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  89970. */
  89971. alwaysSelectAsActiveMesh: boolean;
  89972. /**
  89973. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  89974. */
  89975. doNotSyncBoundingInfo: boolean;
  89976. /**
  89977. * Gets or sets the current action manager
  89978. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  89979. */
  89980. actionManager: Nullable<AbstractActionManager>;
  89981. private _meshCollisionData;
  89982. /**
  89983. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  89984. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  89985. */
  89986. ellipsoid: Vector3;
  89987. /**
  89988. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  89989. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  89990. */
  89991. ellipsoidOffset: Vector3;
  89992. /**
  89993. * Gets or sets a collision mask used to mask collisions (default is -1).
  89994. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  89995. */
  89996. collisionMask: number;
  89997. /**
  89998. * Gets or sets the current collision group mask (-1 by default).
  89999. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  90000. */
  90001. collisionGroup: number;
  90002. /**
  90003. * Defines edge width used when edgesRenderer is enabled
  90004. * @see https://www.babylonjs-playground.com/#10OJSG#13
  90005. */
  90006. edgesWidth: number;
  90007. /**
  90008. * Defines edge color used when edgesRenderer is enabled
  90009. * @see https://www.babylonjs-playground.com/#10OJSG#13
  90010. */
  90011. edgesColor: Color4;
  90012. /** @hidden */
  90013. _edgesRenderer: Nullable<IEdgesRenderer>;
  90014. /** @hidden */
  90015. _masterMesh: Nullable<AbstractMesh>;
  90016. /** @hidden */
  90017. _boundingInfo: Nullable<BoundingInfo>;
  90018. /** @hidden */
  90019. _renderId: number;
  90020. /**
  90021. * Gets or sets the list of subMeshes
  90022. * @see http://doc.babylonjs.com/how_to/multi_materials
  90023. */
  90024. subMeshes: SubMesh[];
  90025. /** @hidden */
  90026. _intersectionsInProgress: AbstractMesh[];
  90027. /** @hidden */
  90028. _unIndexed: boolean;
  90029. /** @hidden */
  90030. _lightSources: Light[];
  90031. /** Gets the list of lights affecting that mesh */
  90032. readonly lightSources: Light[];
  90033. /** @hidden */
  90034. readonly _positions: Nullable<Vector3[]>;
  90035. /** @hidden */
  90036. _waitingData: {
  90037. lods: Nullable<any>;
  90038. actions: Nullable<any>;
  90039. freezeWorldMatrix: Nullable<boolean>;
  90040. };
  90041. /** @hidden */
  90042. _bonesTransformMatrices: Nullable<Float32Array>;
  90043. /** @hidden */
  90044. _transformMatrixTexture: Nullable<RawTexture>;
  90045. /**
  90046. * Gets or sets a skeleton to apply skining transformations
  90047. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  90048. */
  90049. skeleton: Nullable<Skeleton>;
  90050. /**
  90051. * An event triggered when the mesh is rebuilt.
  90052. */
  90053. onRebuildObservable: Observable<AbstractMesh>;
  90054. /**
  90055. * Creates a new AbstractMesh
  90056. * @param name defines the name of the mesh
  90057. * @param scene defines the hosting scene
  90058. */
  90059. constructor(name: string, scene?: Nullable<Scene>);
  90060. /**
  90061. * Returns the string "AbstractMesh"
  90062. * @returns "AbstractMesh"
  90063. */
  90064. getClassName(): string;
  90065. /**
  90066. * Gets a string representation of the current mesh
  90067. * @param fullDetails defines a boolean indicating if full details must be included
  90068. * @returns a string representation of the current mesh
  90069. */
  90070. toString(fullDetails?: boolean): string;
  90071. /**
  90072. * @hidden
  90073. */
  90074. protected _getEffectiveParent(): Nullable<Node>;
  90075. /** @hidden */
  90076. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  90077. /** @hidden */
  90078. _rebuild(): void;
  90079. /** @hidden */
  90080. _resyncLightSources(): void;
  90081. /** @hidden */
  90082. _resyncLighSource(light: Light): void;
  90083. /** @hidden */
  90084. _unBindEffect(): void;
  90085. /** @hidden */
  90086. _removeLightSource(light: Light): void;
  90087. private _markSubMeshesAsDirty;
  90088. /** @hidden */
  90089. _markSubMeshesAsLightDirty(): void;
  90090. /** @hidden */
  90091. _markSubMeshesAsAttributesDirty(): void;
  90092. /** @hidden */
  90093. _markSubMeshesAsMiscDirty(): void;
  90094. /**
  90095. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  90096. */
  90097. scaling: Vector3;
  90098. /**
  90099. * Returns true if the mesh is blocked. Implemented by child classes
  90100. */
  90101. readonly isBlocked: boolean;
  90102. /**
  90103. * Returns the mesh itself by default. Implemented by child classes
  90104. * @param camera defines the camera to use to pick the right LOD level
  90105. * @returns the currentAbstractMesh
  90106. */
  90107. getLOD(camera: Camera): Nullable<AbstractMesh>;
  90108. /**
  90109. * Returns 0 by default. Implemented by child classes
  90110. * @returns an integer
  90111. */
  90112. getTotalVertices(): number;
  90113. /**
  90114. * Returns a positive integer : the total number of indices in this mesh geometry.
  90115. * @returns the numner of indices or zero if the mesh has no geometry.
  90116. */
  90117. getTotalIndices(): number;
  90118. /**
  90119. * Returns null by default. Implemented by child classes
  90120. * @returns null
  90121. */
  90122. getIndices(): Nullable<IndicesArray>;
  90123. /**
  90124. * Returns the array of the requested vertex data kind. Implemented by child classes
  90125. * @param kind defines the vertex data kind to use
  90126. * @returns null
  90127. */
  90128. getVerticesData(kind: string): Nullable<FloatArray>;
  90129. /**
  90130. * Sets the vertex data of the mesh geometry for the requested `kind`.
  90131. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  90132. * Note that a new underlying VertexBuffer object is created each call.
  90133. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  90134. * @param kind defines vertex data kind:
  90135. * * VertexBuffer.PositionKind
  90136. * * VertexBuffer.UVKind
  90137. * * VertexBuffer.UV2Kind
  90138. * * VertexBuffer.UV3Kind
  90139. * * VertexBuffer.UV4Kind
  90140. * * VertexBuffer.UV5Kind
  90141. * * VertexBuffer.UV6Kind
  90142. * * VertexBuffer.ColorKind
  90143. * * VertexBuffer.MatricesIndicesKind
  90144. * * VertexBuffer.MatricesIndicesExtraKind
  90145. * * VertexBuffer.MatricesWeightsKind
  90146. * * VertexBuffer.MatricesWeightsExtraKind
  90147. * @param data defines the data source
  90148. * @param updatable defines if the data must be flagged as updatable (or static)
  90149. * @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
  90150. * @returns the current mesh
  90151. */
  90152. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  90153. /**
  90154. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  90155. * If the mesh has no geometry, it is simply returned as it is.
  90156. * @param kind defines vertex data kind:
  90157. * * VertexBuffer.PositionKind
  90158. * * VertexBuffer.UVKind
  90159. * * VertexBuffer.UV2Kind
  90160. * * VertexBuffer.UV3Kind
  90161. * * VertexBuffer.UV4Kind
  90162. * * VertexBuffer.UV5Kind
  90163. * * VertexBuffer.UV6Kind
  90164. * * VertexBuffer.ColorKind
  90165. * * VertexBuffer.MatricesIndicesKind
  90166. * * VertexBuffer.MatricesIndicesExtraKind
  90167. * * VertexBuffer.MatricesWeightsKind
  90168. * * VertexBuffer.MatricesWeightsExtraKind
  90169. * @param data defines the data source
  90170. * @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
  90171. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  90172. * @returns the current mesh
  90173. */
  90174. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  90175. /**
  90176. * Sets the mesh indices,
  90177. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  90178. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  90179. * @param totalVertices Defines the total number of vertices
  90180. * @returns the current mesh
  90181. */
  90182. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  90183. /**
  90184. * Gets a boolean indicating if specific vertex data is present
  90185. * @param kind defines the vertex data kind to use
  90186. * @returns true is data kind is present
  90187. */
  90188. isVerticesDataPresent(kind: string): boolean;
  90189. /**
  90190. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  90191. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  90192. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  90193. * @returns a BoundingInfo
  90194. */
  90195. getBoundingInfo(): BoundingInfo;
  90196. /**
  90197. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  90198. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  90199. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  90200. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  90201. * @returns the current mesh
  90202. */
  90203. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  90204. /**
  90205. * Overwrite the current bounding info
  90206. * @param boundingInfo defines the new bounding info
  90207. * @returns the current mesh
  90208. */
  90209. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  90210. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  90211. readonly useBones: boolean;
  90212. /** @hidden */
  90213. _preActivate(): void;
  90214. /** @hidden */
  90215. _preActivateForIntermediateRendering(renderId: number): void;
  90216. /** @hidden */
  90217. _activate(renderId: number, intermediateRendering: boolean): boolean;
  90218. /** @hidden */
  90219. _postActivate(): void;
  90220. /** @hidden */
  90221. _freeze(): void;
  90222. /** @hidden */
  90223. _unFreeze(): void;
  90224. /**
  90225. * Gets the current world matrix
  90226. * @returns a Matrix
  90227. */
  90228. getWorldMatrix(): Matrix;
  90229. /** @hidden */
  90230. _getWorldMatrixDeterminant(): number;
  90231. /**
  90232. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  90233. */
  90234. readonly isAnInstance: boolean;
  90235. /**
  90236. * Perform relative position change from the point of view of behind the front of the mesh.
  90237. * This is performed taking into account the meshes current rotation, so you do not have to care.
  90238. * Supports definition of mesh facing forward or backward
  90239. * @param amountRight defines the distance on the right axis
  90240. * @param amountUp defines the distance on the up axis
  90241. * @param amountForward defines the distance on the forward axis
  90242. * @returns the current mesh
  90243. */
  90244. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  90245. /**
  90246. * Calculate relative position change from the point of view of behind the front of the mesh.
  90247. * This is performed taking into account the meshes current rotation, so you do not have to care.
  90248. * Supports definition of mesh facing forward or backward
  90249. * @param amountRight defines the distance on the right axis
  90250. * @param amountUp defines the distance on the up axis
  90251. * @param amountForward defines the distance on the forward axis
  90252. * @returns the new displacement vector
  90253. */
  90254. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  90255. /**
  90256. * Perform relative rotation change from the point of view of behind the front of the mesh.
  90257. * Supports definition of mesh facing forward or backward
  90258. * @param flipBack defines the flip
  90259. * @param twirlClockwise defines the twirl
  90260. * @param tiltRight defines the tilt
  90261. * @returns the current mesh
  90262. */
  90263. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  90264. /**
  90265. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  90266. * Supports definition of mesh facing forward or backward.
  90267. * @param flipBack defines the flip
  90268. * @param twirlClockwise defines the twirl
  90269. * @param tiltRight defines the tilt
  90270. * @returns the new rotation vector
  90271. */
  90272. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  90273. /**
  90274. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  90275. * This means the mesh underlying bounding box and sphere are recomputed.
  90276. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  90277. * @returns the current mesh
  90278. */
  90279. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  90280. /** @hidden */
  90281. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  90282. /** @hidden */
  90283. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  90284. /** @hidden */
  90285. _updateBoundingInfo(): AbstractMesh;
  90286. /** @hidden */
  90287. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  90288. /** @hidden */
  90289. protected _afterComputeWorldMatrix(): void;
  90290. /** @hidden */
  90291. readonly _effectiveMesh: AbstractMesh;
  90292. /**
  90293. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  90294. * A mesh is in the frustum if its bounding box intersects the frustum
  90295. * @param frustumPlanes defines the frustum to test
  90296. * @returns true if the mesh is in the frustum planes
  90297. */
  90298. isInFrustum(frustumPlanes: Plane[]): boolean;
  90299. /**
  90300. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  90301. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  90302. * @param frustumPlanes defines the frustum to test
  90303. * @returns true if the mesh is completely in the frustum planes
  90304. */
  90305. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  90306. /**
  90307. * True if the mesh intersects another mesh or a SolidParticle object
  90308. * @param mesh defines a target mesh or SolidParticle to test
  90309. * @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)
  90310. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  90311. * @returns true if there is an intersection
  90312. */
  90313. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  90314. /**
  90315. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  90316. * @param point defines the point to test
  90317. * @returns true if there is an intersection
  90318. */
  90319. intersectsPoint(point: Vector3): boolean;
  90320. /**
  90321. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  90322. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  90323. */
  90324. checkCollisions: boolean;
  90325. /**
  90326. * Gets Collider object used to compute collisions (not physics)
  90327. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  90328. */
  90329. readonly collider: Nullable<Collider>;
  90330. /**
  90331. * Move the mesh using collision engine
  90332. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  90333. * @param displacement defines the requested displacement vector
  90334. * @returns the current mesh
  90335. */
  90336. moveWithCollisions(displacement: Vector3): AbstractMesh;
  90337. private _onCollisionPositionChange;
  90338. /** @hidden */
  90339. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  90340. /** @hidden */
  90341. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  90342. /** @hidden */
  90343. _checkCollision(collider: Collider): AbstractMesh;
  90344. /** @hidden */
  90345. _generatePointsArray(): boolean;
  90346. /**
  90347. * Checks if the passed Ray intersects with the mesh
  90348. * @param ray defines the ray to use
  90349. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  90350. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  90351. * @returns the picking info
  90352. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  90353. */
  90354. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  90355. /**
  90356. * Clones the current mesh
  90357. * @param name defines the mesh name
  90358. * @param newParent defines the new mesh parent
  90359. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  90360. * @returns the new mesh
  90361. */
  90362. clone(name: string, newParent: Node, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  90363. /**
  90364. * Disposes all the submeshes of the current meshnp
  90365. * @returns the current mesh
  90366. */
  90367. releaseSubMeshes(): AbstractMesh;
  90368. /**
  90369. * Releases resources associated with this abstract mesh.
  90370. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  90371. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  90372. */
  90373. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  90374. /**
  90375. * Adds the passed mesh as a child to the current mesh
  90376. * @param mesh defines the child mesh
  90377. * @returns the current mesh
  90378. */
  90379. addChild(mesh: AbstractMesh): AbstractMesh;
  90380. /**
  90381. * Removes the passed mesh from the current mesh children list
  90382. * @param mesh defines the child mesh
  90383. * @returns the current mesh
  90384. */
  90385. removeChild(mesh: AbstractMesh): AbstractMesh;
  90386. /** @hidden */
  90387. private _initFacetData;
  90388. /**
  90389. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  90390. * This method can be called within the render loop.
  90391. * 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
  90392. * @returns the current mesh
  90393. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90394. */
  90395. updateFacetData(): AbstractMesh;
  90396. /**
  90397. * Returns the facetLocalNormals array.
  90398. * The normals are expressed in the mesh local spac
  90399. * @returns an array of Vector3
  90400. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90401. */
  90402. getFacetLocalNormals(): Vector3[];
  90403. /**
  90404. * Returns the facetLocalPositions array.
  90405. * The facet positions are expressed in the mesh local space
  90406. * @returns an array of Vector3
  90407. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90408. */
  90409. getFacetLocalPositions(): Vector3[];
  90410. /**
  90411. * Returns the facetLocalPartioning array
  90412. * @returns an array of array of numbers
  90413. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90414. */
  90415. getFacetLocalPartitioning(): number[][];
  90416. /**
  90417. * Returns the i-th facet position in the world system.
  90418. * This method allocates a new Vector3 per call
  90419. * @param i defines the facet index
  90420. * @returns a new Vector3
  90421. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90422. */
  90423. getFacetPosition(i: number): Vector3;
  90424. /**
  90425. * Sets the reference Vector3 with the i-th facet position in the world system
  90426. * @param i defines the facet index
  90427. * @param ref defines the target vector
  90428. * @returns the current mesh
  90429. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90430. */
  90431. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  90432. /**
  90433. * Returns the i-th facet normal in the world system.
  90434. * This method allocates a new Vector3 per call
  90435. * @param i defines the facet index
  90436. * @returns a new Vector3
  90437. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90438. */
  90439. getFacetNormal(i: number): Vector3;
  90440. /**
  90441. * Sets the reference Vector3 with the i-th facet normal in the world system
  90442. * @param i defines the facet index
  90443. * @param ref defines the target vector
  90444. * @returns the current mesh
  90445. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90446. */
  90447. getFacetNormalToRef(i: number, ref: Vector3): this;
  90448. /**
  90449. * 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)
  90450. * @param x defines x coordinate
  90451. * @param y defines y coordinate
  90452. * @param z defines z coordinate
  90453. * @returns the array of facet indexes
  90454. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90455. */
  90456. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  90457. /**
  90458. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  90459. * @param projected sets as the (x,y,z) world projection on the facet
  90460. * @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
  90461. * @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
  90462. * @param x defines x coordinate
  90463. * @param y defines y coordinate
  90464. * @param z defines z coordinate
  90465. * @returns the face index if found (or null instead)
  90466. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90467. */
  90468. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  90469. /**
  90470. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  90471. * @param projected sets as the (x,y,z) local projection on the facet
  90472. * @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
  90473. * @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
  90474. * @param x defines x coordinate
  90475. * @param y defines y coordinate
  90476. * @param z defines z coordinate
  90477. * @returns the face index if found (or null instead)
  90478. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90479. */
  90480. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  90481. /**
  90482. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  90483. * @returns the parameters
  90484. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90485. */
  90486. getFacetDataParameters(): any;
  90487. /**
  90488. * Disables the feature FacetData and frees the related memory
  90489. * @returns the current mesh
  90490. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  90491. */
  90492. disableFacetData(): AbstractMesh;
  90493. /**
  90494. * Updates the AbstractMesh indices array
  90495. * @param indices defines the data source
  90496. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  90497. * @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)
  90498. * @returns the current mesh
  90499. */
  90500. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  90501. /**
  90502. * Creates new normals data for the mesh
  90503. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  90504. * @returns the current mesh
  90505. */
  90506. createNormals(updatable: boolean): AbstractMesh;
  90507. /**
  90508. * Align the mesh with a normal
  90509. * @param normal defines the normal to use
  90510. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  90511. * @returns the current mesh
  90512. */
  90513. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  90514. /** @hidden */
  90515. _checkOcclusionQuery(): boolean;
  90516. /**
  90517. * Disables the mesh edge rendering mode
  90518. * @returns the currentAbstractMesh
  90519. */
  90520. disableEdgesRendering(): AbstractMesh;
  90521. /**
  90522. * Enables the edge rendering mode on the mesh.
  90523. * This mode makes the mesh edges visible
  90524. * @param epsilon defines the maximal distance between two angles to detect a face
  90525. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  90526. * @returns the currentAbstractMesh
  90527. * @see https://www.babylonjs-playground.com/#19O9TU#0
  90528. */
  90529. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  90530. }
  90531. }
  90532. declare module BABYLON {
  90533. /**
  90534. * Interface used to define ActionEvent
  90535. */
  90536. export interface IActionEvent {
  90537. /** The mesh or sprite that triggered the action */
  90538. source: any;
  90539. /** The X mouse cursor position at the time of the event */
  90540. pointerX: number;
  90541. /** The Y mouse cursor position at the time of the event */
  90542. pointerY: number;
  90543. /** The mesh that is currently pointed at (can be null) */
  90544. meshUnderPointer: Nullable<AbstractMesh>;
  90545. /** the original (browser) event that triggered the ActionEvent */
  90546. sourceEvent?: any;
  90547. /** additional data for the event */
  90548. additionalData?: any;
  90549. }
  90550. /**
  90551. * ActionEvent is the event being sent when an action is triggered.
  90552. */
  90553. export class ActionEvent implements IActionEvent {
  90554. /** The mesh or sprite that triggered the action */
  90555. source: any;
  90556. /** The X mouse cursor position at the time of the event */
  90557. pointerX: number;
  90558. /** The Y mouse cursor position at the time of the event */
  90559. pointerY: number;
  90560. /** The mesh that is currently pointed at (can be null) */
  90561. meshUnderPointer: Nullable<AbstractMesh>;
  90562. /** the original (browser) event that triggered the ActionEvent */
  90563. sourceEvent?: any;
  90564. /** additional data for the event */
  90565. additionalData?: any;
  90566. /**
  90567. * Creates a new ActionEvent
  90568. * @param source The mesh or sprite that triggered the action
  90569. * @param pointerX The X mouse cursor position at the time of the event
  90570. * @param pointerY The Y mouse cursor position at the time of the event
  90571. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  90572. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  90573. * @param additionalData additional data for the event
  90574. */
  90575. constructor(
  90576. /** The mesh or sprite that triggered the action */
  90577. source: any,
  90578. /** The X mouse cursor position at the time of the event */
  90579. pointerX: number,
  90580. /** The Y mouse cursor position at the time of the event */
  90581. pointerY: number,
  90582. /** The mesh that is currently pointed at (can be null) */
  90583. meshUnderPointer: Nullable<AbstractMesh>,
  90584. /** the original (browser) event that triggered the ActionEvent */
  90585. sourceEvent?: any,
  90586. /** additional data for the event */
  90587. additionalData?: any);
  90588. /**
  90589. * Helper function to auto-create an ActionEvent from a source mesh.
  90590. * @param source The source mesh that triggered the event
  90591. * @param evt The original (browser) event
  90592. * @param additionalData additional data for the event
  90593. * @returns the new ActionEvent
  90594. */
  90595. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  90596. /**
  90597. * Helper function to auto-create an ActionEvent from a source sprite
  90598. * @param source The source sprite that triggered the event
  90599. * @param scene Scene associated with the sprite
  90600. * @param evt The original (browser) event
  90601. * @param additionalData additional data for the event
  90602. * @returns the new ActionEvent
  90603. */
  90604. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  90605. /**
  90606. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  90607. * @param scene the scene where the event occurred
  90608. * @param evt The original (browser) event
  90609. * @returns the new ActionEvent
  90610. */
  90611. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  90612. /**
  90613. * Helper function to auto-create an ActionEvent from a primitive
  90614. * @param prim defines the target primitive
  90615. * @param pointerPos defines the pointer position
  90616. * @param evt The original (browser) event
  90617. * @param additionalData additional data for the event
  90618. * @returns the new ActionEvent
  90619. */
  90620. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  90621. }
  90622. }
  90623. declare module BABYLON {
  90624. /**
  90625. * Abstract class used to decouple action Manager from scene and meshes.
  90626. * Do not instantiate.
  90627. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  90628. */
  90629. export abstract class AbstractActionManager implements IDisposable {
  90630. /** Gets the list of active triggers */
  90631. static Triggers: {
  90632. [key: string]: number;
  90633. };
  90634. /** Gets the cursor to use when hovering items */
  90635. hoverCursor: string;
  90636. /** Gets the list of actions */
  90637. actions: IAction[];
  90638. /**
  90639. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  90640. */
  90641. isRecursive: boolean;
  90642. /**
  90643. * Releases all associated resources
  90644. */
  90645. abstract dispose(): void;
  90646. /**
  90647. * Does this action manager has pointer triggers
  90648. */
  90649. abstract readonly hasPointerTriggers: boolean;
  90650. /**
  90651. * Does this action manager has pick triggers
  90652. */
  90653. abstract readonly hasPickTriggers: boolean;
  90654. /**
  90655. * Process a specific trigger
  90656. * @param trigger defines the trigger to process
  90657. * @param evt defines the event details to be processed
  90658. */
  90659. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  90660. /**
  90661. * Does this action manager handles actions of any of the given triggers
  90662. * @param triggers defines the triggers to be tested
  90663. * @return a boolean indicating whether one (or more) of the triggers is handled
  90664. */
  90665. abstract hasSpecificTriggers(triggers: number[]): boolean;
  90666. /**
  90667. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  90668. * speed.
  90669. * @param triggerA defines the trigger to be tested
  90670. * @param triggerB defines the trigger to be tested
  90671. * @return a boolean indicating whether one (or more) of the triggers is handled
  90672. */
  90673. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  90674. /**
  90675. * Does this action manager handles actions of a given trigger
  90676. * @param trigger defines the trigger to be tested
  90677. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  90678. * @return whether the trigger is handled
  90679. */
  90680. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  90681. /**
  90682. * Serialize this manager to a JSON object
  90683. * @param name defines the property name to store this manager
  90684. * @returns a JSON representation of this manager
  90685. */
  90686. abstract serialize(name: string): any;
  90687. /**
  90688. * Registers an action to this action manager
  90689. * @param action defines the action to be registered
  90690. * @return the action amended (prepared) after registration
  90691. */
  90692. abstract registerAction(action: IAction): Nullable<IAction>;
  90693. /**
  90694. * Unregisters an action to this action manager
  90695. * @param action defines the action to be unregistered
  90696. * @return a boolean indicating whether the action has been unregistered
  90697. */
  90698. abstract unregisterAction(action: IAction): Boolean;
  90699. /**
  90700. * Does exist one action manager with at least one trigger
  90701. **/
  90702. static readonly HasTriggers: boolean;
  90703. /**
  90704. * Does exist one action manager with at least one pick trigger
  90705. **/
  90706. static readonly HasPickTriggers: boolean;
  90707. /**
  90708. * Does exist one action manager that handles actions of a given trigger
  90709. * @param trigger defines the trigger to be tested
  90710. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  90711. **/
  90712. static HasSpecificTrigger(trigger: number): boolean;
  90713. }
  90714. }
  90715. declare module BABYLON {
  90716. /**
  90717. * Defines how a node can be built from a string name.
  90718. */
  90719. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  90720. /**
  90721. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  90722. */
  90723. export class Node implements IBehaviorAware<Node> {
  90724. /** @hidden */
  90725. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  90726. private static _NodeConstructors;
  90727. /**
  90728. * Add a new node constructor
  90729. * @param type defines the type name of the node to construct
  90730. * @param constructorFunc defines the constructor function
  90731. */
  90732. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  90733. /**
  90734. * Returns a node constructor based on type name
  90735. * @param type defines the type name
  90736. * @param name defines the new node name
  90737. * @param scene defines the hosting scene
  90738. * @param options defines optional options to transmit to constructors
  90739. * @returns the new constructor or null
  90740. */
  90741. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  90742. /**
  90743. * Gets or sets the name of the node
  90744. */
  90745. name: string;
  90746. /**
  90747. * Gets or sets the id of the node
  90748. */
  90749. id: string;
  90750. /**
  90751. * Gets or sets the unique id of the node
  90752. */
  90753. uniqueId: number;
  90754. /**
  90755. * Gets or sets a string used to store user defined state for the node
  90756. */
  90757. state: string;
  90758. /**
  90759. * Gets or sets an object used to store user defined information for the node
  90760. */
  90761. metadata: any;
  90762. /**
  90763. * For internal use only. Please do not use.
  90764. */
  90765. reservedDataStore: any;
  90766. /**
  90767. * List of inspectable custom properties (used by the Inspector)
  90768. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  90769. */
  90770. inspectableCustomProperties: IInspectable[];
  90771. /**
  90772. * Gets or sets a boolean used to define if the node must be serialized
  90773. */
  90774. doNotSerialize: boolean;
  90775. /** @hidden */
  90776. _isDisposed: boolean;
  90777. /**
  90778. * Gets a list of Animations associated with the node
  90779. */
  90780. animations: Animation[];
  90781. protected _ranges: {
  90782. [name: string]: Nullable<AnimationRange>;
  90783. };
  90784. /**
  90785. * Callback raised when the node is ready to be used
  90786. */
  90787. onReady: Nullable<(node: Node) => void>;
  90788. private _isEnabled;
  90789. private _isParentEnabled;
  90790. private _isReady;
  90791. /** @hidden */
  90792. _currentRenderId: number;
  90793. private _parentUpdateId;
  90794. /** @hidden */
  90795. _childUpdateId: number;
  90796. /** @hidden */
  90797. _waitingParentId: Nullable<string>;
  90798. /** @hidden */
  90799. _scene: Scene;
  90800. /** @hidden */
  90801. _cache: any;
  90802. private _parentNode;
  90803. private _children;
  90804. /** @hidden */
  90805. _worldMatrix: Matrix;
  90806. /** @hidden */
  90807. _worldMatrixDeterminant: number;
  90808. /** @hidden */
  90809. _worldMatrixDeterminantIsDirty: boolean;
  90810. /** @hidden */
  90811. private _sceneRootNodesIndex;
  90812. /**
  90813. * Gets a boolean indicating if the node has been disposed
  90814. * @returns true if the node was disposed
  90815. */
  90816. isDisposed(): boolean;
  90817. /**
  90818. * Gets or sets the parent of the node (without keeping the current position in the scene)
  90819. * @see https://doc.babylonjs.com/how_to/parenting
  90820. */
  90821. parent: Nullable<Node>;
  90822. private addToSceneRootNodes;
  90823. private removeFromSceneRootNodes;
  90824. private _animationPropertiesOverride;
  90825. /**
  90826. * Gets or sets the animation properties override
  90827. */
  90828. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  90829. /**
  90830. * Gets a string idenfifying the name of the class
  90831. * @returns "Node" string
  90832. */
  90833. getClassName(): string;
  90834. /** @hidden */
  90835. readonly _isNode: boolean;
  90836. /**
  90837. * An event triggered when the mesh is disposed
  90838. */
  90839. onDisposeObservable: Observable<Node>;
  90840. private _onDisposeObserver;
  90841. /**
  90842. * Sets a callback that will be raised when the node will be disposed
  90843. */
  90844. onDispose: () => void;
  90845. /**
  90846. * Creates a new Node
  90847. * @param name the name and id to be given to this node
  90848. * @param scene the scene this node will be added to
  90849. * @param addToRootNodes the node will be added to scene.rootNodes
  90850. */
  90851. constructor(name: string, scene?: Nullable<Scene>, addToRootNodes?: boolean);
  90852. /**
  90853. * Gets the scene of the node
  90854. * @returns a scene
  90855. */
  90856. getScene(): Scene;
  90857. /**
  90858. * Gets the engine of the node
  90859. * @returns a Engine
  90860. */
  90861. getEngine(): Engine;
  90862. private _behaviors;
  90863. /**
  90864. * Attach a behavior to the node
  90865. * @see http://doc.babylonjs.com/features/behaviour
  90866. * @param behavior defines the behavior to attach
  90867. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  90868. * @returns the current Node
  90869. */
  90870. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  90871. /**
  90872. * Remove an attached behavior
  90873. * @see http://doc.babylonjs.com/features/behaviour
  90874. * @param behavior defines the behavior to attach
  90875. * @returns the current Node
  90876. */
  90877. removeBehavior(behavior: Behavior<Node>): Node;
  90878. /**
  90879. * Gets the list of attached behaviors
  90880. * @see http://doc.babylonjs.com/features/behaviour
  90881. */
  90882. readonly behaviors: Behavior<Node>[];
  90883. /**
  90884. * Gets an attached behavior by name
  90885. * @param name defines the name of the behavior to look for
  90886. * @see http://doc.babylonjs.com/features/behaviour
  90887. * @returns null if behavior was not found else the requested behavior
  90888. */
  90889. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  90890. /**
  90891. * Returns the latest update of the World matrix
  90892. * @returns a Matrix
  90893. */
  90894. getWorldMatrix(): Matrix;
  90895. /** @hidden */
  90896. _getWorldMatrixDeterminant(): number;
  90897. /**
  90898. * Returns directly the latest state of the mesh World matrix.
  90899. * A Matrix is returned.
  90900. */
  90901. readonly worldMatrixFromCache: Matrix;
  90902. /** @hidden */
  90903. _initCache(): void;
  90904. /** @hidden */
  90905. updateCache(force?: boolean): void;
  90906. /** @hidden */
  90907. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  90908. /** @hidden */
  90909. _updateCache(ignoreParentClass?: boolean): void;
  90910. /** @hidden */
  90911. _isSynchronized(): boolean;
  90912. /** @hidden */
  90913. _markSyncedWithParent(): void;
  90914. /** @hidden */
  90915. isSynchronizedWithParent(): boolean;
  90916. /** @hidden */
  90917. isSynchronized(): boolean;
  90918. /**
  90919. * Is this node ready to be used/rendered
  90920. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  90921. * @return true if the node is ready
  90922. */
  90923. isReady(completeCheck?: boolean): boolean;
  90924. /**
  90925. * Is this node enabled?
  90926. * 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
  90927. * @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
  90928. * @return whether this node (and its parent) is enabled
  90929. */
  90930. isEnabled(checkAncestors?: boolean): boolean;
  90931. /** @hidden */
  90932. protected _syncParentEnabledState(): void;
  90933. /**
  90934. * Set the enabled state of this node
  90935. * @param value defines the new enabled state
  90936. */
  90937. setEnabled(value: boolean): void;
  90938. /**
  90939. * Is this node a descendant of the given node?
  90940. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  90941. * @param ancestor defines the parent node to inspect
  90942. * @returns a boolean indicating if this node is a descendant of the given node
  90943. */
  90944. isDescendantOf(ancestor: Node): boolean;
  90945. /** @hidden */
  90946. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  90947. /**
  90948. * Will return all nodes that have this node as ascendant
  90949. * @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
  90950. * @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
  90951. * @return all children nodes of all types
  90952. */
  90953. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  90954. /**
  90955. * Get all child-meshes of this node
  90956. * @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)
  90957. * @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
  90958. * @returns an array of AbstractMesh
  90959. */
  90960. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  90961. /**
  90962. * Get all direct children of this node
  90963. * @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
  90964. * @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)
  90965. * @returns an array of Node
  90966. */
  90967. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  90968. /** @hidden */
  90969. _setReady(state: boolean): void;
  90970. /**
  90971. * Get an animation by name
  90972. * @param name defines the name of the animation to look for
  90973. * @returns null if not found else the requested animation
  90974. */
  90975. getAnimationByName(name: string): Nullable<Animation>;
  90976. /**
  90977. * Creates an animation range for this node
  90978. * @param name defines the name of the range
  90979. * @param from defines the starting key
  90980. * @param to defines the end key
  90981. */
  90982. createAnimationRange(name: string, from: number, to: number): void;
  90983. /**
  90984. * Delete a specific animation range
  90985. * @param name defines the name of the range to delete
  90986. * @param deleteFrames defines if animation frames from the range must be deleted as well
  90987. */
  90988. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  90989. /**
  90990. * Get an animation range by name
  90991. * @param name defines the name of the animation range to look for
  90992. * @returns null if not found else the requested animation range
  90993. */
  90994. getAnimationRange(name: string): Nullable<AnimationRange>;
  90995. /**
  90996. * Gets the list of all animation ranges defined on this node
  90997. * @returns an array
  90998. */
  90999. getAnimationRanges(): Nullable<AnimationRange>[];
  91000. /**
  91001. * Will start the animation sequence
  91002. * @param name defines the range frames for animation sequence
  91003. * @param loop defines if the animation should loop (false by default)
  91004. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  91005. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  91006. * @returns the object created for this animation. If range does not exist, it will return null
  91007. */
  91008. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  91009. /**
  91010. * Serialize animation ranges into a JSON compatible object
  91011. * @returns serialization object
  91012. */
  91013. serializeAnimationRanges(): any;
  91014. /**
  91015. * Computes the world matrix of the node
  91016. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  91017. * @returns the world matrix
  91018. */
  91019. computeWorldMatrix(force?: boolean): Matrix;
  91020. /**
  91021. * Releases resources associated with this node.
  91022. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  91023. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  91024. */
  91025. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  91026. /**
  91027. * Parse animation range data from a serialization object and store them into a given node
  91028. * @param node defines where to store the animation ranges
  91029. * @param parsedNode defines the serialization object to read data from
  91030. * @param scene defines the hosting scene
  91031. */
  91032. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  91033. /**
  91034. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  91035. * @param includeDescendants Include bounding info from descendants as well (true by default)
  91036. * @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
  91037. * @returns the new bounding vectors
  91038. */
  91039. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  91040. min: Vector3;
  91041. max: Vector3;
  91042. };
  91043. }
  91044. }
  91045. declare module BABYLON {
  91046. /**
  91047. * @hidden
  91048. */
  91049. export class _IAnimationState {
  91050. key: number;
  91051. repeatCount: number;
  91052. workValue?: any;
  91053. loopMode?: number;
  91054. offsetValue?: any;
  91055. highLimitValue?: any;
  91056. }
  91057. /**
  91058. * Class used to store any kind of animation
  91059. */
  91060. export class Animation {
  91061. /**Name of the animation */
  91062. name: string;
  91063. /**Property to animate */
  91064. targetProperty: string;
  91065. /**The frames per second of the animation */
  91066. framePerSecond: number;
  91067. /**The data type of the animation */
  91068. dataType: number;
  91069. /**The loop mode of the animation */
  91070. loopMode?: number | undefined;
  91071. /**Specifies if blending should be enabled */
  91072. enableBlending?: boolean | undefined;
  91073. /**
  91074. * Use matrix interpolation instead of using direct key value when animating matrices
  91075. */
  91076. static AllowMatricesInterpolation: boolean;
  91077. /**
  91078. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  91079. */
  91080. static AllowMatrixDecomposeForInterpolation: boolean;
  91081. /**
  91082. * Stores the key frames of the animation
  91083. */
  91084. private _keys;
  91085. /**
  91086. * Stores the easing function of the animation
  91087. */
  91088. private _easingFunction;
  91089. /**
  91090. * @hidden Internal use only
  91091. */
  91092. _runtimeAnimations: RuntimeAnimation[];
  91093. /**
  91094. * The set of event that will be linked to this animation
  91095. */
  91096. private _events;
  91097. /**
  91098. * Stores an array of target property paths
  91099. */
  91100. targetPropertyPath: string[];
  91101. /**
  91102. * Stores the blending speed of the animation
  91103. */
  91104. blendingSpeed: number;
  91105. /**
  91106. * Stores the animation ranges for the animation
  91107. */
  91108. private _ranges;
  91109. /**
  91110. * @hidden Internal use
  91111. */
  91112. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  91113. /**
  91114. * Sets up an animation
  91115. * @param property The property to animate
  91116. * @param animationType The animation type to apply
  91117. * @param framePerSecond The frames per second of the animation
  91118. * @param easingFunction The easing function used in the animation
  91119. * @returns The created animation
  91120. */
  91121. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  91122. /**
  91123. * Create and start an animation on a node
  91124. * @param name defines the name of the global animation that will be run on all nodes
  91125. * @param node defines the root node where the animation will take place
  91126. * @param targetProperty defines property to animate
  91127. * @param framePerSecond defines the number of frame per second yo use
  91128. * @param totalFrame defines the number of frames in total
  91129. * @param from defines the initial value
  91130. * @param to defines the final value
  91131. * @param loopMode defines which loop mode you want to use (off by default)
  91132. * @param easingFunction defines the easing function to use (linear by default)
  91133. * @param onAnimationEnd defines the callback to call when animation end
  91134. * @returns the animatable created for this animation
  91135. */
  91136. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  91137. /**
  91138. * Create and start an animation on a node and its descendants
  91139. * @param name defines the name of the global animation that will be run on all nodes
  91140. * @param node defines the root node where the animation will take place
  91141. * @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
  91142. * @param targetProperty defines property to animate
  91143. * @param framePerSecond defines the number of frame per second to use
  91144. * @param totalFrame defines the number of frames in total
  91145. * @param from defines the initial value
  91146. * @param to defines the final value
  91147. * @param loopMode defines which loop mode you want to use (off by default)
  91148. * @param easingFunction defines the easing function to use (linear by default)
  91149. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  91150. * @returns the list of animatables created for all nodes
  91151. * @example https://www.babylonjs-playground.com/#MH0VLI
  91152. */
  91153. 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[]>;
  91154. /**
  91155. * Creates a new animation, merges it with the existing animations and starts it
  91156. * @param name Name of the animation
  91157. * @param node Node which contains the scene that begins the animations
  91158. * @param targetProperty Specifies which property to animate
  91159. * @param framePerSecond The frames per second of the animation
  91160. * @param totalFrame The total number of frames
  91161. * @param from The frame at the beginning of the animation
  91162. * @param to The frame at the end of the animation
  91163. * @param loopMode Specifies the loop mode of the animation
  91164. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  91165. * @param onAnimationEnd Callback to run once the animation is complete
  91166. * @returns Nullable animation
  91167. */
  91168. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  91169. /**
  91170. * Transition property of an host to the target Value
  91171. * @param property The property to transition
  91172. * @param targetValue The target Value of the property
  91173. * @param host The object where the property to animate belongs
  91174. * @param scene Scene used to run the animation
  91175. * @param frameRate Framerate (in frame/s) to use
  91176. * @param transition The transition type we want to use
  91177. * @param duration The duration of the animation, in milliseconds
  91178. * @param onAnimationEnd Callback trigger at the end of the animation
  91179. * @returns Nullable animation
  91180. */
  91181. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  91182. /**
  91183. * Return the array of runtime animations currently using this animation
  91184. */
  91185. readonly runtimeAnimations: RuntimeAnimation[];
  91186. /**
  91187. * Specifies if any of the runtime animations are currently running
  91188. */
  91189. readonly hasRunningRuntimeAnimations: boolean;
  91190. /**
  91191. * Initializes the animation
  91192. * @param name Name of the animation
  91193. * @param targetProperty Property to animate
  91194. * @param framePerSecond The frames per second of the animation
  91195. * @param dataType The data type of the animation
  91196. * @param loopMode The loop mode of the animation
  91197. * @param enableBlending Specifies if blending should be enabled
  91198. */
  91199. constructor(
  91200. /**Name of the animation */
  91201. name: string,
  91202. /**Property to animate */
  91203. targetProperty: string,
  91204. /**The frames per second of the animation */
  91205. framePerSecond: number,
  91206. /**The data type of the animation */
  91207. dataType: number,
  91208. /**The loop mode of the animation */
  91209. loopMode?: number | undefined,
  91210. /**Specifies if blending should be enabled */
  91211. enableBlending?: boolean | undefined);
  91212. /**
  91213. * Converts the animation to a string
  91214. * @param fullDetails support for multiple levels of logging within scene loading
  91215. * @returns String form of the animation
  91216. */
  91217. toString(fullDetails?: boolean): string;
  91218. /**
  91219. * Add an event to this animation
  91220. * @param event Event to add
  91221. */
  91222. addEvent(event: AnimationEvent): void;
  91223. /**
  91224. * Remove all events found at the given frame
  91225. * @param frame The frame to remove events from
  91226. */
  91227. removeEvents(frame: number): void;
  91228. /**
  91229. * Retrieves all the events from the animation
  91230. * @returns Events from the animation
  91231. */
  91232. getEvents(): AnimationEvent[];
  91233. /**
  91234. * Creates an animation range
  91235. * @param name Name of the animation range
  91236. * @param from Starting frame of the animation range
  91237. * @param to Ending frame of the animation
  91238. */
  91239. createRange(name: string, from: number, to: number): void;
  91240. /**
  91241. * Deletes an animation range by name
  91242. * @param name Name of the animation range to delete
  91243. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  91244. */
  91245. deleteRange(name: string, deleteFrames?: boolean): void;
  91246. /**
  91247. * Gets the animation range by name, or null if not defined
  91248. * @param name Name of the animation range
  91249. * @returns Nullable animation range
  91250. */
  91251. getRange(name: string): Nullable<AnimationRange>;
  91252. /**
  91253. * Gets the key frames from the animation
  91254. * @returns The key frames of the animation
  91255. */
  91256. getKeys(): Array<IAnimationKey>;
  91257. /**
  91258. * Gets the highest frame rate of the animation
  91259. * @returns Highest frame rate of the animation
  91260. */
  91261. getHighestFrame(): number;
  91262. /**
  91263. * Gets the easing function of the animation
  91264. * @returns Easing function of the animation
  91265. */
  91266. getEasingFunction(): IEasingFunction;
  91267. /**
  91268. * Sets the easing function of the animation
  91269. * @param easingFunction A custom mathematical formula for animation
  91270. */
  91271. setEasingFunction(easingFunction: EasingFunction): void;
  91272. /**
  91273. * Interpolates a scalar linearly
  91274. * @param startValue Start value of the animation curve
  91275. * @param endValue End value of the animation curve
  91276. * @param gradient Scalar amount to interpolate
  91277. * @returns Interpolated scalar value
  91278. */
  91279. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  91280. /**
  91281. * Interpolates a scalar cubically
  91282. * @param startValue Start value of the animation curve
  91283. * @param outTangent End tangent of the animation
  91284. * @param endValue End value of the animation curve
  91285. * @param inTangent Start tangent of the animation curve
  91286. * @param gradient Scalar amount to interpolate
  91287. * @returns Interpolated scalar value
  91288. */
  91289. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  91290. /**
  91291. * Interpolates a quaternion using a spherical linear interpolation
  91292. * @param startValue Start value of the animation curve
  91293. * @param endValue End value of the animation curve
  91294. * @param gradient Scalar amount to interpolate
  91295. * @returns Interpolated quaternion value
  91296. */
  91297. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  91298. /**
  91299. * Interpolates a quaternion cubically
  91300. * @param startValue Start value of the animation curve
  91301. * @param outTangent End tangent of the animation curve
  91302. * @param endValue End value of the animation curve
  91303. * @param inTangent Start tangent of the animation curve
  91304. * @param gradient Scalar amount to interpolate
  91305. * @returns Interpolated quaternion value
  91306. */
  91307. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  91308. /**
  91309. * Interpolates a Vector3 linearl
  91310. * @param startValue Start value of the animation curve
  91311. * @param endValue End value of the animation curve
  91312. * @param gradient Scalar amount to interpolate
  91313. * @returns Interpolated scalar value
  91314. */
  91315. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  91316. /**
  91317. * Interpolates a Vector3 cubically
  91318. * @param startValue Start value of the animation curve
  91319. * @param outTangent End tangent of the animation
  91320. * @param endValue End value of the animation curve
  91321. * @param inTangent Start tangent of the animation curve
  91322. * @param gradient Scalar amount to interpolate
  91323. * @returns InterpolatedVector3 value
  91324. */
  91325. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  91326. /**
  91327. * Interpolates a Vector2 linearly
  91328. * @param startValue Start value of the animation curve
  91329. * @param endValue End value of the animation curve
  91330. * @param gradient Scalar amount to interpolate
  91331. * @returns Interpolated Vector2 value
  91332. */
  91333. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  91334. /**
  91335. * Interpolates a Vector2 cubically
  91336. * @param startValue Start value of the animation curve
  91337. * @param outTangent End tangent of the animation
  91338. * @param endValue End value of the animation curve
  91339. * @param inTangent Start tangent of the animation curve
  91340. * @param gradient Scalar amount to interpolate
  91341. * @returns Interpolated Vector2 value
  91342. */
  91343. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  91344. /**
  91345. * Interpolates a size linearly
  91346. * @param startValue Start value of the animation curve
  91347. * @param endValue End value of the animation curve
  91348. * @param gradient Scalar amount to interpolate
  91349. * @returns Interpolated Size value
  91350. */
  91351. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  91352. /**
  91353. * Interpolates a Color3 linearly
  91354. * @param startValue Start value of the animation curve
  91355. * @param endValue End value of the animation curve
  91356. * @param gradient Scalar amount to interpolate
  91357. * @returns Interpolated Color3 value
  91358. */
  91359. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  91360. /**
  91361. * @hidden Internal use only
  91362. */
  91363. _getKeyValue(value: any): any;
  91364. /**
  91365. * @hidden Internal use only
  91366. */
  91367. _interpolate(currentFrame: number, state: _IAnimationState): any;
  91368. /**
  91369. * Defines the function to use to interpolate matrices
  91370. * @param startValue defines the start matrix
  91371. * @param endValue defines the end matrix
  91372. * @param gradient defines the gradient between both matrices
  91373. * @param result defines an optional target matrix where to store the interpolation
  91374. * @returns the interpolated matrix
  91375. */
  91376. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  91377. /**
  91378. * Makes a copy of the animation
  91379. * @returns Cloned animation
  91380. */
  91381. clone(): Animation;
  91382. /**
  91383. * Sets the key frames of the animation
  91384. * @param values The animation key frames to set
  91385. */
  91386. setKeys(values: Array<IAnimationKey>): void;
  91387. /**
  91388. * Serializes the animation to an object
  91389. * @returns Serialized object
  91390. */
  91391. serialize(): any;
  91392. /**
  91393. * Float animation type
  91394. */
  91395. private static _ANIMATIONTYPE_FLOAT;
  91396. /**
  91397. * Vector3 animation type
  91398. */
  91399. private static _ANIMATIONTYPE_VECTOR3;
  91400. /**
  91401. * Quaternion animation type
  91402. */
  91403. private static _ANIMATIONTYPE_QUATERNION;
  91404. /**
  91405. * Matrix animation type
  91406. */
  91407. private static _ANIMATIONTYPE_MATRIX;
  91408. /**
  91409. * Color3 animation type
  91410. */
  91411. private static _ANIMATIONTYPE_COLOR3;
  91412. /**
  91413. * Vector2 animation type
  91414. */
  91415. private static _ANIMATIONTYPE_VECTOR2;
  91416. /**
  91417. * Size animation type
  91418. */
  91419. private static _ANIMATIONTYPE_SIZE;
  91420. /**
  91421. * Relative Loop Mode
  91422. */
  91423. private static _ANIMATIONLOOPMODE_RELATIVE;
  91424. /**
  91425. * Cycle Loop Mode
  91426. */
  91427. private static _ANIMATIONLOOPMODE_CYCLE;
  91428. /**
  91429. * Constant Loop Mode
  91430. */
  91431. private static _ANIMATIONLOOPMODE_CONSTANT;
  91432. /**
  91433. * Get the float animation type
  91434. */
  91435. static readonly ANIMATIONTYPE_FLOAT: number;
  91436. /**
  91437. * Get the Vector3 animation type
  91438. */
  91439. static readonly ANIMATIONTYPE_VECTOR3: number;
  91440. /**
  91441. * Get the Vector2 animation type
  91442. */
  91443. static readonly ANIMATIONTYPE_VECTOR2: number;
  91444. /**
  91445. * Get the Size animation type
  91446. */
  91447. static readonly ANIMATIONTYPE_SIZE: number;
  91448. /**
  91449. * Get the Quaternion animation type
  91450. */
  91451. static readonly ANIMATIONTYPE_QUATERNION: number;
  91452. /**
  91453. * Get the Matrix animation type
  91454. */
  91455. static readonly ANIMATIONTYPE_MATRIX: number;
  91456. /**
  91457. * Get the Color3 animation type
  91458. */
  91459. static readonly ANIMATIONTYPE_COLOR3: number;
  91460. /**
  91461. * Get the Relative Loop Mode
  91462. */
  91463. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  91464. /**
  91465. * Get the Cycle Loop Mode
  91466. */
  91467. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  91468. /**
  91469. * Get the Constant Loop Mode
  91470. */
  91471. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  91472. /** @hidden */
  91473. static _UniversalLerp(left: any, right: any, amount: number): any;
  91474. /**
  91475. * Parses an animation object and creates an animation
  91476. * @param parsedAnimation Parsed animation object
  91477. * @returns Animation object
  91478. */
  91479. static Parse(parsedAnimation: any): Animation;
  91480. /**
  91481. * Appends the serialized animations from the source animations
  91482. * @param source Source containing the animations
  91483. * @param destination Target to store the animations
  91484. */
  91485. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  91486. }
  91487. }
  91488. declare module BABYLON {
  91489. /**
  91490. * Interface containing an array of animations
  91491. */
  91492. export interface IAnimatable {
  91493. /**
  91494. * Array of animations
  91495. */
  91496. animations: Nullable<Array<Animation>>;
  91497. }
  91498. }
  91499. declare module BABYLON {
  91500. /**
  91501. * This represents all the required information to add a fresnel effect on a material:
  91502. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  91503. */
  91504. export class FresnelParameters {
  91505. private _isEnabled;
  91506. /**
  91507. * Define if the fresnel effect is enable or not.
  91508. */
  91509. isEnabled: boolean;
  91510. /**
  91511. * Define the color used on edges (grazing angle)
  91512. */
  91513. leftColor: Color3;
  91514. /**
  91515. * Define the color used on center
  91516. */
  91517. rightColor: Color3;
  91518. /**
  91519. * Define bias applied to computed fresnel term
  91520. */
  91521. bias: number;
  91522. /**
  91523. * Defined the power exponent applied to fresnel term
  91524. */
  91525. power: number;
  91526. /**
  91527. * Clones the current fresnel and its valuues
  91528. * @returns a clone fresnel configuration
  91529. */
  91530. clone(): FresnelParameters;
  91531. /**
  91532. * Serializes the current fresnel parameters to a JSON representation.
  91533. * @return the JSON serialization
  91534. */
  91535. serialize(): any;
  91536. /**
  91537. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  91538. * @param parsedFresnelParameters Define the JSON representation
  91539. * @returns the parsed parameters
  91540. */
  91541. static Parse(parsedFresnelParameters: any): FresnelParameters;
  91542. }
  91543. }
  91544. declare module BABYLON {
  91545. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  91546. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91547. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91548. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91549. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91550. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91551. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91552. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91553. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91554. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91555. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91556. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91557. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91558. /**
  91559. * Decorator used to define property that can be serialized as reference to a camera
  91560. * @param sourceName defines the name of the property to decorate
  91561. */
  91562. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  91563. /**
  91564. * Class used to help serialization objects
  91565. */
  91566. export class SerializationHelper {
  91567. /** @hidden */
  91568. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  91569. /** @hidden */
  91570. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  91571. /** @hidden */
  91572. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  91573. /** @hidden */
  91574. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  91575. /**
  91576. * Appends the serialized animations from the source animations
  91577. * @param source Source containing the animations
  91578. * @param destination Target to store the animations
  91579. */
  91580. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  91581. /**
  91582. * Static function used to serialized a specific entity
  91583. * @param entity defines the entity to serialize
  91584. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  91585. * @returns a JSON compatible object representing the serialization of the entity
  91586. */
  91587. static Serialize<T>(entity: T, serializationObject?: any): any;
  91588. /**
  91589. * Creates a new entity from a serialization data object
  91590. * @param creationFunction defines a function used to instanciated the new entity
  91591. * @param source defines the source serialization data
  91592. * @param scene defines the hosting scene
  91593. * @param rootUrl defines the root url for resources
  91594. * @returns a new entity
  91595. */
  91596. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  91597. /**
  91598. * Clones an object
  91599. * @param creationFunction defines the function used to instanciate the new object
  91600. * @param source defines the source object
  91601. * @returns the cloned object
  91602. */
  91603. static Clone<T>(creationFunction: () => T, source: T): T;
  91604. /**
  91605. * Instanciates a new object based on a source one (some data will be shared between both object)
  91606. * @param creationFunction defines the function used to instanciate the new object
  91607. * @param source defines the source object
  91608. * @returns the new object
  91609. */
  91610. static Instanciate<T>(creationFunction: () => T, source: T): T;
  91611. }
  91612. }
  91613. declare module BABYLON {
  91614. /**
  91615. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  91616. */
  91617. export interface CubeMapInfo {
  91618. /**
  91619. * The pixel array for the front face.
  91620. * This is stored in format, left to right, up to down format.
  91621. */
  91622. front: Nullable<ArrayBufferView>;
  91623. /**
  91624. * The pixel array for the back face.
  91625. * This is stored in format, left to right, up to down format.
  91626. */
  91627. back: Nullable<ArrayBufferView>;
  91628. /**
  91629. * The pixel array for the left face.
  91630. * This is stored in format, left to right, up to down format.
  91631. */
  91632. left: Nullable<ArrayBufferView>;
  91633. /**
  91634. * The pixel array for the right face.
  91635. * This is stored in format, left to right, up to down format.
  91636. */
  91637. right: Nullable<ArrayBufferView>;
  91638. /**
  91639. * The pixel array for the up face.
  91640. * This is stored in format, left to right, up to down format.
  91641. */
  91642. up: Nullable<ArrayBufferView>;
  91643. /**
  91644. * The pixel array for the down face.
  91645. * This is stored in format, left to right, up to down format.
  91646. */
  91647. down: Nullable<ArrayBufferView>;
  91648. /**
  91649. * The size of the cubemap stored.
  91650. *
  91651. * Each faces will be size * size pixels.
  91652. */
  91653. size: number;
  91654. /**
  91655. * The format of the texture.
  91656. *
  91657. * RGBA, RGB.
  91658. */
  91659. format: number;
  91660. /**
  91661. * The type of the texture data.
  91662. *
  91663. * UNSIGNED_INT, FLOAT.
  91664. */
  91665. type: number;
  91666. /**
  91667. * Specifies whether the texture is in gamma space.
  91668. */
  91669. gammaSpace: boolean;
  91670. }
  91671. /**
  91672. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  91673. */
  91674. export class PanoramaToCubeMapTools {
  91675. private static FACE_FRONT;
  91676. private static FACE_BACK;
  91677. private static FACE_RIGHT;
  91678. private static FACE_LEFT;
  91679. private static FACE_DOWN;
  91680. private static FACE_UP;
  91681. /**
  91682. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  91683. *
  91684. * @param float32Array The source data.
  91685. * @param inputWidth The width of the input panorama.
  91686. * @param inputHeight The height of the input panorama.
  91687. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  91688. * @return The cubemap data
  91689. */
  91690. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  91691. private static CreateCubemapTexture;
  91692. private static CalcProjectionSpherical;
  91693. }
  91694. }
  91695. declare module BABYLON {
  91696. /**
  91697. * Helper class dealing with the extraction of spherical polynomial dataArray
  91698. * from a cube map.
  91699. */
  91700. export class CubeMapToSphericalPolynomialTools {
  91701. private static FileFaces;
  91702. /**
  91703. * Converts a texture to the according Spherical Polynomial data.
  91704. * This extracts the first 3 orders only as they are the only one used in the lighting.
  91705. *
  91706. * @param texture The texture to extract the information from.
  91707. * @return The Spherical Polynomial data.
  91708. */
  91709. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  91710. /**
  91711. * Converts a cubemap to the according Spherical Polynomial data.
  91712. * This extracts the first 3 orders only as they are the only one used in the lighting.
  91713. *
  91714. * @param cubeInfo The Cube map to extract the information from.
  91715. * @return The Spherical Polynomial data.
  91716. */
  91717. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  91718. }
  91719. }
  91720. declare module BABYLON {
  91721. /**
  91722. * Class used to manipulate GUIDs
  91723. */
  91724. export class GUID {
  91725. /**
  91726. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  91727. * Be aware Math.random() could cause collisions, but:
  91728. * "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"
  91729. * @returns a pseudo random id
  91730. */
  91731. static RandomId(): string;
  91732. }
  91733. }
  91734. declare module BABYLON {
  91735. /**
  91736. * Base class of all the textures in babylon.
  91737. * It groups all the common properties the materials, post process, lights... might need
  91738. * in order to make a correct use of the texture.
  91739. */
  91740. export class BaseTexture implements IAnimatable {
  91741. /**
  91742. * Default anisotropic filtering level for the application.
  91743. * It is set to 4 as a good tradeoff between perf and quality.
  91744. */
  91745. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  91746. /**
  91747. * Gets or sets the unique id of the texture
  91748. */
  91749. uniqueId: number;
  91750. /**
  91751. * Define the name of the texture.
  91752. */
  91753. name: string;
  91754. /**
  91755. * Gets or sets an object used to store user defined information.
  91756. */
  91757. metadata: any;
  91758. /**
  91759. * For internal use only. Please do not use.
  91760. */
  91761. reservedDataStore: any;
  91762. private _hasAlpha;
  91763. /**
  91764. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  91765. */
  91766. hasAlpha: boolean;
  91767. /**
  91768. * Defines if the alpha value should be determined via the rgb values.
  91769. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  91770. */
  91771. getAlphaFromRGB: boolean;
  91772. /**
  91773. * Intensity or strength of the texture.
  91774. * It is commonly used by materials to fine tune the intensity of the texture
  91775. */
  91776. level: number;
  91777. /**
  91778. * Define the UV chanel to use starting from 0 and defaulting to 0.
  91779. * This is part of the texture as textures usually maps to one uv set.
  91780. */
  91781. coordinatesIndex: number;
  91782. private _coordinatesMode;
  91783. /**
  91784. * How a texture is mapped.
  91785. *
  91786. * | Value | Type | Description |
  91787. * | ----- | ----------------------------------- | ----------- |
  91788. * | 0 | EXPLICIT_MODE | |
  91789. * | 1 | SPHERICAL_MODE | |
  91790. * | 2 | PLANAR_MODE | |
  91791. * | 3 | CUBIC_MODE | |
  91792. * | 4 | PROJECTION_MODE | |
  91793. * | 5 | SKYBOX_MODE | |
  91794. * | 6 | INVCUBIC_MODE | |
  91795. * | 7 | EQUIRECTANGULAR_MODE | |
  91796. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  91797. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  91798. */
  91799. coordinatesMode: number;
  91800. /**
  91801. * | Value | Type | Description |
  91802. * | ----- | ------------------ | ----------- |
  91803. * | 0 | CLAMP_ADDRESSMODE | |
  91804. * | 1 | WRAP_ADDRESSMODE | |
  91805. * | 2 | MIRROR_ADDRESSMODE | |
  91806. */
  91807. wrapU: number;
  91808. /**
  91809. * | Value | Type | Description |
  91810. * | ----- | ------------------ | ----------- |
  91811. * | 0 | CLAMP_ADDRESSMODE | |
  91812. * | 1 | WRAP_ADDRESSMODE | |
  91813. * | 2 | MIRROR_ADDRESSMODE | |
  91814. */
  91815. wrapV: number;
  91816. /**
  91817. * | Value | Type | Description |
  91818. * | ----- | ------------------ | ----------- |
  91819. * | 0 | CLAMP_ADDRESSMODE | |
  91820. * | 1 | WRAP_ADDRESSMODE | |
  91821. * | 2 | MIRROR_ADDRESSMODE | |
  91822. */
  91823. wrapR: number;
  91824. /**
  91825. * With compliant hardware and browser (supporting anisotropic filtering)
  91826. * this defines the level of anisotropic filtering in the texture.
  91827. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  91828. */
  91829. anisotropicFilteringLevel: number;
  91830. /**
  91831. * Define if the texture is a cube texture or if false a 2d texture.
  91832. */
  91833. isCube: boolean;
  91834. /**
  91835. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  91836. */
  91837. is3D: boolean;
  91838. /**
  91839. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  91840. * HDR texture are usually stored in linear space.
  91841. * This only impacts the PBR and Background materials
  91842. */
  91843. gammaSpace: boolean;
  91844. /**
  91845. * Gets whether or not the texture contains RGBD data.
  91846. */
  91847. readonly isRGBD: boolean;
  91848. /**
  91849. * Is Z inverted in the texture (useful in a cube texture).
  91850. */
  91851. invertZ: boolean;
  91852. /**
  91853. * Are mip maps generated for this texture or not.
  91854. */
  91855. readonly noMipmap: boolean;
  91856. /**
  91857. * @hidden
  91858. */
  91859. lodLevelInAlpha: boolean;
  91860. /**
  91861. * With prefiltered texture, defined the offset used during the prefiltering steps.
  91862. */
  91863. lodGenerationOffset: number;
  91864. /**
  91865. * With prefiltered texture, defined the scale used during the prefiltering steps.
  91866. */
  91867. lodGenerationScale: number;
  91868. /**
  91869. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  91870. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  91871. * average roughness values.
  91872. */
  91873. linearSpecularLOD: boolean;
  91874. /**
  91875. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  91876. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  91877. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  91878. */
  91879. irradianceTexture: Nullable<BaseTexture>;
  91880. /**
  91881. * Define if the texture is a render target.
  91882. */
  91883. isRenderTarget: boolean;
  91884. /**
  91885. * Define the unique id of the texture in the scene.
  91886. */
  91887. readonly uid: string;
  91888. /**
  91889. * Return a string representation of the texture.
  91890. * @returns the texture as a string
  91891. */
  91892. toString(): string;
  91893. /**
  91894. * Get the class name of the texture.
  91895. * @returns "BaseTexture"
  91896. */
  91897. getClassName(): string;
  91898. /**
  91899. * Define the list of animation attached to the texture.
  91900. */
  91901. animations: Animation[];
  91902. /**
  91903. * An event triggered when the texture is disposed.
  91904. */
  91905. onDisposeObservable: Observable<BaseTexture>;
  91906. private _onDisposeObserver;
  91907. /**
  91908. * Callback triggered when the texture has been disposed.
  91909. * Kept for back compatibility, you can use the onDisposeObservable instead.
  91910. */
  91911. onDispose: () => void;
  91912. /**
  91913. * Define the current state of the loading sequence when in delayed load mode.
  91914. */
  91915. delayLoadState: number;
  91916. private _scene;
  91917. /** @hidden */
  91918. _texture: Nullable<InternalTexture>;
  91919. private _uid;
  91920. /**
  91921. * Define if the texture is preventinga material to render or not.
  91922. * If not and the texture is not ready, the engine will use a default black texture instead.
  91923. */
  91924. readonly isBlocking: boolean;
  91925. /**
  91926. * Instantiates a new BaseTexture.
  91927. * Base class of all the textures in babylon.
  91928. * It groups all the common properties the materials, post process, lights... might need
  91929. * in order to make a correct use of the texture.
  91930. * @param scene Define the scene the texture blongs to
  91931. */
  91932. constructor(scene: Nullable<Scene>);
  91933. /**
  91934. * Get the scene the texture belongs to.
  91935. * @returns the scene or null if undefined
  91936. */
  91937. getScene(): Nullable<Scene>;
  91938. /**
  91939. * Get the texture transform matrix used to offset tile the texture for istance.
  91940. * @returns the transformation matrix
  91941. */
  91942. getTextureMatrix(): Matrix;
  91943. /**
  91944. * Get the texture reflection matrix used to rotate/transform the reflection.
  91945. * @returns the reflection matrix
  91946. */
  91947. getReflectionTextureMatrix(): Matrix;
  91948. /**
  91949. * Get the underlying lower level texture from Babylon.
  91950. * @returns the insternal texture
  91951. */
  91952. getInternalTexture(): Nullable<InternalTexture>;
  91953. /**
  91954. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  91955. * @returns true if ready or not blocking
  91956. */
  91957. isReadyOrNotBlocking(): boolean;
  91958. /**
  91959. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  91960. * @returns true if fully ready
  91961. */
  91962. isReady(): boolean;
  91963. private _cachedSize;
  91964. /**
  91965. * Get the size of the texture.
  91966. * @returns the texture size.
  91967. */
  91968. getSize(): ISize;
  91969. /**
  91970. * Get the base size of the texture.
  91971. * It can be different from the size if the texture has been resized for POT for instance
  91972. * @returns the base size
  91973. */
  91974. getBaseSize(): ISize;
  91975. /**
  91976. * Update the sampling mode of the texture.
  91977. * Default is Trilinear mode.
  91978. *
  91979. * | Value | Type | Description |
  91980. * | ----- | ------------------ | ----------- |
  91981. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  91982. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  91983. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  91984. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  91985. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  91986. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  91987. * | 7 | NEAREST_LINEAR | |
  91988. * | 8 | NEAREST_NEAREST | |
  91989. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  91990. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  91991. * | 11 | LINEAR_LINEAR | |
  91992. * | 12 | LINEAR_NEAREST | |
  91993. *
  91994. * > _mag_: magnification filter (close to the viewer)
  91995. * > _min_: minification filter (far from the viewer)
  91996. * > _mip_: filter used between mip map levels
  91997. *@param samplingMode Define the new sampling mode of the texture
  91998. */
  91999. updateSamplingMode(samplingMode: number): void;
  92000. /**
  92001. * Scales the texture if is `canRescale()`
  92002. * @param ratio the resize factor we want to use to rescale
  92003. */
  92004. scale(ratio: number): void;
  92005. /**
  92006. * Get if the texture can rescale.
  92007. */
  92008. readonly canRescale: boolean;
  92009. /** @hidden */
  92010. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  92011. /** @hidden */
  92012. _rebuild(): void;
  92013. /**
  92014. * Triggers the load sequence in delayed load mode.
  92015. */
  92016. delayLoad(): void;
  92017. /**
  92018. * Clones the texture.
  92019. * @returns the cloned texture
  92020. */
  92021. clone(): Nullable<BaseTexture>;
  92022. /**
  92023. * Get the texture underlying type (INT, FLOAT...)
  92024. */
  92025. readonly textureType: number;
  92026. /**
  92027. * Get the texture underlying format (RGB, RGBA...)
  92028. */
  92029. readonly textureFormat: number;
  92030. /**
  92031. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  92032. * This will returns an RGBA array buffer containing either in values (0-255) or
  92033. * float values (0-1) depending of the underlying buffer type.
  92034. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  92035. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  92036. * @param buffer defines a user defined buffer to fill with data (can be null)
  92037. * @returns The Array buffer containing the pixels data.
  92038. */
  92039. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  92040. /**
  92041. * Release and destroy the underlying lower level texture aka internalTexture.
  92042. */
  92043. releaseInternalTexture(): void;
  92044. /**
  92045. * Get the polynomial representation of the texture data.
  92046. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  92047. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  92048. */
  92049. sphericalPolynomial: Nullable<SphericalPolynomial>;
  92050. /** @hidden */
  92051. readonly _lodTextureHigh: Nullable<BaseTexture>;
  92052. /** @hidden */
  92053. readonly _lodTextureMid: Nullable<BaseTexture>;
  92054. /** @hidden */
  92055. readonly _lodTextureLow: Nullable<BaseTexture>;
  92056. /**
  92057. * Dispose the texture and release its associated resources.
  92058. */
  92059. dispose(): void;
  92060. /**
  92061. * Serialize the texture into a JSON representation that can be parsed later on.
  92062. * @returns the JSON representation of the texture
  92063. */
  92064. serialize(): any;
  92065. /**
  92066. * Helper function to be called back once a list of texture contains only ready textures.
  92067. * @param textures Define the list of textures to wait for
  92068. * @param callback Define the callback triggered once the entire list will be ready
  92069. */
  92070. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  92071. }
  92072. }
  92073. declare module BABYLON {
  92074. /**
  92075. * Class used to store data associated with WebGL texture data for the engine
  92076. * This class should not be used directly
  92077. */
  92078. export class InternalTexture {
  92079. /** @hidden */
  92080. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  92081. /**
  92082. * The source of the texture data is unknown
  92083. */
  92084. static DATASOURCE_UNKNOWN: number;
  92085. /**
  92086. * Texture data comes from an URL
  92087. */
  92088. static DATASOURCE_URL: number;
  92089. /**
  92090. * Texture data is only used for temporary storage
  92091. */
  92092. static DATASOURCE_TEMP: number;
  92093. /**
  92094. * Texture data comes from raw data (ArrayBuffer)
  92095. */
  92096. static DATASOURCE_RAW: number;
  92097. /**
  92098. * Texture content is dynamic (video or dynamic texture)
  92099. */
  92100. static DATASOURCE_DYNAMIC: number;
  92101. /**
  92102. * Texture content is generated by rendering to it
  92103. */
  92104. static DATASOURCE_RENDERTARGET: number;
  92105. /**
  92106. * Texture content is part of a multi render target process
  92107. */
  92108. static DATASOURCE_MULTIRENDERTARGET: number;
  92109. /**
  92110. * Texture data comes from a cube data file
  92111. */
  92112. static DATASOURCE_CUBE: number;
  92113. /**
  92114. * Texture data comes from a raw cube data
  92115. */
  92116. static DATASOURCE_CUBERAW: number;
  92117. /**
  92118. * Texture data come from a prefiltered cube data file
  92119. */
  92120. static DATASOURCE_CUBEPREFILTERED: number;
  92121. /**
  92122. * Texture content is raw 3D data
  92123. */
  92124. static DATASOURCE_RAW3D: number;
  92125. /**
  92126. * Texture content is a depth texture
  92127. */
  92128. static DATASOURCE_DEPTHTEXTURE: number;
  92129. /**
  92130. * Texture data comes from a raw cube data encoded with RGBD
  92131. */
  92132. static DATASOURCE_CUBERAW_RGBD: number;
  92133. /**
  92134. * Defines if the texture is ready
  92135. */
  92136. isReady: boolean;
  92137. /**
  92138. * Defines if the texture is a cube texture
  92139. */
  92140. isCube: boolean;
  92141. /**
  92142. * Defines if the texture contains 3D data
  92143. */
  92144. is3D: boolean;
  92145. /**
  92146. * Defines if the texture contains multiview data
  92147. */
  92148. isMultiview: boolean;
  92149. /**
  92150. * Gets the URL used to load this texture
  92151. */
  92152. url: string;
  92153. /**
  92154. * Gets the sampling mode of the texture
  92155. */
  92156. samplingMode: number;
  92157. /**
  92158. * Gets a boolean indicating if the texture needs mipmaps generation
  92159. */
  92160. generateMipMaps: boolean;
  92161. /**
  92162. * Gets the number of samples used by the texture (WebGL2+ only)
  92163. */
  92164. samples: number;
  92165. /**
  92166. * Gets the type of the texture (int, float...)
  92167. */
  92168. type: number;
  92169. /**
  92170. * Gets the format of the texture (RGB, RGBA...)
  92171. */
  92172. format: number;
  92173. /**
  92174. * Observable called when the texture is loaded
  92175. */
  92176. onLoadedObservable: Observable<InternalTexture>;
  92177. /**
  92178. * Gets the width of the texture
  92179. */
  92180. width: number;
  92181. /**
  92182. * Gets the height of the texture
  92183. */
  92184. height: number;
  92185. /**
  92186. * Gets the depth of the texture
  92187. */
  92188. depth: number;
  92189. /**
  92190. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  92191. */
  92192. baseWidth: number;
  92193. /**
  92194. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  92195. */
  92196. baseHeight: number;
  92197. /**
  92198. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  92199. */
  92200. baseDepth: number;
  92201. /**
  92202. * Gets a boolean indicating if the texture is inverted on Y axis
  92203. */
  92204. invertY: boolean;
  92205. /** @hidden */
  92206. _invertVScale: boolean;
  92207. /** @hidden */
  92208. _associatedChannel: number;
  92209. /** @hidden */
  92210. _dataSource: number;
  92211. /** @hidden */
  92212. _buffer: Nullable<string | ArrayBuffer | HTMLImageElement | Blob>;
  92213. /** @hidden */
  92214. _bufferView: Nullable<ArrayBufferView>;
  92215. /** @hidden */
  92216. _bufferViewArray: Nullable<ArrayBufferView[]>;
  92217. /** @hidden */
  92218. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  92219. /** @hidden */
  92220. _size: number;
  92221. /** @hidden */
  92222. _extension: string;
  92223. /** @hidden */
  92224. _files: Nullable<string[]>;
  92225. /** @hidden */
  92226. _workingCanvas: Nullable<HTMLCanvasElement>;
  92227. /** @hidden */
  92228. _workingContext: Nullable<CanvasRenderingContext2D>;
  92229. /** @hidden */
  92230. _framebuffer: Nullable<WebGLFramebuffer>;
  92231. /** @hidden */
  92232. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  92233. /** @hidden */
  92234. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  92235. /** @hidden */
  92236. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  92237. /** @hidden */
  92238. _attachments: Nullable<number[]>;
  92239. /** @hidden */
  92240. _cachedCoordinatesMode: Nullable<number>;
  92241. /** @hidden */
  92242. _cachedWrapU: Nullable<number>;
  92243. /** @hidden */
  92244. _cachedWrapV: Nullable<number>;
  92245. /** @hidden */
  92246. _cachedWrapR: Nullable<number>;
  92247. /** @hidden */
  92248. _cachedAnisotropicFilteringLevel: Nullable<number>;
  92249. /** @hidden */
  92250. _isDisabled: boolean;
  92251. /** @hidden */
  92252. _compression: Nullable<string>;
  92253. /** @hidden */
  92254. _generateStencilBuffer: boolean;
  92255. /** @hidden */
  92256. _generateDepthBuffer: boolean;
  92257. /** @hidden */
  92258. _comparisonFunction: number;
  92259. /** @hidden */
  92260. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  92261. /** @hidden */
  92262. _lodGenerationScale: number;
  92263. /** @hidden */
  92264. _lodGenerationOffset: number;
  92265. /** @hidden */
  92266. _colorTextureArray: Nullable<WebGLTexture>;
  92267. /** @hidden */
  92268. _depthStencilTextureArray: Nullable<WebGLTexture>;
  92269. /** @hidden */
  92270. _lodTextureHigh: Nullable<BaseTexture>;
  92271. /** @hidden */
  92272. _lodTextureMid: Nullable<BaseTexture>;
  92273. /** @hidden */
  92274. _lodTextureLow: Nullable<BaseTexture>;
  92275. /** @hidden */
  92276. _isRGBD: boolean;
  92277. /** @hidden */
  92278. _linearSpecularLOD: boolean;
  92279. /** @hidden */
  92280. _irradianceTexture: Nullable<BaseTexture>;
  92281. /** @hidden */
  92282. _webGLTexture: Nullable<WebGLTexture>;
  92283. /** @hidden */
  92284. _references: number;
  92285. private _engine;
  92286. /**
  92287. * Gets the Engine the texture belongs to.
  92288. * @returns The babylon engine
  92289. */
  92290. getEngine(): Engine;
  92291. /**
  92292. * Gets the data source type of the texture (can be one of the InternalTexture.DATASOURCE_XXXX)
  92293. */
  92294. readonly dataSource: number;
  92295. /**
  92296. * Creates a new InternalTexture
  92297. * @param engine defines the engine to use
  92298. * @param dataSource defines the type of data that will be used
  92299. * @param delayAllocation if the texture allocation should be delayed (default: false)
  92300. */
  92301. constructor(engine: Engine, dataSource: number, delayAllocation?: boolean);
  92302. /**
  92303. * Increments the number of references (ie. the number of Texture that point to it)
  92304. */
  92305. incrementReferences(): void;
  92306. /**
  92307. * Change the size of the texture (not the size of the content)
  92308. * @param width defines the new width
  92309. * @param height defines the new height
  92310. * @param depth defines the new depth (1 by default)
  92311. */
  92312. updateSize(width: int, height: int, depth?: int): void;
  92313. /** @hidden */
  92314. _rebuild(): void;
  92315. /** @hidden */
  92316. _swapAndDie(target: InternalTexture): void;
  92317. /**
  92318. * Dispose the current allocated resources
  92319. */
  92320. dispose(): void;
  92321. }
  92322. }
  92323. declare module BABYLON {
  92324. /**
  92325. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  92326. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  92327. */
  92328. export class EffectFallbacks {
  92329. private _defines;
  92330. private _currentRank;
  92331. private _maxRank;
  92332. private _mesh;
  92333. /**
  92334. * Removes the fallback from the bound mesh.
  92335. */
  92336. unBindMesh(): void;
  92337. /**
  92338. * Adds a fallback on the specified property.
  92339. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  92340. * @param define The name of the define in the shader
  92341. */
  92342. addFallback(rank: number, define: string): void;
  92343. /**
  92344. * Sets the mesh to use CPU skinning when needing to fallback.
  92345. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  92346. * @param mesh The mesh to use the fallbacks.
  92347. */
  92348. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  92349. /**
  92350. * Checks to see if more fallbacks are still availible.
  92351. */
  92352. readonly isMoreFallbacks: boolean;
  92353. /**
  92354. * Removes the defines that should be removed when falling back.
  92355. * @param currentDefines defines the current define statements for the shader.
  92356. * @param effect defines the current effect we try to compile
  92357. * @returns The resulting defines with defines of the current rank removed.
  92358. */
  92359. reduce(currentDefines: string, effect: Effect): string;
  92360. }
  92361. /**
  92362. * Options to be used when creating an effect.
  92363. */
  92364. export class EffectCreationOptions {
  92365. /**
  92366. * Atrributes that will be used in the shader.
  92367. */
  92368. attributes: string[];
  92369. /**
  92370. * Uniform varible names that will be set in the shader.
  92371. */
  92372. uniformsNames: string[];
  92373. /**
  92374. * Uniform buffer varible names that will be set in the shader.
  92375. */
  92376. uniformBuffersNames: string[];
  92377. /**
  92378. * Sampler texture variable names that will be set in the shader.
  92379. */
  92380. samplers: string[];
  92381. /**
  92382. * Define statements that will be set in the shader.
  92383. */
  92384. defines: any;
  92385. /**
  92386. * Possible fallbacks for this effect to improve performance when needed.
  92387. */
  92388. fallbacks: Nullable<EffectFallbacks>;
  92389. /**
  92390. * Callback that will be called when the shader is compiled.
  92391. */
  92392. onCompiled: Nullable<(effect: Effect) => void>;
  92393. /**
  92394. * Callback that will be called if an error occurs during shader compilation.
  92395. */
  92396. onError: Nullable<(effect: Effect, errors: string) => void>;
  92397. /**
  92398. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  92399. */
  92400. indexParameters: any;
  92401. /**
  92402. * Max number of lights that can be used in the shader.
  92403. */
  92404. maxSimultaneousLights: number;
  92405. /**
  92406. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  92407. */
  92408. transformFeedbackVaryings: Nullable<string[]>;
  92409. }
  92410. /**
  92411. * Effect containing vertex and fragment shader that can be executed on an object.
  92412. */
  92413. export class Effect implements IDisposable {
  92414. /**
  92415. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  92416. */
  92417. static ShadersRepository: string;
  92418. /**
  92419. * Name of the effect.
  92420. */
  92421. name: any;
  92422. /**
  92423. * String container all the define statements that should be set on the shader.
  92424. */
  92425. defines: string;
  92426. /**
  92427. * Callback that will be called when the shader is compiled.
  92428. */
  92429. onCompiled: Nullable<(effect: Effect) => void>;
  92430. /**
  92431. * Callback that will be called if an error occurs during shader compilation.
  92432. */
  92433. onError: Nullable<(effect: Effect, errors: string) => void>;
  92434. /**
  92435. * Callback that will be called when effect is bound.
  92436. */
  92437. onBind: Nullable<(effect: Effect) => void>;
  92438. /**
  92439. * Unique ID of the effect.
  92440. */
  92441. uniqueId: number;
  92442. /**
  92443. * Observable that will be called when the shader is compiled.
  92444. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  92445. */
  92446. onCompileObservable: Observable<Effect>;
  92447. /**
  92448. * Observable that will be called if an error occurs during shader compilation.
  92449. */
  92450. onErrorObservable: Observable<Effect>;
  92451. /** @hidden */
  92452. _onBindObservable: Nullable<Observable<Effect>>;
  92453. /**
  92454. * Observable that will be called when effect is bound.
  92455. */
  92456. readonly onBindObservable: Observable<Effect>;
  92457. /** @hidden */
  92458. _bonesComputationForcedToCPU: boolean;
  92459. private static _uniqueIdSeed;
  92460. private _engine;
  92461. private _uniformBuffersNames;
  92462. private _uniformsNames;
  92463. private _samplerList;
  92464. private _samplers;
  92465. private _isReady;
  92466. private _compilationError;
  92467. private _attributesNames;
  92468. private _attributes;
  92469. private _uniforms;
  92470. /**
  92471. * Key for the effect.
  92472. * @hidden
  92473. */
  92474. _key: string;
  92475. private _indexParameters;
  92476. private _fallbacks;
  92477. private _vertexSourceCode;
  92478. private _fragmentSourceCode;
  92479. private _vertexSourceCodeOverride;
  92480. private _fragmentSourceCodeOverride;
  92481. private _transformFeedbackVaryings;
  92482. /**
  92483. * Compiled shader to webGL program.
  92484. * @hidden
  92485. */
  92486. _pipelineContext: Nullable<IPipelineContext>;
  92487. private _valueCache;
  92488. private static _baseCache;
  92489. /**
  92490. * Instantiates an effect.
  92491. * An effect can be used to create/manage/execute vertex and fragment shaders.
  92492. * @param baseName Name of the effect.
  92493. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  92494. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  92495. * @param samplers List of sampler variables that will be passed to the shader.
  92496. * @param engine Engine to be used to render the effect
  92497. * @param defines Define statements to be added to the shader.
  92498. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  92499. * @param onCompiled Callback that will be called when the shader is compiled.
  92500. * @param onError Callback that will be called if an error occurs during shader compilation.
  92501. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  92502. */
  92503. constructor(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: Nullable<string[]>, engine?: Engine, defines?: Nullable<string>, fallbacks?: Nullable<EffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  92504. private _useFinalCode;
  92505. /**
  92506. * Unique key for this effect
  92507. */
  92508. readonly key: string;
  92509. /**
  92510. * If the effect has been compiled and prepared.
  92511. * @returns if the effect is compiled and prepared.
  92512. */
  92513. isReady(): boolean;
  92514. /**
  92515. * The engine the effect was initialized with.
  92516. * @returns the engine.
  92517. */
  92518. getEngine(): Engine;
  92519. /**
  92520. * The pipeline context for this effect
  92521. * @returns the associated pipeline context
  92522. */
  92523. getPipelineContext(): Nullable<IPipelineContext>;
  92524. /**
  92525. * The set of names of attribute variables for the shader.
  92526. * @returns An array of attribute names.
  92527. */
  92528. getAttributesNames(): string[];
  92529. /**
  92530. * Returns the attribute at the given index.
  92531. * @param index The index of the attribute.
  92532. * @returns The location of the attribute.
  92533. */
  92534. getAttributeLocation(index: number): number;
  92535. /**
  92536. * Returns the attribute based on the name of the variable.
  92537. * @param name of the attribute to look up.
  92538. * @returns the attribute location.
  92539. */
  92540. getAttributeLocationByName(name: string): number;
  92541. /**
  92542. * The number of attributes.
  92543. * @returns the numnber of attributes.
  92544. */
  92545. getAttributesCount(): number;
  92546. /**
  92547. * Gets the index of a uniform variable.
  92548. * @param uniformName of the uniform to look up.
  92549. * @returns the index.
  92550. */
  92551. getUniformIndex(uniformName: string): number;
  92552. /**
  92553. * Returns the attribute based on the name of the variable.
  92554. * @param uniformName of the uniform to look up.
  92555. * @returns the location of the uniform.
  92556. */
  92557. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  92558. /**
  92559. * Returns an array of sampler variable names
  92560. * @returns The array of sampler variable neames.
  92561. */
  92562. getSamplers(): string[];
  92563. /**
  92564. * The error from the last compilation.
  92565. * @returns the error string.
  92566. */
  92567. getCompilationError(): string;
  92568. /**
  92569. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  92570. * @param func The callback to be used.
  92571. */
  92572. executeWhenCompiled(func: (effect: Effect) => void): void;
  92573. private _checkIsReady;
  92574. /** @hidden */
  92575. _loadVertexShader(vertex: any, callback: (data: any) => void): void;
  92576. /** @hidden */
  92577. _loadFragmentShader(fragment: any, callback: (data: any) => void): void;
  92578. /** @hidden */
  92579. _dumpShadersSource(vertexCode: string, fragmentCode: string, defines: string): void;
  92580. /**
  92581. * Recompiles the webGL program
  92582. * @param vertexSourceCode The source code for the vertex shader.
  92583. * @param fragmentSourceCode The source code for the fragment shader.
  92584. * @param onCompiled Callback called when completed.
  92585. * @param onError Callback called on error.
  92586. * @hidden
  92587. */
  92588. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  92589. /**
  92590. * Prepares the effect
  92591. * @hidden
  92592. */
  92593. _prepareEffect(): void;
  92594. /**
  92595. * Checks if the effect is supported. (Must be called after compilation)
  92596. */
  92597. readonly isSupported: boolean;
  92598. /**
  92599. * Binds a texture to the engine to be used as output of the shader.
  92600. * @param channel Name of the output variable.
  92601. * @param texture Texture to bind.
  92602. * @hidden
  92603. */
  92604. _bindTexture(channel: string, texture: InternalTexture): void;
  92605. /**
  92606. * Sets a texture on the engine to be used in the shader.
  92607. * @param channel Name of the sampler variable.
  92608. * @param texture Texture to set.
  92609. */
  92610. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  92611. /**
  92612. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  92613. * @param channel Name of the sampler variable.
  92614. * @param texture Texture to set.
  92615. */
  92616. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  92617. /**
  92618. * Sets an array of textures on the engine to be used in the shader.
  92619. * @param channel Name of the variable.
  92620. * @param textures Textures to set.
  92621. */
  92622. setTextureArray(channel: string, textures: BaseTexture[]): void;
  92623. /**
  92624. * 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)
  92625. * @param channel Name of the sampler variable.
  92626. * @param postProcess Post process to get the input texture from.
  92627. */
  92628. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  92629. /**
  92630. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  92631. * 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)
  92632. * @param channel Name of the sampler variable.
  92633. * @param postProcess Post process to get the output texture from.
  92634. */
  92635. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  92636. /** @hidden */
  92637. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  92638. /** @hidden */
  92639. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  92640. /** @hidden */
  92641. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  92642. /** @hidden */
  92643. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  92644. /**
  92645. * Binds a buffer to a uniform.
  92646. * @param buffer Buffer to bind.
  92647. * @param name Name of the uniform variable to bind to.
  92648. */
  92649. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  92650. /**
  92651. * Binds block to a uniform.
  92652. * @param blockName Name of the block to bind.
  92653. * @param index Index to bind.
  92654. */
  92655. bindUniformBlock(blockName: string, index: number): void;
  92656. /**
  92657. * Sets an interger value on a uniform variable.
  92658. * @param uniformName Name of the variable.
  92659. * @param value Value to be set.
  92660. * @returns this effect.
  92661. */
  92662. setInt(uniformName: string, value: number): Effect;
  92663. /**
  92664. * Sets an int array on a uniform variable.
  92665. * @param uniformName Name of the variable.
  92666. * @param array array to be set.
  92667. * @returns this effect.
  92668. */
  92669. setIntArray(uniformName: string, array: Int32Array): Effect;
  92670. /**
  92671. * 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)
  92672. * @param uniformName Name of the variable.
  92673. * @param array array to be set.
  92674. * @returns this effect.
  92675. */
  92676. setIntArray2(uniformName: string, array: Int32Array): Effect;
  92677. /**
  92678. * 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)
  92679. * @param uniformName Name of the variable.
  92680. * @param array array to be set.
  92681. * @returns this effect.
  92682. */
  92683. setIntArray3(uniformName: string, array: Int32Array): Effect;
  92684. /**
  92685. * 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)
  92686. * @param uniformName Name of the variable.
  92687. * @param array array to be set.
  92688. * @returns this effect.
  92689. */
  92690. setIntArray4(uniformName: string, array: Int32Array): Effect;
  92691. /**
  92692. * Sets an float array on a uniform variable.
  92693. * @param uniformName Name of the variable.
  92694. * @param array array to be set.
  92695. * @returns this effect.
  92696. */
  92697. setFloatArray(uniformName: string, array: Float32Array): Effect;
  92698. /**
  92699. * 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)
  92700. * @param uniformName Name of the variable.
  92701. * @param array array to be set.
  92702. * @returns this effect.
  92703. */
  92704. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  92705. /**
  92706. * 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)
  92707. * @param uniformName Name of the variable.
  92708. * @param array array to be set.
  92709. * @returns this effect.
  92710. */
  92711. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  92712. /**
  92713. * 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)
  92714. * @param uniformName Name of the variable.
  92715. * @param array array to be set.
  92716. * @returns this effect.
  92717. */
  92718. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  92719. /**
  92720. * Sets an array on a uniform variable.
  92721. * @param uniformName Name of the variable.
  92722. * @param array array to be set.
  92723. * @returns this effect.
  92724. */
  92725. setArray(uniformName: string, array: number[]): Effect;
  92726. /**
  92727. * 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)
  92728. * @param uniformName Name of the variable.
  92729. * @param array array to be set.
  92730. * @returns this effect.
  92731. */
  92732. setArray2(uniformName: string, array: number[]): Effect;
  92733. /**
  92734. * 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)
  92735. * @param uniformName Name of the variable.
  92736. * @param array array to be set.
  92737. * @returns this effect.
  92738. */
  92739. setArray3(uniformName: string, array: number[]): Effect;
  92740. /**
  92741. * 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)
  92742. * @param uniformName Name of the variable.
  92743. * @param array array to be set.
  92744. * @returns this effect.
  92745. */
  92746. setArray4(uniformName: string, array: number[]): Effect;
  92747. /**
  92748. * Sets matrices on a uniform variable.
  92749. * @param uniformName Name of the variable.
  92750. * @param matrices matrices to be set.
  92751. * @returns this effect.
  92752. */
  92753. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  92754. /**
  92755. * Sets matrix on a uniform variable.
  92756. * @param uniformName Name of the variable.
  92757. * @param matrix matrix to be set.
  92758. * @returns this effect.
  92759. */
  92760. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  92761. /**
  92762. * 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)
  92763. * @param uniformName Name of the variable.
  92764. * @param matrix matrix to be set.
  92765. * @returns this effect.
  92766. */
  92767. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  92768. /**
  92769. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  92770. * @param uniformName Name of the variable.
  92771. * @param matrix matrix to be set.
  92772. * @returns this effect.
  92773. */
  92774. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  92775. /**
  92776. * Sets a float on a uniform variable.
  92777. * @param uniformName Name of the variable.
  92778. * @param value value to be set.
  92779. * @returns this effect.
  92780. */
  92781. setFloat(uniformName: string, value: number): Effect;
  92782. /**
  92783. * Sets a boolean on a uniform variable.
  92784. * @param uniformName Name of the variable.
  92785. * @param bool value to be set.
  92786. * @returns this effect.
  92787. */
  92788. setBool(uniformName: string, bool: boolean): Effect;
  92789. /**
  92790. * Sets a Vector2 on a uniform variable.
  92791. * @param uniformName Name of the variable.
  92792. * @param vector2 vector2 to be set.
  92793. * @returns this effect.
  92794. */
  92795. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  92796. /**
  92797. * Sets a float2 on a uniform variable.
  92798. * @param uniformName Name of the variable.
  92799. * @param x First float in float2.
  92800. * @param y Second float in float2.
  92801. * @returns this effect.
  92802. */
  92803. setFloat2(uniformName: string, x: number, y: number): Effect;
  92804. /**
  92805. * Sets a Vector3 on a uniform variable.
  92806. * @param uniformName Name of the variable.
  92807. * @param vector3 Value to be set.
  92808. * @returns this effect.
  92809. */
  92810. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  92811. /**
  92812. * Sets a float3 on a uniform variable.
  92813. * @param uniformName Name of the variable.
  92814. * @param x First float in float3.
  92815. * @param y Second float in float3.
  92816. * @param z Third float in float3.
  92817. * @returns this effect.
  92818. */
  92819. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  92820. /**
  92821. * Sets a Vector4 on a uniform variable.
  92822. * @param uniformName Name of the variable.
  92823. * @param vector4 Value to be set.
  92824. * @returns this effect.
  92825. */
  92826. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  92827. /**
  92828. * Sets a float4 on a uniform variable.
  92829. * @param uniformName Name of the variable.
  92830. * @param x First float in float4.
  92831. * @param y Second float in float4.
  92832. * @param z Third float in float4.
  92833. * @param w Fourth float in float4.
  92834. * @returns this effect.
  92835. */
  92836. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  92837. /**
  92838. * Sets a Color3 on a uniform variable.
  92839. * @param uniformName Name of the variable.
  92840. * @param color3 Value to be set.
  92841. * @returns this effect.
  92842. */
  92843. setColor3(uniformName: string, color3: IColor3Like): Effect;
  92844. /**
  92845. * Sets a Color4 on a uniform variable.
  92846. * @param uniformName Name of the variable.
  92847. * @param color3 Value to be set.
  92848. * @param alpha Alpha value to be set.
  92849. * @returns this effect.
  92850. */
  92851. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  92852. /**
  92853. * Sets a Color4 on a uniform variable
  92854. * @param uniformName defines the name of the variable
  92855. * @param color4 defines the value to be set
  92856. * @returns this effect.
  92857. */
  92858. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  92859. /** Release all associated resources */
  92860. dispose(): void;
  92861. /**
  92862. * This function will add a new shader to the shader store
  92863. * @param name the name of the shader
  92864. * @param pixelShader optional pixel shader content
  92865. * @param vertexShader optional vertex shader content
  92866. */
  92867. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  92868. /**
  92869. * Store of each shader (The can be looked up using effect.key)
  92870. */
  92871. static ShadersStore: {
  92872. [key: string]: string;
  92873. };
  92874. /**
  92875. * Store of each included file for a shader (The can be looked up using effect.key)
  92876. */
  92877. static IncludesShadersStore: {
  92878. [key: string]: string;
  92879. };
  92880. /**
  92881. * Resets the cache of effects.
  92882. */
  92883. static ResetCache(): void;
  92884. }
  92885. }
  92886. declare module BABYLON {
  92887. /**
  92888. * Uniform buffer objects.
  92889. *
  92890. * Handles blocks of uniform on the GPU.
  92891. *
  92892. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  92893. *
  92894. * For more information, please refer to :
  92895. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  92896. */
  92897. export class UniformBuffer {
  92898. private _engine;
  92899. private _buffer;
  92900. private _data;
  92901. private _bufferData;
  92902. private _dynamic?;
  92903. private _uniformLocations;
  92904. private _uniformSizes;
  92905. private _uniformLocationPointer;
  92906. private _needSync;
  92907. private _noUBO;
  92908. private _currentEffect;
  92909. private static _MAX_UNIFORM_SIZE;
  92910. private static _tempBuffer;
  92911. /**
  92912. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  92913. * This is dynamic to allow compat with webgl 1 and 2.
  92914. * You will need to pass the name of the uniform as well as the value.
  92915. */
  92916. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  92917. /**
  92918. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  92919. * This is dynamic to allow compat with webgl 1 and 2.
  92920. * You will need to pass the name of the uniform as well as the value.
  92921. */
  92922. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  92923. /**
  92924. * Lambda to Update a single float in a uniform buffer.
  92925. * This is dynamic to allow compat with webgl 1 and 2.
  92926. * You will need to pass the name of the uniform as well as the value.
  92927. */
  92928. updateFloat: (name: string, x: number) => void;
  92929. /**
  92930. * Lambda to Update a vec2 of float in a uniform buffer.
  92931. * This is dynamic to allow compat with webgl 1 and 2.
  92932. * You will need to pass the name of the uniform as well as the value.
  92933. */
  92934. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  92935. /**
  92936. * Lambda to Update a vec3 of float in a uniform buffer.
  92937. * This is dynamic to allow compat with webgl 1 and 2.
  92938. * You will need to pass the name of the uniform as well as the value.
  92939. */
  92940. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  92941. /**
  92942. * Lambda to Update a vec4 of float in a uniform buffer.
  92943. * This is dynamic to allow compat with webgl 1 and 2.
  92944. * You will need to pass the name of the uniform as well as the value.
  92945. */
  92946. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  92947. /**
  92948. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  92949. * This is dynamic to allow compat with webgl 1 and 2.
  92950. * You will need to pass the name of the uniform as well as the value.
  92951. */
  92952. updateMatrix: (name: string, mat: Matrix) => void;
  92953. /**
  92954. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  92955. * This is dynamic to allow compat with webgl 1 and 2.
  92956. * You will need to pass the name of the uniform as well as the value.
  92957. */
  92958. updateVector3: (name: string, vector: Vector3) => void;
  92959. /**
  92960. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  92961. * This is dynamic to allow compat with webgl 1 and 2.
  92962. * You will need to pass the name of the uniform as well as the value.
  92963. */
  92964. updateVector4: (name: string, vector: Vector4) => void;
  92965. /**
  92966. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  92967. * This is dynamic to allow compat with webgl 1 and 2.
  92968. * You will need to pass the name of the uniform as well as the value.
  92969. */
  92970. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  92971. /**
  92972. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  92973. * This is dynamic to allow compat with webgl 1 and 2.
  92974. * You will need to pass the name of the uniform as well as the value.
  92975. */
  92976. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  92977. /**
  92978. * Instantiates a new Uniform buffer objects.
  92979. *
  92980. * Handles blocks of uniform on the GPU.
  92981. *
  92982. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  92983. *
  92984. * For more information, please refer to :
  92985. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  92986. * @param engine Define the engine the buffer is associated with
  92987. * @param data Define the data contained in the buffer
  92988. * @param dynamic Define if the buffer is updatable
  92989. */
  92990. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  92991. /**
  92992. * Indicates if the buffer is using the WebGL2 UBO implementation,
  92993. * or just falling back on setUniformXXX calls.
  92994. */
  92995. readonly useUbo: boolean;
  92996. /**
  92997. * Indicates if the WebGL underlying uniform buffer is in sync
  92998. * with the javascript cache data.
  92999. */
  93000. readonly isSync: boolean;
  93001. /**
  93002. * Indicates if the WebGL underlying uniform buffer is dynamic.
  93003. * Also, a dynamic UniformBuffer will disable cache verification and always
  93004. * update the underlying WebGL uniform buffer to the GPU.
  93005. * @returns if Dynamic, otherwise false
  93006. */
  93007. isDynamic(): boolean;
  93008. /**
  93009. * The data cache on JS side.
  93010. * @returns the underlying data as a float array
  93011. */
  93012. getData(): Float32Array;
  93013. /**
  93014. * The underlying WebGL Uniform buffer.
  93015. * @returns the webgl buffer
  93016. */
  93017. getBuffer(): Nullable<DataBuffer>;
  93018. /**
  93019. * std140 layout specifies how to align data within an UBO structure.
  93020. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  93021. * for specs.
  93022. */
  93023. private _fillAlignment;
  93024. /**
  93025. * Adds an uniform in the buffer.
  93026. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  93027. * for the layout to be correct !
  93028. * @param name Name of the uniform, as used in the uniform block in the shader.
  93029. * @param size Data size, or data directly.
  93030. */
  93031. addUniform(name: string, size: number | number[]): void;
  93032. /**
  93033. * Adds a Matrix 4x4 to the uniform buffer.
  93034. * @param name Name of the uniform, as used in the uniform block in the shader.
  93035. * @param mat A 4x4 matrix.
  93036. */
  93037. addMatrix(name: string, mat: Matrix): void;
  93038. /**
  93039. * Adds a vec2 to the uniform buffer.
  93040. * @param name Name of the uniform, as used in the uniform block in the shader.
  93041. * @param x Define the x component value of the vec2
  93042. * @param y Define the y component value of the vec2
  93043. */
  93044. addFloat2(name: string, x: number, y: number): void;
  93045. /**
  93046. * Adds a vec3 to the uniform buffer.
  93047. * @param name Name of the uniform, as used in the uniform block in the shader.
  93048. * @param x Define the x component value of the vec3
  93049. * @param y Define the y component value of the vec3
  93050. * @param z Define the z component value of the vec3
  93051. */
  93052. addFloat3(name: string, x: number, y: number, z: number): void;
  93053. /**
  93054. * Adds a vec3 to the uniform buffer.
  93055. * @param name Name of the uniform, as used in the uniform block in the shader.
  93056. * @param color Define the vec3 from a Color
  93057. */
  93058. addColor3(name: string, color: Color3): void;
  93059. /**
  93060. * Adds a vec4 to the uniform buffer.
  93061. * @param name Name of the uniform, as used in the uniform block in the shader.
  93062. * @param color Define the rgb components from a Color
  93063. * @param alpha Define the a component of the vec4
  93064. */
  93065. addColor4(name: string, color: Color3, alpha: number): void;
  93066. /**
  93067. * Adds a vec3 to the uniform buffer.
  93068. * @param name Name of the uniform, as used in the uniform block in the shader.
  93069. * @param vector Define the vec3 components from a Vector
  93070. */
  93071. addVector3(name: string, vector: Vector3): void;
  93072. /**
  93073. * Adds a Matrix 3x3 to the uniform buffer.
  93074. * @param name Name of the uniform, as used in the uniform block in the shader.
  93075. */
  93076. addMatrix3x3(name: string): void;
  93077. /**
  93078. * Adds a Matrix 2x2 to the uniform buffer.
  93079. * @param name Name of the uniform, as used in the uniform block in the shader.
  93080. */
  93081. addMatrix2x2(name: string): void;
  93082. /**
  93083. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  93084. */
  93085. create(): void;
  93086. /** @hidden */
  93087. _rebuild(): void;
  93088. /**
  93089. * Updates the WebGL Uniform Buffer on the GPU.
  93090. * If the `dynamic` flag is set to true, no cache comparison is done.
  93091. * Otherwise, the buffer will be updated only if the cache differs.
  93092. */
  93093. update(): void;
  93094. /**
  93095. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  93096. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  93097. * @param data Define the flattened data
  93098. * @param size Define the size of the data.
  93099. */
  93100. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  93101. private _updateMatrix3x3ForUniform;
  93102. private _updateMatrix3x3ForEffect;
  93103. private _updateMatrix2x2ForEffect;
  93104. private _updateMatrix2x2ForUniform;
  93105. private _updateFloatForEffect;
  93106. private _updateFloatForUniform;
  93107. private _updateFloat2ForEffect;
  93108. private _updateFloat2ForUniform;
  93109. private _updateFloat3ForEffect;
  93110. private _updateFloat3ForUniform;
  93111. private _updateFloat4ForEffect;
  93112. private _updateFloat4ForUniform;
  93113. private _updateMatrixForEffect;
  93114. private _updateMatrixForUniform;
  93115. private _updateVector3ForEffect;
  93116. private _updateVector3ForUniform;
  93117. private _updateVector4ForEffect;
  93118. private _updateVector4ForUniform;
  93119. private _updateColor3ForEffect;
  93120. private _updateColor3ForUniform;
  93121. private _updateColor4ForEffect;
  93122. private _updateColor4ForUniform;
  93123. /**
  93124. * Sets a sampler uniform on the effect.
  93125. * @param name Define the name of the sampler.
  93126. * @param texture Define the texture to set in the sampler
  93127. */
  93128. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  93129. /**
  93130. * Directly updates the value of the uniform in the cache AND on the GPU.
  93131. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  93132. * @param data Define the flattened data
  93133. */
  93134. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  93135. /**
  93136. * Binds this uniform buffer to an effect.
  93137. * @param effect Define the effect to bind the buffer to
  93138. * @param name Name of the uniform block in the shader.
  93139. */
  93140. bindToEffect(effect: Effect, name: string): void;
  93141. /**
  93142. * Disposes the uniform buffer.
  93143. */
  93144. dispose(): void;
  93145. }
  93146. }
  93147. declare module BABYLON {
  93148. /**
  93149. * Class used to work with sound analyzer using fast fourier transform (FFT)
  93150. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  93151. */
  93152. export class Analyser {
  93153. /**
  93154. * Gets or sets the smoothing
  93155. * @ignorenaming
  93156. */
  93157. SMOOTHING: number;
  93158. /**
  93159. * Gets or sets the FFT table size
  93160. * @ignorenaming
  93161. */
  93162. FFT_SIZE: number;
  93163. /**
  93164. * Gets or sets the bar graph amplitude
  93165. * @ignorenaming
  93166. */
  93167. BARGRAPHAMPLITUDE: number;
  93168. /**
  93169. * Gets or sets the position of the debug canvas
  93170. * @ignorenaming
  93171. */
  93172. DEBUGCANVASPOS: {
  93173. x: number;
  93174. y: number;
  93175. };
  93176. /**
  93177. * Gets or sets the debug canvas size
  93178. * @ignorenaming
  93179. */
  93180. DEBUGCANVASSIZE: {
  93181. width: number;
  93182. height: number;
  93183. };
  93184. private _byteFreqs;
  93185. private _byteTime;
  93186. private _floatFreqs;
  93187. private _webAudioAnalyser;
  93188. private _debugCanvas;
  93189. private _debugCanvasContext;
  93190. private _scene;
  93191. private _registerFunc;
  93192. private _audioEngine;
  93193. /**
  93194. * Creates a new analyser
  93195. * @param scene defines hosting scene
  93196. */
  93197. constructor(scene: Scene);
  93198. /**
  93199. * Get the number of data values you will have to play with for the visualization
  93200. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  93201. * @returns a number
  93202. */
  93203. getFrequencyBinCount(): number;
  93204. /**
  93205. * Gets the current frequency data as a byte array
  93206. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  93207. * @returns a Uint8Array
  93208. */
  93209. getByteFrequencyData(): Uint8Array;
  93210. /**
  93211. * Gets the current waveform as a byte array
  93212. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  93213. * @returns a Uint8Array
  93214. */
  93215. getByteTimeDomainData(): Uint8Array;
  93216. /**
  93217. * Gets the current frequency data as a float array
  93218. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  93219. * @returns a Float32Array
  93220. */
  93221. getFloatFrequencyData(): Float32Array;
  93222. /**
  93223. * Renders the debug canvas
  93224. */
  93225. drawDebugCanvas(): void;
  93226. /**
  93227. * Stops rendering the debug canvas and removes it
  93228. */
  93229. stopDebugCanvas(): void;
  93230. /**
  93231. * Connects two audio nodes
  93232. * @param inputAudioNode defines first node to connect
  93233. * @param outputAudioNode defines second node to connect
  93234. */
  93235. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  93236. /**
  93237. * Releases all associated resources
  93238. */
  93239. dispose(): void;
  93240. }
  93241. }
  93242. declare module BABYLON {
  93243. /**
  93244. * This represents an audio engine and it is responsible
  93245. * to play, synchronize and analyse sounds throughout the application.
  93246. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  93247. */
  93248. export interface IAudioEngine extends IDisposable {
  93249. /**
  93250. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  93251. */
  93252. readonly canUseWebAudio: boolean;
  93253. /**
  93254. * Gets the current AudioContext if available.
  93255. */
  93256. readonly audioContext: Nullable<AudioContext>;
  93257. /**
  93258. * The master gain node defines the global audio volume of your audio engine.
  93259. */
  93260. readonly masterGain: GainNode;
  93261. /**
  93262. * Gets whether or not mp3 are supported by your browser.
  93263. */
  93264. readonly isMP3supported: boolean;
  93265. /**
  93266. * Gets whether or not ogg are supported by your browser.
  93267. */
  93268. readonly isOGGsupported: boolean;
  93269. /**
  93270. * Defines if Babylon should emit a warning if WebAudio is not supported.
  93271. * @ignoreNaming
  93272. */
  93273. WarnedWebAudioUnsupported: boolean;
  93274. /**
  93275. * Defines if the audio engine relies on a custom unlocked button.
  93276. * In this case, the embedded button will not be displayed.
  93277. */
  93278. useCustomUnlockedButton: boolean;
  93279. /**
  93280. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  93281. */
  93282. readonly unlocked: boolean;
  93283. /**
  93284. * Event raised when audio has been unlocked on the browser.
  93285. */
  93286. onAudioUnlockedObservable: Observable<AudioEngine>;
  93287. /**
  93288. * Event raised when audio has been locked on the browser.
  93289. */
  93290. onAudioLockedObservable: Observable<AudioEngine>;
  93291. /**
  93292. * Flags the audio engine in Locked state.
  93293. * This happens due to new browser policies preventing audio to autoplay.
  93294. */
  93295. lock(): void;
  93296. /**
  93297. * Unlocks the audio engine once a user action has been done on the dom.
  93298. * This is helpful to resume play once browser policies have been satisfied.
  93299. */
  93300. unlock(): void;
  93301. }
  93302. /**
  93303. * This represents the default audio engine used in babylon.
  93304. * It is responsible to play, synchronize and analyse sounds throughout the application.
  93305. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  93306. */
  93307. export class AudioEngine implements IAudioEngine {
  93308. private _audioContext;
  93309. private _audioContextInitialized;
  93310. private _muteButton;
  93311. private _hostElement;
  93312. /**
  93313. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  93314. */
  93315. canUseWebAudio: boolean;
  93316. /**
  93317. * The master gain node defines the global audio volume of your audio engine.
  93318. */
  93319. masterGain: GainNode;
  93320. /**
  93321. * Defines if Babylon should emit a warning if WebAudio is not supported.
  93322. * @ignoreNaming
  93323. */
  93324. WarnedWebAudioUnsupported: boolean;
  93325. /**
  93326. * Gets whether or not mp3 are supported by your browser.
  93327. */
  93328. isMP3supported: boolean;
  93329. /**
  93330. * Gets whether or not ogg are supported by your browser.
  93331. */
  93332. isOGGsupported: boolean;
  93333. /**
  93334. * Gets whether audio has been unlocked on the device.
  93335. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  93336. * a user interaction has happened.
  93337. */
  93338. unlocked: boolean;
  93339. /**
  93340. * Defines if the audio engine relies on a custom unlocked button.
  93341. * In this case, the embedded button will not be displayed.
  93342. */
  93343. useCustomUnlockedButton: boolean;
  93344. /**
  93345. * Event raised when audio has been unlocked on the browser.
  93346. */
  93347. onAudioUnlockedObservable: Observable<AudioEngine>;
  93348. /**
  93349. * Event raised when audio has been locked on the browser.
  93350. */
  93351. onAudioLockedObservable: Observable<AudioEngine>;
  93352. /**
  93353. * Gets the current AudioContext if available.
  93354. */
  93355. readonly audioContext: Nullable<AudioContext>;
  93356. private _connectedAnalyser;
  93357. /**
  93358. * Instantiates a new audio engine.
  93359. *
  93360. * There should be only one per page as some browsers restrict the number
  93361. * of audio contexts you can create.
  93362. * @param hostElement defines the host element where to display the mute icon if necessary
  93363. */
  93364. constructor(hostElement?: Nullable<HTMLElement>);
  93365. /**
  93366. * Flags the audio engine in Locked state.
  93367. * This happens due to new browser policies preventing audio to autoplay.
  93368. */
  93369. lock(): void;
  93370. /**
  93371. * Unlocks the audio engine once a user action has been done on the dom.
  93372. * This is helpful to resume play once browser policies have been satisfied.
  93373. */
  93374. unlock(): void;
  93375. private _resumeAudioContext;
  93376. private _initializeAudioContext;
  93377. private _tryToRun;
  93378. private _triggerRunningState;
  93379. private _triggerSuspendedState;
  93380. private _displayMuteButton;
  93381. private _moveButtonToTopLeft;
  93382. private _onResize;
  93383. private _hideMuteButton;
  93384. /**
  93385. * Destroy and release the resources associated with the audio ccontext.
  93386. */
  93387. dispose(): void;
  93388. /**
  93389. * Gets the global volume sets on the master gain.
  93390. * @returns the global volume if set or -1 otherwise
  93391. */
  93392. getGlobalVolume(): number;
  93393. /**
  93394. * Sets the global volume of your experience (sets on the master gain).
  93395. * @param newVolume Defines the new global volume of the application
  93396. */
  93397. setGlobalVolume(newVolume: number): void;
  93398. /**
  93399. * Connect the audio engine to an audio analyser allowing some amazing
  93400. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  93401. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  93402. * @param analyser The analyser to connect to the engine
  93403. */
  93404. connectToAnalyser(analyser: Analyser): void;
  93405. }
  93406. }
  93407. declare module BABYLON {
  93408. /**
  93409. * Interface used to present a loading screen while loading a scene
  93410. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  93411. */
  93412. export interface ILoadingScreen {
  93413. /**
  93414. * Function called to display the loading screen
  93415. */
  93416. displayLoadingUI: () => void;
  93417. /**
  93418. * Function called to hide the loading screen
  93419. */
  93420. hideLoadingUI: () => void;
  93421. /**
  93422. * Gets or sets the color to use for the background
  93423. */
  93424. loadingUIBackgroundColor: string;
  93425. /**
  93426. * Gets or sets the text to display while loading
  93427. */
  93428. loadingUIText: string;
  93429. }
  93430. /**
  93431. * Class used for the default loading screen
  93432. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  93433. */
  93434. export class DefaultLoadingScreen implements ILoadingScreen {
  93435. private _renderingCanvas;
  93436. private _loadingText;
  93437. private _loadingDivBackgroundColor;
  93438. private _loadingDiv;
  93439. private _loadingTextDiv;
  93440. /** Gets or sets the logo url to use for the default loading screen */
  93441. static DefaultLogoUrl: string;
  93442. /** Gets or sets the spinner url to use for the default loading screen */
  93443. static DefaultSpinnerUrl: string;
  93444. /**
  93445. * Creates a new default loading screen
  93446. * @param _renderingCanvas defines the canvas used to render the scene
  93447. * @param _loadingText defines the default text to display
  93448. * @param _loadingDivBackgroundColor defines the default background color
  93449. */
  93450. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  93451. /**
  93452. * Function called to display the loading screen
  93453. */
  93454. displayLoadingUI(): void;
  93455. /**
  93456. * Function called to hide the loading screen
  93457. */
  93458. hideLoadingUI(): void;
  93459. /**
  93460. * Gets or sets the text to display while loading
  93461. */
  93462. loadingUIText: string;
  93463. /**
  93464. * Gets or sets the color to use for the background
  93465. */
  93466. loadingUIBackgroundColor: string;
  93467. private _resizeLoadingUI;
  93468. }
  93469. }
  93470. declare module BABYLON {
  93471. /** @hidden */
  93472. export class WebGLPipelineContext implements IPipelineContext {
  93473. engine: Engine;
  93474. program: Nullable<WebGLProgram>;
  93475. context?: WebGLRenderingContext;
  93476. vertexShader?: WebGLShader;
  93477. fragmentShader?: WebGLShader;
  93478. isParallelCompiled: boolean;
  93479. onCompiled?: () => void;
  93480. transformFeedback?: WebGLTransformFeedback | null;
  93481. readonly isAsync: boolean;
  93482. readonly isReady: boolean;
  93483. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  93484. }
  93485. }
  93486. declare module BABYLON {
  93487. /** @hidden */
  93488. export class WebGLDataBuffer extends DataBuffer {
  93489. private _buffer;
  93490. constructor(resource: WebGLBuffer);
  93491. readonly underlyingResource: any;
  93492. }
  93493. }
  93494. declare module BABYLON {
  93495. /** @hidden */
  93496. export class WebGL2ShaderProcessor implements IShaderProcessor {
  93497. attributeProcessor(attribute: string): string;
  93498. varyingProcessor(varying: string, isFragment: boolean): string;
  93499. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  93500. }
  93501. }
  93502. declare module BABYLON {
  93503. /**
  93504. * This class is used to track a performance counter which is number based.
  93505. * The user has access to many properties which give statistics of different nature.
  93506. *
  93507. * The implementer can track two kinds of Performance Counter: time and count.
  93508. * 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.
  93509. * 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.
  93510. */
  93511. export class PerfCounter {
  93512. /**
  93513. * Gets or sets a global boolean to turn on and off all the counters
  93514. */
  93515. static Enabled: boolean;
  93516. /**
  93517. * Returns the smallest value ever
  93518. */
  93519. readonly min: number;
  93520. /**
  93521. * Returns the biggest value ever
  93522. */
  93523. readonly max: number;
  93524. /**
  93525. * Returns the average value since the performance counter is running
  93526. */
  93527. readonly average: number;
  93528. /**
  93529. * Returns the average value of the last second the counter was monitored
  93530. */
  93531. readonly lastSecAverage: number;
  93532. /**
  93533. * Returns the current value
  93534. */
  93535. readonly current: number;
  93536. /**
  93537. * Gets the accumulated total
  93538. */
  93539. readonly total: number;
  93540. /**
  93541. * Gets the total value count
  93542. */
  93543. readonly count: number;
  93544. /**
  93545. * Creates a new counter
  93546. */
  93547. constructor();
  93548. /**
  93549. * Call this method to start monitoring a new frame.
  93550. * 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.
  93551. */
  93552. fetchNewFrame(): void;
  93553. /**
  93554. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  93555. * @param newCount the count value to add to the monitored count
  93556. * @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.
  93557. */
  93558. addCount(newCount: number, fetchResult: boolean): void;
  93559. /**
  93560. * Start monitoring this performance counter
  93561. */
  93562. beginMonitoring(): void;
  93563. /**
  93564. * Compute the time lapsed since the previous beginMonitoring() call.
  93565. * @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
  93566. */
  93567. endMonitoring(newFrame?: boolean): void;
  93568. private _fetchResult;
  93569. private _startMonitoringTime;
  93570. private _min;
  93571. private _max;
  93572. private _average;
  93573. private _current;
  93574. private _totalValueCount;
  93575. private _totalAccumulated;
  93576. private _lastSecAverage;
  93577. private _lastSecAccumulated;
  93578. private _lastSecTime;
  93579. private _lastSecValueCount;
  93580. }
  93581. }
  93582. declare module BABYLON {
  93583. /**
  93584. * Interface for any object that can request an animation frame
  93585. */
  93586. export interface ICustomAnimationFrameRequester {
  93587. /**
  93588. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  93589. */
  93590. renderFunction?: Function;
  93591. /**
  93592. * Called to request the next frame to render to
  93593. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  93594. */
  93595. requestAnimationFrame: Function;
  93596. /**
  93597. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  93598. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  93599. */
  93600. requestID?: number;
  93601. }
  93602. }
  93603. declare module BABYLON {
  93604. /**
  93605. * Settings for finer control over video usage
  93606. */
  93607. export interface VideoTextureSettings {
  93608. /**
  93609. * Applies `autoplay` to video, if specified
  93610. */
  93611. autoPlay?: boolean;
  93612. /**
  93613. * Applies `loop` to video, if specified
  93614. */
  93615. loop?: boolean;
  93616. /**
  93617. * Automatically updates internal texture from video at every frame in the render loop
  93618. */
  93619. autoUpdateTexture: boolean;
  93620. /**
  93621. * Image src displayed during the video loading or until the user interacts with the video.
  93622. */
  93623. poster?: string;
  93624. }
  93625. /**
  93626. * If you want to display a video in your scene, this is the special texture for that.
  93627. * This special texture works similar to other textures, with the exception of a few parameters.
  93628. * @see https://doc.babylonjs.com/how_to/video_texture
  93629. */
  93630. export class VideoTexture extends Texture {
  93631. /**
  93632. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  93633. */
  93634. readonly autoUpdateTexture: boolean;
  93635. /**
  93636. * The video instance used by the texture internally
  93637. */
  93638. readonly video: HTMLVideoElement;
  93639. private _onUserActionRequestedObservable;
  93640. /**
  93641. * Event triggerd when a dom action is required by the user to play the video.
  93642. * This happens due to recent changes in browser policies preventing video to auto start.
  93643. */
  93644. readonly onUserActionRequestedObservable: Observable<Texture>;
  93645. private _generateMipMaps;
  93646. private _engine;
  93647. private _stillImageCaptured;
  93648. private _displayingPosterTexture;
  93649. private _settings;
  93650. private _createInternalTextureOnEvent;
  93651. /**
  93652. * Creates a video texture.
  93653. * If you want to display a video in your scene, this is the special texture for that.
  93654. * This special texture works similar to other textures, with the exception of a few parameters.
  93655. * @see https://doc.babylonjs.com/how_to/video_texture
  93656. * @param name optional name, will detect from video source, if not defined
  93657. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  93658. * @param scene is obviously the current scene.
  93659. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  93660. * @param invertY is false by default but can be used to invert video on Y axis
  93661. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  93662. * @param settings allows finer control over video usage
  93663. */
  93664. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  93665. private _getName;
  93666. private _getVideo;
  93667. private _createInternalTexture;
  93668. private reset;
  93669. /**
  93670. * @hidden Internal method to initiate `update`.
  93671. */
  93672. _rebuild(): void;
  93673. /**
  93674. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  93675. */
  93676. update(): void;
  93677. /**
  93678. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  93679. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  93680. */
  93681. updateTexture(isVisible: boolean): void;
  93682. protected _updateInternalTexture: () => void;
  93683. /**
  93684. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  93685. * @param url New url.
  93686. */
  93687. updateURL(url: string): void;
  93688. /**
  93689. * Dispose the texture and release its associated resources.
  93690. */
  93691. dispose(): void;
  93692. /**
  93693. * Creates a video texture straight from a stream.
  93694. * @param scene Define the scene the texture should be created in
  93695. * @param stream Define the stream the texture should be created from
  93696. * @returns The created video texture as a promise
  93697. */
  93698. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  93699. /**
  93700. * Creates a video texture straight from your WebCam video feed.
  93701. * @param scene Define the scene the texture should be created in
  93702. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  93703. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  93704. * @returns The created video texture as a promise
  93705. */
  93706. static CreateFromWebCamAsync(scene: Scene, constraints: {
  93707. minWidth: number;
  93708. maxWidth: number;
  93709. minHeight: number;
  93710. maxHeight: number;
  93711. deviceId: string;
  93712. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  93713. /**
  93714. * Creates a video texture straight from your WebCam video feed.
  93715. * @param scene Define the scene the texture should be created in
  93716. * @param onReady Define a callback to triggered once the texture will be ready
  93717. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  93718. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  93719. */
  93720. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  93721. minWidth: number;
  93722. maxWidth: number;
  93723. minHeight: number;
  93724. maxHeight: number;
  93725. deviceId: string;
  93726. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  93727. }
  93728. }
  93729. declare module BABYLON {
  93730. /**
  93731. * Defines the interface used by objects containing a viewport (like a camera)
  93732. */
  93733. interface IViewportOwnerLike {
  93734. /**
  93735. * Gets or sets the viewport
  93736. */
  93737. viewport: IViewportLike;
  93738. }
  93739. /**
  93740. * Interface for attribute information associated with buffer instanciation
  93741. */
  93742. export class InstancingAttributeInfo {
  93743. /**
  93744. * Index/offset of the attribute in the vertex shader
  93745. */
  93746. index: number;
  93747. /**
  93748. * size of the attribute, 1, 2, 3 or 4
  93749. */
  93750. attributeSize: number;
  93751. /**
  93752. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  93753. * default is FLOAT
  93754. */
  93755. attribyteType: number;
  93756. /**
  93757. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  93758. */
  93759. normalized: boolean;
  93760. /**
  93761. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  93762. */
  93763. offset: number;
  93764. /**
  93765. * Name of the GLSL attribute, for debugging purpose only
  93766. */
  93767. attributeName: string;
  93768. }
  93769. /**
  93770. * Define options used to create a depth texture
  93771. */
  93772. export class DepthTextureCreationOptions {
  93773. /** Specifies whether or not a stencil should be allocated in the texture */
  93774. generateStencil?: boolean;
  93775. /** Specifies whether or not bilinear filtering is enable on the texture */
  93776. bilinearFiltering?: boolean;
  93777. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  93778. comparisonFunction?: number;
  93779. /** Specifies if the created texture is a cube texture */
  93780. isCube?: boolean;
  93781. }
  93782. /**
  93783. * Class used to describe the capabilities of the engine relatively to the current browser
  93784. */
  93785. export class EngineCapabilities {
  93786. /** Maximum textures units per fragment shader */
  93787. maxTexturesImageUnits: number;
  93788. /** Maximum texture units per vertex shader */
  93789. maxVertexTextureImageUnits: number;
  93790. /** Maximum textures units in the entire pipeline */
  93791. maxCombinedTexturesImageUnits: number;
  93792. /** Maximum texture size */
  93793. maxTextureSize: number;
  93794. /** Maximum cube texture size */
  93795. maxCubemapTextureSize: number;
  93796. /** Maximum render texture size */
  93797. maxRenderTextureSize: number;
  93798. /** Maximum number of vertex attributes */
  93799. maxVertexAttribs: number;
  93800. /** Maximum number of varyings */
  93801. maxVaryingVectors: number;
  93802. /** Maximum number of uniforms per vertex shader */
  93803. maxVertexUniformVectors: number;
  93804. /** Maximum number of uniforms per fragment shader */
  93805. maxFragmentUniformVectors: number;
  93806. /** Defines if standard derivates (dx/dy) are supported */
  93807. standardDerivatives: boolean;
  93808. /** Defines if s3tc texture compression is supported */
  93809. s3tc: Nullable<WEBGL_compressed_texture_s3tc>;
  93810. /** Defines if pvrtc texture compression is supported */
  93811. pvrtc: any;
  93812. /** Defines if etc1 texture compression is supported */
  93813. etc1: any;
  93814. /** Defines if etc2 texture compression is supported */
  93815. etc2: any;
  93816. /** Defines if astc texture compression is supported */
  93817. astc: any;
  93818. /** Defines if float textures are supported */
  93819. textureFloat: boolean;
  93820. /** Defines if vertex array objects are supported */
  93821. vertexArrayObject: boolean;
  93822. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  93823. textureAnisotropicFilterExtension: Nullable<EXT_texture_filter_anisotropic>;
  93824. /** Gets the maximum level of anisotropy supported */
  93825. maxAnisotropy: number;
  93826. /** Defines if instancing is supported */
  93827. instancedArrays: boolean;
  93828. /** Defines if 32 bits indices are supported */
  93829. uintIndices: boolean;
  93830. /** Defines if high precision shaders are supported */
  93831. highPrecisionShaderSupported: boolean;
  93832. /** Defines if depth reading in the fragment shader is supported */
  93833. fragmentDepthSupported: boolean;
  93834. /** Defines if float texture linear filtering is supported*/
  93835. textureFloatLinearFiltering: boolean;
  93836. /** Defines if rendering to float textures is supported */
  93837. textureFloatRender: boolean;
  93838. /** Defines if half float textures are supported*/
  93839. textureHalfFloat: boolean;
  93840. /** Defines if half float texture linear filtering is supported*/
  93841. textureHalfFloatLinearFiltering: boolean;
  93842. /** Defines if rendering to half float textures is supported */
  93843. textureHalfFloatRender: boolean;
  93844. /** Defines if textureLOD shader command is supported */
  93845. textureLOD: boolean;
  93846. /** Defines if draw buffers extension is supported */
  93847. drawBuffersExtension: boolean;
  93848. /** Defines if depth textures are supported */
  93849. depthTextureExtension: boolean;
  93850. /** Defines if float color buffer are supported */
  93851. colorBufferFloat: boolean;
  93852. /** Gets disjoint timer query extension (null if not supported) */
  93853. timerQuery: EXT_disjoint_timer_query;
  93854. /** Defines if timestamp can be used with timer query */
  93855. canUseTimestampForTimerQuery: boolean;
  93856. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  93857. multiview: any;
  93858. /** Function used to let the system compiles shaders in background */
  93859. parallelShaderCompile: {
  93860. COMPLETION_STATUS_KHR: number;
  93861. };
  93862. /** Max number of texture samples for MSAA */
  93863. maxMSAASamples: number;
  93864. }
  93865. /** Interface defining initialization parameters for Engine class */
  93866. export interface EngineOptions extends WebGLContextAttributes {
  93867. /**
  93868. * Defines if the engine should no exceed a specified device ratio
  93869. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  93870. */
  93871. limitDeviceRatio?: number;
  93872. /**
  93873. * Defines if webvr should be enabled automatically
  93874. * @see http://doc.babylonjs.com/how_to/webvr_camera
  93875. */
  93876. autoEnableWebVR?: boolean;
  93877. /**
  93878. * Defines if webgl2 should be turned off even if supported
  93879. * @see http://doc.babylonjs.com/features/webgl2
  93880. */
  93881. disableWebGL2Support?: boolean;
  93882. /**
  93883. * Defines if webaudio should be initialized as well
  93884. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  93885. */
  93886. audioEngine?: boolean;
  93887. /**
  93888. * Defines if animations should run using a deterministic lock step
  93889. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  93890. */
  93891. deterministicLockstep?: boolean;
  93892. /** Defines the maximum steps to use with deterministic lock step mode */
  93893. lockstepMaxSteps?: number;
  93894. /**
  93895. * Defines that engine should ignore context lost events
  93896. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  93897. */
  93898. doNotHandleContextLost?: boolean;
  93899. /**
  93900. * Defines that engine should ignore modifying touch action attribute and style
  93901. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  93902. */
  93903. doNotHandleTouchAction?: boolean;
  93904. /**
  93905. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  93906. */
  93907. useHighPrecisionFloats?: boolean;
  93908. }
  93909. /**
  93910. * Defines the interface used by display changed events
  93911. */
  93912. export interface IDisplayChangedEventArgs {
  93913. /** Gets the vrDisplay object (if any) */
  93914. vrDisplay: Nullable<any>;
  93915. /** Gets a boolean indicating if webVR is supported */
  93916. vrSupported: boolean;
  93917. }
  93918. /**
  93919. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  93920. */
  93921. export class Engine {
  93922. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  93923. static ExceptionList: ({
  93924. key: string;
  93925. capture: string;
  93926. captureConstraint: number;
  93927. targets: string[];
  93928. } | {
  93929. key: string;
  93930. capture: null;
  93931. captureConstraint: null;
  93932. targets: string[];
  93933. })[];
  93934. /** Gets the list of created engines */
  93935. static readonly Instances: Engine[];
  93936. /**
  93937. * Gets the latest created engine
  93938. */
  93939. static readonly LastCreatedEngine: Nullable<Engine>;
  93940. /**
  93941. * Gets the latest created scene
  93942. */
  93943. static readonly LastCreatedScene: Nullable<Scene>;
  93944. /**
  93945. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  93946. * @param flag defines which part of the materials must be marked as dirty
  93947. * @param predicate defines a predicate used to filter which materials should be affected
  93948. */
  93949. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  93950. /** @hidden */
  93951. static _TextureLoaders: IInternalTextureLoader[];
  93952. /** Defines that alpha blending is disabled */
  93953. static readonly ALPHA_DISABLE: number;
  93954. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  93955. static readonly ALPHA_ADD: number;
  93956. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  93957. static readonly ALPHA_COMBINE: number;
  93958. /** Defines that alpha blending to DEST - SRC * DEST */
  93959. static readonly ALPHA_SUBTRACT: number;
  93960. /** Defines that alpha blending to SRC * DEST */
  93961. static readonly ALPHA_MULTIPLY: number;
  93962. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  93963. static readonly ALPHA_MAXIMIZED: number;
  93964. /** Defines that alpha blending to SRC + DEST */
  93965. static readonly ALPHA_ONEONE: number;
  93966. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  93967. static readonly ALPHA_PREMULTIPLIED: number;
  93968. /**
  93969. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  93970. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  93971. */
  93972. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  93973. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  93974. static readonly ALPHA_INTERPOLATE: number;
  93975. /**
  93976. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  93977. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  93978. */
  93979. static readonly ALPHA_SCREENMODE: number;
  93980. /** Defines that the ressource is not delayed*/
  93981. static readonly DELAYLOADSTATE_NONE: number;
  93982. /** Defines that the ressource was successfully delay loaded */
  93983. static readonly DELAYLOADSTATE_LOADED: number;
  93984. /** Defines that the ressource is currently delay loading */
  93985. static readonly DELAYLOADSTATE_LOADING: number;
  93986. /** Defines that the ressource is delayed and has not started loading */
  93987. static readonly DELAYLOADSTATE_NOTLOADED: number;
  93988. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  93989. static readonly NEVER: number;
  93990. /** 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 */
  93991. static readonly ALWAYS: number;
  93992. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  93993. static readonly LESS: number;
  93994. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  93995. static readonly EQUAL: number;
  93996. /** 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 */
  93997. static readonly LEQUAL: number;
  93998. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  93999. static readonly GREATER: number;
  94000. /** 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 */
  94001. static readonly GEQUAL: number;
  94002. /** 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 */
  94003. static readonly NOTEQUAL: number;
  94004. /** Passed to stencilOperation to specify that stencil value must be kept */
  94005. static readonly KEEP: number;
  94006. /** Passed to stencilOperation to specify that stencil value must be replaced */
  94007. static readonly REPLACE: number;
  94008. /** Passed to stencilOperation to specify that stencil value must be incremented */
  94009. static readonly INCR: number;
  94010. /** Passed to stencilOperation to specify that stencil value must be decremented */
  94011. static readonly DECR: number;
  94012. /** Passed to stencilOperation to specify that stencil value must be inverted */
  94013. static readonly INVERT: number;
  94014. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  94015. static readonly INCR_WRAP: number;
  94016. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  94017. static readonly DECR_WRAP: number;
  94018. /** Texture is not repeating outside of 0..1 UVs */
  94019. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  94020. /** Texture is repeating outside of 0..1 UVs */
  94021. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  94022. /** Texture is repeating and mirrored */
  94023. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  94024. /** ALPHA */
  94025. static readonly TEXTUREFORMAT_ALPHA: number;
  94026. /** LUMINANCE */
  94027. static readonly TEXTUREFORMAT_LUMINANCE: number;
  94028. /** LUMINANCE_ALPHA */
  94029. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  94030. /** RGB */
  94031. static readonly TEXTUREFORMAT_RGB: number;
  94032. /** RGBA */
  94033. static readonly TEXTUREFORMAT_RGBA: number;
  94034. /** RED */
  94035. static readonly TEXTUREFORMAT_RED: number;
  94036. /** RED (2nd reference) */
  94037. static readonly TEXTUREFORMAT_R: number;
  94038. /** RG */
  94039. static readonly TEXTUREFORMAT_RG: number;
  94040. /** RED_INTEGER */
  94041. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  94042. /** RED_INTEGER (2nd reference) */
  94043. static readonly TEXTUREFORMAT_R_INTEGER: number;
  94044. /** RG_INTEGER */
  94045. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  94046. /** RGB_INTEGER */
  94047. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  94048. /** RGBA_INTEGER */
  94049. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  94050. /** UNSIGNED_BYTE */
  94051. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  94052. /** UNSIGNED_BYTE (2nd reference) */
  94053. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  94054. /** FLOAT */
  94055. static readonly TEXTURETYPE_FLOAT: number;
  94056. /** HALF_FLOAT */
  94057. static readonly TEXTURETYPE_HALF_FLOAT: number;
  94058. /** BYTE */
  94059. static readonly TEXTURETYPE_BYTE: number;
  94060. /** SHORT */
  94061. static readonly TEXTURETYPE_SHORT: number;
  94062. /** UNSIGNED_SHORT */
  94063. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  94064. /** INT */
  94065. static readonly TEXTURETYPE_INT: number;
  94066. /** UNSIGNED_INT */
  94067. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  94068. /** UNSIGNED_SHORT_4_4_4_4 */
  94069. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  94070. /** UNSIGNED_SHORT_5_5_5_1 */
  94071. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  94072. /** UNSIGNED_SHORT_5_6_5 */
  94073. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  94074. /** UNSIGNED_INT_2_10_10_10_REV */
  94075. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  94076. /** UNSIGNED_INT_24_8 */
  94077. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  94078. /** UNSIGNED_INT_10F_11F_11F_REV */
  94079. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  94080. /** UNSIGNED_INT_5_9_9_9_REV */
  94081. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  94082. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  94083. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  94084. /** nearest is mag = nearest and min = nearest and mip = linear */
  94085. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  94086. /** Bilinear is mag = linear and min = linear and mip = nearest */
  94087. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  94088. /** Trilinear is mag = linear and min = linear and mip = linear */
  94089. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  94090. /** nearest is mag = nearest and min = nearest and mip = linear */
  94091. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  94092. /** Bilinear is mag = linear and min = linear and mip = nearest */
  94093. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  94094. /** Trilinear is mag = linear and min = linear and mip = linear */
  94095. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  94096. /** mag = nearest and min = nearest and mip = nearest */
  94097. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  94098. /** mag = nearest and min = linear and mip = nearest */
  94099. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  94100. /** mag = nearest and min = linear and mip = linear */
  94101. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  94102. /** mag = nearest and min = linear and mip = none */
  94103. static readonly TEXTURE_NEAREST_LINEAR: number;
  94104. /** mag = nearest and min = nearest and mip = none */
  94105. static readonly TEXTURE_NEAREST_NEAREST: number;
  94106. /** mag = linear and min = nearest and mip = nearest */
  94107. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  94108. /** mag = linear and min = nearest and mip = linear */
  94109. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  94110. /** mag = linear and min = linear and mip = none */
  94111. static readonly TEXTURE_LINEAR_LINEAR: number;
  94112. /** mag = linear and min = nearest and mip = none */
  94113. static readonly TEXTURE_LINEAR_NEAREST: number;
  94114. /** Explicit coordinates mode */
  94115. static readonly TEXTURE_EXPLICIT_MODE: number;
  94116. /** Spherical coordinates mode */
  94117. static readonly TEXTURE_SPHERICAL_MODE: number;
  94118. /** Planar coordinates mode */
  94119. static readonly TEXTURE_PLANAR_MODE: number;
  94120. /** Cubic coordinates mode */
  94121. static readonly TEXTURE_CUBIC_MODE: number;
  94122. /** Projection coordinates mode */
  94123. static readonly TEXTURE_PROJECTION_MODE: number;
  94124. /** Skybox coordinates mode */
  94125. static readonly TEXTURE_SKYBOX_MODE: number;
  94126. /** Inverse Cubic coordinates mode */
  94127. static readonly TEXTURE_INVCUBIC_MODE: number;
  94128. /** Equirectangular coordinates mode */
  94129. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  94130. /** Equirectangular Fixed coordinates mode */
  94131. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  94132. /** Equirectangular Fixed Mirrored coordinates mode */
  94133. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  94134. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  94135. static readonly SCALEMODE_FLOOR: number;
  94136. /** Defines that texture rescaling will look for the nearest power of 2 size */
  94137. static readonly SCALEMODE_NEAREST: number;
  94138. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  94139. static readonly SCALEMODE_CEILING: number;
  94140. /**
  94141. * Returns the current npm package of the sdk
  94142. */
  94143. static readonly NpmPackage: string;
  94144. /**
  94145. * Returns the current version of the framework
  94146. */
  94147. static readonly Version: string;
  94148. /**
  94149. * Returns a string describing the current engine
  94150. */
  94151. readonly description: string;
  94152. /**
  94153. * Gets or sets the epsilon value used by collision engine
  94154. */
  94155. static CollisionsEpsilon: number;
  94156. /**
  94157. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  94158. */
  94159. static ShadersRepository: string;
  94160. /**
  94161. * Method called to create the default loading screen.
  94162. * This can be overriden in your own app.
  94163. * @param canvas The rendering canvas element
  94164. * @returns The loading screen
  94165. */
  94166. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  94167. /**
  94168. * Method called to create the default rescale post process on each engine.
  94169. */
  94170. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  94171. /** @hidden */
  94172. _shaderProcessor: IShaderProcessor;
  94173. /**
  94174. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  94175. */
  94176. forcePOTTextures: boolean;
  94177. /**
  94178. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  94179. */
  94180. isFullscreen: boolean;
  94181. /**
  94182. * Gets a boolean indicating if the pointer is currently locked
  94183. */
  94184. isPointerLock: boolean;
  94185. /**
  94186. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  94187. */
  94188. cullBackFaces: boolean;
  94189. /**
  94190. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  94191. */
  94192. renderEvenInBackground: boolean;
  94193. /**
  94194. * Gets or sets a boolean indicating that cache can be kept between frames
  94195. */
  94196. preventCacheWipeBetweenFrames: boolean;
  94197. /**
  94198. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  94199. **/
  94200. enableOfflineSupport: boolean;
  94201. /**
  94202. * 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)
  94203. **/
  94204. disableManifestCheck: boolean;
  94205. /**
  94206. * Gets the list of created scenes
  94207. */
  94208. scenes: Scene[];
  94209. /**
  94210. * Event raised when a new scene is created
  94211. */
  94212. onNewSceneAddedObservable: Observable<Scene>;
  94213. /**
  94214. * Gets the list of created postprocesses
  94215. */
  94216. postProcesses: PostProcess[];
  94217. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  94218. validateShaderPrograms: boolean;
  94219. /**
  94220. * Observable event triggered each time the rendering canvas is resized
  94221. */
  94222. onResizeObservable: Observable<Engine>;
  94223. /**
  94224. * Observable event triggered each time the canvas loses focus
  94225. */
  94226. onCanvasBlurObservable: Observable<Engine>;
  94227. /**
  94228. * Observable event triggered each time the canvas gains focus
  94229. */
  94230. onCanvasFocusObservable: Observable<Engine>;
  94231. /**
  94232. * Observable event triggered each time the canvas receives pointerout event
  94233. */
  94234. onCanvasPointerOutObservable: Observable<PointerEvent>;
  94235. /**
  94236. * Observable event triggered before each texture is initialized
  94237. */
  94238. onBeforeTextureInitObservable: Observable<Texture>;
  94239. /**
  94240. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  94241. */
  94242. disableUniformBuffers: boolean;
  94243. /** @hidden */
  94244. _uniformBuffers: UniformBuffer[];
  94245. /**
  94246. * Gets a boolean indicating that the engine supports uniform buffers
  94247. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  94248. */
  94249. readonly supportsUniformBuffers: boolean;
  94250. /**
  94251. * Observable raised when the engine begins a new frame
  94252. */
  94253. onBeginFrameObservable: Observable<Engine>;
  94254. /**
  94255. * If set, will be used to request the next animation frame for the render loop
  94256. */
  94257. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  94258. /**
  94259. * Observable raised when the engine ends the current frame
  94260. */
  94261. onEndFrameObservable: Observable<Engine>;
  94262. /**
  94263. * Observable raised when the engine is about to compile a shader
  94264. */
  94265. onBeforeShaderCompilationObservable: Observable<Engine>;
  94266. /**
  94267. * Observable raised when the engine has jsut compiled a shader
  94268. */
  94269. onAfterShaderCompilationObservable: Observable<Engine>;
  94270. /** @hidden */
  94271. _gl: WebGLRenderingContext;
  94272. private _renderingCanvas;
  94273. private _windowIsBackground;
  94274. private _webGLVersion;
  94275. protected _highPrecisionShadersAllowed: boolean;
  94276. /** @hidden */
  94277. readonly _shouldUseHighPrecisionShader: boolean;
  94278. /**
  94279. * Gets a boolean indicating that only power of 2 textures are supported
  94280. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  94281. */
  94282. readonly needPOTTextures: boolean;
  94283. /** @hidden */
  94284. _badOS: boolean;
  94285. /** @hidden */
  94286. _badDesktopOS: boolean;
  94287. /**
  94288. * Gets the audio engine
  94289. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  94290. * @ignorenaming
  94291. */
  94292. static audioEngine: IAudioEngine;
  94293. /**
  94294. * Default AudioEngine factory responsible of creating the Audio Engine.
  94295. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  94296. */
  94297. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  94298. /**
  94299. * Default offline support factory responsible of creating a tool used to store data locally.
  94300. * By default, this will create a Database object if the workload has been embedded.
  94301. */
  94302. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  94303. private _onFocus;
  94304. private _onBlur;
  94305. private _onCanvasPointerOut;
  94306. private _onCanvasBlur;
  94307. private _onCanvasFocus;
  94308. private _onFullscreenChange;
  94309. private _onPointerLockChange;
  94310. private _hardwareScalingLevel;
  94311. /** @hidden */
  94312. _caps: EngineCapabilities;
  94313. private _pointerLockRequested;
  94314. private _isStencilEnable;
  94315. private _colorWrite;
  94316. private _loadingScreen;
  94317. /** @hidden */
  94318. _drawCalls: PerfCounter;
  94319. private _glVersion;
  94320. private _glRenderer;
  94321. private _glVendor;
  94322. private _videoTextureSupported;
  94323. private _renderingQueueLaunched;
  94324. private _activeRenderLoops;
  94325. private _deterministicLockstep;
  94326. private _lockstepMaxSteps;
  94327. /**
  94328. * Observable signaled when a context lost event is raised
  94329. */
  94330. onContextLostObservable: Observable<Engine>;
  94331. /**
  94332. * Observable signaled when a context restored event is raised
  94333. */
  94334. onContextRestoredObservable: Observable<Engine>;
  94335. private _onContextLost;
  94336. private _onContextRestored;
  94337. private _contextWasLost;
  94338. /** @hidden */
  94339. _doNotHandleContextLost: boolean;
  94340. /**
  94341. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  94342. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  94343. */
  94344. doNotHandleContextLost: boolean;
  94345. private _performanceMonitor;
  94346. private _fps;
  94347. private _deltaTime;
  94348. /**
  94349. * Turn this value on if you want to pause FPS computation when in background
  94350. */
  94351. disablePerformanceMonitorInBackground: boolean;
  94352. /**
  94353. * Gets the performance monitor attached to this engine
  94354. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  94355. */
  94356. readonly performanceMonitor: PerformanceMonitor;
  94357. /**
  94358. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  94359. */
  94360. disableVertexArrayObjects: boolean;
  94361. /** @hidden */
  94362. protected _depthCullingState: _DepthCullingState;
  94363. /** @hidden */
  94364. protected _stencilState: _StencilState;
  94365. /** @hidden */
  94366. protected _alphaState: _AlphaState;
  94367. /** @hidden */
  94368. protected _alphaMode: number;
  94369. /** @hidden */
  94370. _internalTexturesCache: InternalTexture[];
  94371. /** @hidden */
  94372. protected _activeChannel: number;
  94373. private _currentTextureChannel;
  94374. /** @hidden */
  94375. protected _boundTexturesCache: {
  94376. [key: string]: Nullable<InternalTexture>;
  94377. };
  94378. /** @hidden */
  94379. protected _currentEffect: Nullable<Effect>;
  94380. /** @hidden */
  94381. protected _currentProgram: Nullable<WebGLProgram>;
  94382. private _compiledEffects;
  94383. private _vertexAttribArraysEnabled;
  94384. /** @hidden */
  94385. protected _cachedViewport: Nullable<IViewportLike>;
  94386. private _cachedVertexArrayObject;
  94387. /** @hidden */
  94388. protected _cachedVertexBuffers: any;
  94389. /** @hidden */
  94390. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  94391. /** @hidden */
  94392. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  94393. /** @hidden */
  94394. _currentRenderTarget: Nullable<InternalTexture>;
  94395. private _uintIndicesCurrentlySet;
  94396. private _currentBoundBuffer;
  94397. /** @hidden */
  94398. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  94399. private _currentBufferPointers;
  94400. private _currentInstanceLocations;
  94401. private _currentInstanceBuffers;
  94402. private _textureUnits;
  94403. /** @hidden */
  94404. _workingCanvas: Nullable<HTMLCanvasElement>;
  94405. /** @hidden */
  94406. _workingContext: Nullable<CanvasRenderingContext2D>;
  94407. private _rescalePostProcess;
  94408. private _dummyFramebuffer;
  94409. private _externalData;
  94410. /** @hidden */
  94411. _bindedRenderFunction: any;
  94412. private _vaoRecordInProgress;
  94413. private _mustWipeVertexAttributes;
  94414. private _emptyTexture;
  94415. private _emptyCubeTexture;
  94416. private _emptyTexture3D;
  94417. /** @hidden */
  94418. _frameHandler: number;
  94419. private _nextFreeTextureSlots;
  94420. private _maxSimultaneousTextures;
  94421. private _activeRequests;
  94422. private _texturesSupported;
  94423. /** @hidden */
  94424. _textureFormatInUse: Nullable<string>;
  94425. /**
  94426. * Gets the list of texture formats supported
  94427. */
  94428. readonly texturesSupported: Array<string>;
  94429. /**
  94430. * Gets the list of texture formats in use
  94431. */
  94432. readonly textureFormatInUse: Nullable<string>;
  94433. /**
  94434. * Gets the current viewport
  94435. */
  94436. readonly currentViewport: Nullable<IViewportLike>;
  94437. /**
  94438. * Gets the default empty texture
  94439. */
  94440. readonly emptyTexture: InternalTexture;
  94441. /**
  94442. * Gets the default empty 3D texture
  94443. */
  94444. readonly emptyTexture3D: InternalTexture;
  94445. /**
  94446. * Gets the default empty cube texture
  94447. */
  94448. readonly emptyCubeTexture: InternalTexture;
  94449. /**
  94450. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  94451. */
  94452. readonly premultipliedAlpha: boolean;
  94453. /**
  94454. * Creates a new engine
  94455. * @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
  94456. * @param antialias defines enable antialiasing (default: false)
  94457. * @param options defines further options to be sent to the getContext() function
  94458. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  94459. */
  94460. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  94461. /**
  94462. * Initializes a webVR display and starts listening to display change events
  94463. * The onVRDisplayChangedObservable will be notified upon these changes
  94464. * @returns The onVRDisplayChangedObservable
  94465. */
  94466. initWebVR(): Observable<IDisplayChangedEventArgs>;
  94467. /** @hidden */
  94468. _prepareVRComponent(): void;
  94469. /** @hidden */
  94470. _connectVREvents(canvas: HTMLCanvasElement, document: any): void;
  94471. /** @hidden */
  94472. _submitVRFrame(): void;
  94473. /**
  94474. * Call this function to leave webVR mode
  94475. * Will do nothing if webVR is not supported or if there is no webVR device
  94476. * @see http://doc.babylonjs.com/how_to/webvr_camera
  94477. */
  94478. disableVR(): void;
  94479. /**
  94480. * Gets a boolean indicating that the system is in VR mode and is presenting
  94481. * @returns true if VR mode is engaged
  94482. */
  94483. isVRPresenting(): boolean;
  94484. /** @hidden */
  94485. _requestVRFrame(): void;
  94486. private _disableTouchAction;
  94487. private _rebuildInternalTextures;
  94488. private _rebuildEffects;
  94489. /**
  94490. * Gets a boolean indicating if all created effects are ready
  94491. * @returns true if all effects are ready
  94492. */
  94493. areAllEffectsReady(): boolean;
  94494. private _rebuildBuffers;
  94495. private _initGLContext;
  94496. /**
  94497. * Gets version of the current webGL context
  94498. */
  94499. readonly webGLVersion: number;
  94500. /**
  94501. * Gets a string idenfifying the name of the class
  94502. * @returns "Engine" string
  94503. */
  94504. getClassName(): string;
  94505. /**
  94506. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  94507. */
  94508. readonly isStencilEnable: boolean;
  94509. /** @hidden */
  94510. _prepareWorkingCanvas(): void;
  94511. /**
  94512. * Reset the texture cache to empty state
  94513. */
  94514. resetTextureCache(): void;
  94515. /**
  94516. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  94517. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  94518. * @returns true if engine is in deterministic lock step mode
  94519. */
  94520. isDeterministicLockStep(): boolean;
  94521. /**
  94522. * Gets the max steps when engine is running in deterministic lock step
  94523. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  94524. * @returns the max steps
  94525. */
  94526. getLockstepMaxSteps(): number;
  94527. /**
  94528. * Gets an object containing information about the current webGL context
  94529. * @returns an object containing the vender, the renderer and the version of the current webGL context
  94530. */
  94531. getGlInfo(): {
  94532. vendor: string;
  94533. renderer: string;
  94534. version: string;
  94535. };
  94536. /**
  94537. * Gets current aspect ratio
  94538. * @param viewportOwner defines the camera to use to get the aspect ratio
  94539. * @param useScreen defines if screen size must be used (or the current render target if any)
  94540. * @returns a number defining the aspect ratio
  94541. */
  94542. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  94543. /**
  94544. * Gets current screen aspect ratio
  94545. * @returns a number defining the aspect ratio
  94546. */
  94547. getScreenAspectRatio(): number;
  94548. /**
  94549. * Gets the current render width
  94550. * @param useScreen defines if screen size must be used (or the current render target if any)
  94551. * @returns a number defining the current render width
  94552. */
  94553. getRenderWidth(useScreen?: boolean): number;
  94554. /**
  94555. * Gets the current render height
  94556. * @param useScreen defines if screen size must be used (or the current render target if any)
  94557. * @returns a number defining the current render height
  94558. */
  94559. getRenderHeight(useScreen?: boolean): number;
  94560. /**
  94561. * Gets the HTML canvas attached with the current webGL context
  94562. * @returns a HTML canvas
  94563. */
  94564. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  94565. /**
  94566. * Gets host window
  94567. * @returns the host window object
  94568. */
  94569. getHostWindow(): Window;
  94570. /**
  94571. * Gets host document
  94572. * @returns the host document object
  94573. */
  94574. getHostDocument(): Document;
  94575. /**
  94576. * Gets the client rect of the HTML canvas attached with the current webGL context
  94577. * @returns a client rectanglee
  94578. */
  94579. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  94580. /**
  94581. * Defines the hardware scaling level.
  94582. * By default the hardware scaling level is computed from the window device ratio.
  94583. * 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.
  94584. * @param level defines the level to use
  94585. */
  94586. setHardwareScalingLevel(level: number): void;
  94587. /**
  94588. * Gets the current hardware scaling level.
  94589. * By default the hardware scaling level is computed from the window device ratio.
  94590. * 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.
  94591. * @returns a number indicating the current hardware scaling level
  94592. */
  94593. getHardwareScalingLevel(): number;
  94594. /**
  94595. * Gets the list of loaded textures
  94596. * @returns an array containing all loaded textures
  94597. */
  94598. getLoadedTexturesCache(): InternalTexture[];
  94599. /**
  94600. * Gets the object containing all engine capabilities
  94601. * @returns the EngineCapabilities object
  94602. */
  94603. getCaps(): EngineCapabilities;
  94604. /**
  94605. * Gets the current depth function
  94606. * @returns a number defining the depth function
  94607. */
  94608. getDepthFunction(): Nullable<number>;
  94609. /**
  94610. * Sets the current depth function
  94611. * @param depthFunc defines the function to use
  94612. */
  94613. setDepthFunction(depthFunc: number): void;
  94614. /**
  94615. * Sets the current depth function to GREATER
  94616. */
  94617. setDepthFunctionToGreater(): void;
  94618. /**
  94619. * Sets the current depth function to GEQUAL
  94620. */
  94621. setDepthFunctionToGreaterOrEqual(): void;
  94622. /**
  94623. * Sets the current depth function to LESS
  94624. */
  94625. setDepthFunctionToLess(): void;
  94626. private _cachedStencilBuffer;
  94627. private _cachedStencilFunction;
  94628. private _cachedStencilMask;
  94629. private _cachedStencilOperationPass;
  94630. private _cachedStencilOperationFail;
  94631. private _cachedStencilOperationDepthFail;
  94632. private _cachedStencilReference;
  94633. /**
  94634. * Caches the the state of the stencil buffer
  94635. */
  94636. cacheStencilState(): void;
  94637. /**
  94638. * Restores the state of the stencil buffer
  94639. */
  94640. restoreStencilState(): void;
  94641. /**
  94642. * Sets the current depth function to LEQUAL
  94643. */
  94644. setDepthFunctionToLessOrEqual(): void;
  94645. /**
  94646. * Gets a boolean indicating if stencil buffer is enabled
  94647. * @returns the current stencil buffer state
  94648. */
  94649. getStencilBuffer(): boolean;
  94650. /**
  94651. * Enable or disable the stencil buffer
  94652. * @param enable defines if the stencil buffer must be enabled or disabled
  94653. */
  94654. setStencilBuffer(enable: boolean): void;
  94655. /**
  94656. * Gets the current stencil mask
  94657. * @returns a number defining the new stencil mask to use
  94658. */
  94659. getStencilMask(): number;
  94660. /**
  94661. * Sets the current stencil mask
  94662. * @param mask defines the new stencil mask to use
  94663. */
  94664. setStencilMask(mask: number): void;
  94665. /**
  94666. * Gets the current stencil function
  94667. * @returns a number defining the stencil function to use
  94668. */
  94669. getStencilFunction(): number;
  94670. /**
  94671. * Gets the current stencil reference value
  94672. * @returns a number defining the stencil reference value to use
  94673. */
  94674. getStencilFunctionReference(): number;
  94675. /**
  94676. * Gets the current stencil mask
  94677. * @returns a number defining the stencil mask to use
  94678. */
  94679. getStencilFunctionMask(): number;
  94680. /**
  94681. * Sets the current stencil function
  94682. * @param stencilFunc defines the new stencil function to use
  94683. */
  94684. setStencilFunction(stencilFunc: number): void;
  94685. /**
  94686. * Sets the current stencil reference
  94687. * @param reference defines the new stencil reference to use
  94688. */
  94689. setStencilFunctionReference(reference: number): void;
  94690. /**
  94691. * Sets the current stencil mask
  94692. * @param mask defines the new stencil mask to use
  94693. */
  94694. setStencilFunctionMask(mask: number): void;
  94695. /**
  94696. * Gets the current stencil operation when stencil fails
  94697. * @returns a number defining stencil operation to use when stencil fails
  94698. */
  94699. getStencilOperationFail(): number;
  94700. /**
  94701. * Gets the current stencil operation when depth fails
  94702. * @returns a number defining stencil operation to use when depth fails
  94703. */
  94704. getStencilOperationDepthFail(): number;
  94705. /**
  94706. * Gets the current stencil operation when stencil passes
  94707. * @returns a number defining stencil operation to use when stencil passes
  94708. */
  94709. getStencilOperationPass(): number;
  94710. /**
  94711. * Sets the stencil operation to use when stencil fails
  94712. * @param operation defines the stencil operation to use when stencil fails
  94713. */
  94714. setStencilOperationFail(operation: number): void;
  94715. /**
  94716. * Sets the stencil operation to use when depth fails
  94717. * @param operation defines the stencil operation to use when depth fails
  94718. */
  94719. setStencilOperationDepthFail(operation: number): void;
  94720. /**
  94721. * Sets the stencil operation to use when stencil passes
  94722. * @param operation defines the stencil operation to use when stencil passes
  94723. */
  94724. setStencilOperationPass(operation: number): void;
  94725. /**
  94726. * Sets a boolean indicating if the dithering state is enabled or disabled
  94727. * @param value defines the dithering state
  94728. */
  94729. setDitheringState(value: boolean): void;
  94730. /**
  94731. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  94732. * @param value defines the rasterizer state
  94733. */
  94734. setRasterizerState(value: boolean): void;
  94735. /**
  94736. * stop executing a render loop function and remove it from the execution array
  94737. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  94738. */
  94739. stopRenderLoop(renderFunction?: () => void): void;
  94740. /** @hidden */
  94741. _renderLoop(): void;
  94742. /**
  94743. * Register and execute a render loop. The engine can have more than one render function
  94744. * @param renderFunction defines the function to continuously execute
  94745. */
  94746. runRenderLoop(renderFunction: () => void): void;
  94747. /**
  94748. * Toggle full screen mode
  94749. * @param requestPointerLock defines if a pointer lock should be requested from the user
  94750. */
  94751. switchFullscreen(requestPointerLock: boolean): void;
  94752. /**
  94753. * Enters full screen mode
  94754. * @param requestPointerLock defines if a pointer lock should be requested from the user
  94755. */
  94756. enterFullscreen(requestPointerLock: boolean): void;
  94757. /**
  94758. * Exits full screen mode
  94759. */
  94760. exitFullscreen(): void;
  94761. /**
  94762. * Enters Pointerlock mode
  94763. */
  94764. enterPointerlock(): void;
  94765. /**
  94766. * Exits Pointerlock mode
  94767. */
  94768. exitPointerlock(): void;
  94769. /**
  94770. * Clear the current render buffer or the current render target (if any is set up)
  94771. * @param color defines the color to use
  94772. * @param backBuffer defines if the back buffer must be cleared
  94773. * @param depth defines if the depth buffer must be cleared
  94774. * @param stencil defines if the stencil buffer must be cleared
  94775. */
  94776. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  94777. /**
  94778. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  94779. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  94780. * @param y defines the y-coordinate of the corner of the clear rectangle
  94781. * @param width defines the width of the clear rectangle
  94782. * @param height defines the height of the clear rectangle
  94783. * @param clearColor defines the clear color
  94784. */
  94785. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  94786. /**
  94787. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  94788. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  94789. * @param y defines the y-coordinate of the corner of the clear rectangle
  94790. * @param width defines the width of the clear rectangle
  94791. * @param height defines the height of the clear rectangle
  94792. */
  94793. enableScissor(x: number, y: number, width: number, height: number): void;
  94794. /**
  94795. * Disable previously set scissor test rectangle
  94796. */
  94797. disableScissor(): void;
  94798. private _viewportCached;
  94799. /** @hidden */
  94800. _viewport(x: number, y: number, width: number, height: number): void;
  94801. /**
  94802. * Set the WebGL's viewport
  94803. * @param viewport defines the viewport element to be used
  94804. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  94805. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  94806. */
  94807. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  94808. /**
  94809. * Directly set the WebGL Viewport
  94810. * @param x defines the x coordinate of the viewport (in screen space)
  94811. * @param y defines the y coordinate of the viewport (in screen space)
  94812. * @param width defines the width of the viewport (in screen space)
  94813. * @param height defines the height of the viewport (in screen space)
  94814. * @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
  94815. */
  94816. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  94817. /**
  94818. * Begin a new frame
  94819. */
  94820. beginFrame(): void;
  94821. /**
  94822. * Enf the current frame
  94823. */
  94824. endFrame(): void;
  94825. /**
  94826. * Resize the view according to the canvas' size
  94827. */
  94828. resize(): void;
  94829. /**
  94830. * Force a specific size of the canvas
  94831. * @param width defines the new canvas' width
  94832. * @param height defines the new canvas' height
  94833. */
  94834. setSize(width: number, height: number): void;
  94835. /**
  94836. * Binds the frame buffer to the specified texture.
  94837. * @param texture The texture to render to or null for the default canvas
  94838. * @param faceIndex The face of the texture to render to in case of cube texture
  94839. * @param requiredWidth The width of the target to render to
  94840. * @param requiredHeight The height of the target to render to
  94841. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  94842. * @param depthStencilTexture The depth stencil texture to use to render
  94843. * @param lodLevel defines le lod level to bind to the frame buffer
  94844. */
  94845. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  94846. /** @hidden */
  94847. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  94848. /**
  94849. * Unbind the current render target texture from the webGL context
  94850. * @param texture defines the render target texture to unbind
  94851. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  94852. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  94853. */
  94854. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  94855. /**
  94856. * Force the mipmap generation for the given render target texture
  94857. * @param texture defines the render target texture to use
  94858. */
  94859. generateMipMapsForCubemap(texture: InternalTexture): void;
  94860. /**
  94861. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  94862. */
  94863. flushFramebuffer(): void;
  94864. /**
  94865. * Unbind the current render target and bind the default framebuffer
  94866. */
  94867. restoreDefaultFramebuffer(): void;
  94868. /**
  94869. * Create an uniform buffer
  94870. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  94871. * @param elements defines the content of the uniform buffer
  94872. * @returns the webGL uniform buffer
  94873. */
  94874. createUniformBuffer(elements: FloatArray): DataBuffer;
  94875. /**
  94876. * Create a dynamic uniform buffer
  94877. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  94878. * @param elements defines the content of the uniform buffer
  94879. * @returns the webGL uniform buffer
  94880. */
  94881. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  94882. /**
  94883. * Update an existing uniform buffer
  94884. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  94885. * @param uniformBuffer defines the target uniform buffer
  94886. * @param elements defines the content to update
  94887. * @param offset defines the offset in the uniform buffer where update should start
  94888. * @param count defines the size of the data to update
  94889. */
  94890. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  94891. private _resetVertexBufferBinding;
  94892. /**
  94893. * Creates a vertex buffer
  94894. * @param data the data for the vertex buffer
  94895. * @returns the new WebGL static buffer
  94896. */
  94897. createVertexBuffer(data: DataArray): DataBuffer;
  94898. /**
  94899. * Creates a dynamic vertex buffer
  94900. * @param data the data for the dynamic vertex buffer
  94901. * @returns the new WebGL dynamic buffer
  94902. */
  94903. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  94904. /**
  94905. * Update a dynamic index buffer
  94906. * @param indexBuffer defines the target index buffer
  94907. * @param indices defines the data to update
  94908. * @param offset defines the offset in the target index buffer where update should start
  94909. */
  94910. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  94911. /**
  94912. * Updates a dynamic vertex buffer.
  94913. * @param vertexBuffer the vertex buffer to update
  94914. * @param data the data used to update the vertex buffer
  94915. * @param byteOffset the byte offset of the data
  94916. * @param byteLength the byte length of the data
  94917. */
  94918. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  94919. private _resetIndexBufferBinding;
  94920. /**
  94921. * Creates a new index buffer
  94922. * @param indices defines the content of the index buffer
  94923. * @param updatable defines if the index buffer must be updatable
  94924. * @returns a new webGL buffer
  94925. */
  94926. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  94927. /**
  94928. * Bind a webGL buffer to the webGL context
  94929. * @param buffer defines the buffer to bind
  94930. */
  94931. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  94932. /**
  94933. * Bind an uniform buffer to the current webGL context
  94934. * @param buffer defines the buffer to bind
  94935. */
  94936. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  94937. /**
  94938. * Bind a buffer to the current webGL context at a given location
  94939. * @param buffer defines the buffer to bind
  94940. * @param location defines the index where to bind the buffer
  94941. */
  94942. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  94943. /**
  94944. * Bind a specific block at a given index in a specific shader program
  94945. * @param pipelineContext defines the pipeline context to use
  94946. * @param blockName defines the block name
  94947. * @param index defines the index where to bind the block
  94948. */
  94949. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  94950. private bindIndexBuffer;
  94951. private bindBuffer;
  94952. /**
  94953. * update the bound buffer with the given data
  94954. * @param data defines the data to update
  94955. */
  94956. updateArrayBuffer(data: Float32Array): void;
  94957. private _vertexAttribPointer;
  94958. private _bindIndexBufferWithCache;
  94959. private _bindVertexBuffersAttributes;
  94960. /**
  94961. * Records a vertex array object
  94962. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  94963. * @param vertexBuffers defines the list of vertex buffers to store
  94964. * @param indexBuffer defines the index buffer to store
  94965. * @param effect defines the effect to store
  94966. * @returns the new vertex array object
  94967. */
  94968. recordVertexArrayObject(vertexBuffers: {
  94969. [key: string]: VertexBuffer;
  94970. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  94971. /**
  94972. * Bind a specific vertex array object
  94973. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  94974. * @param vertexArrayObject defines the vertex array object to bind
  94975. * @param indexBuffer defines the index buffer to bind
  94976. */
  94977. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  94978. /**
  94979. * Bind webGl buffers directly to the webGL context
  94980. * @param vertexBuffer defines the vertex buffer to bind
  94981. * @param indexBuffer defines the index buffer to bind
  94982. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  94983. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  94984. * @param effect defines the effect associated with the vertex buffer
  94985. */
  94986. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  94987. private _unbindVertexArrayObject;
  94988. /**
  94989. * Bind a list of vertex buffers to the webGL context
  94990. * @param vertexBuffers defines the list of vertex buffers to bind
  94991. * @param indexBuffer defines the index buffer to bind
  94992. * @param effect defines the effect associated with the vertex buffers
  94993. */
  94994. bindBuffers(vertexBuffers: {
  94995. [key: string]: Nullable<VertexBuffer>;
  94996. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  94997. /**
  94998. * Unbind all instance attributes
  94999. */
  95000. unbindInstanceAttributes(): void;
  95001. /**
  95002. * Release and free the memory of a vertex array object
  95003. * @param vao defines the vertex array object to delete
  95004. */
  95005. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  95006. /** @hidden */
  95007. _releaseBuffer(buffer: DataBuffer): boolean;
  95008. /**
  95009. * Creates a webGL buffer to use with instanciation
  95010. * @param capacity defines the size of the buffer
  95011. * @returns the webGL buffer
  95012. */
  95013. createInstancesBuffer(capacity: number): DataBuffer;
  95014. /**
  95015. * Delete a webGL buffer used with instanciation
  95016. * @param buffer defines the webGL buffer to delete
  95017. */
  95018. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  95019. /**
  95020. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  95021. * @param instancesBuffer defines the webGL buffer to update and bind
  95022. * @param data defines the data to store in the buffer
  95023. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  95024. */
  95025. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  95026. /**
  95027. * Apply all cached states (depth, culling, stencil and alpha)
  95028. */
  95029. applyStates(): void;
  95030. /**
  95031. * Send a draw order
  95032. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  95033. * @param indexStart defines the starting index
  95034. * @param indexCount defines the number of index to draw
  95035. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  95036. */
  95037. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  95038. /**
  95039. * Draw a list of points
  95040. * @param verticesStart defines the index of first vertex to draw
  95041. * @param verticesCount defines the count of vertices to draw
  95042. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  95043. */
  95044. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  95045. /**
  95046. * Draw a list of unindexed primitives
  95047. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  95048. * @param verticesStart defines the index of first vertex to draw
  95049. * @param verticesCount defines the count of vertices to draw
  95050. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  95051. */
  95052. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  95053. /**
  95054. * Draw a list of indexed primitives
  95055. * @param fillMode defines the primitive to use
  95056. * @param indexStart defines the starting index
  95057. * @param indexCount defines the number of index to draw
  95058. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  95059. */
  95060. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  95061. /**
  95062. * Draw a list of unindexed primitives
  95063. * @param fillMode defines the primitive to use
  95064. * @param verticesStart defines the index of first vertex to draw
  95065. * @param verticesCount defines the count of vertices to draw
  95066. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  95067. */
  95068. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  95069. private _drawMode;
  95070. /** @hidden */
  95071. _releaseEffect(effect: Effect): void;
  95072. /** @hidden */
  95073. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  95074. /**
  95075. * Create a new effect (used to store vertex/fragment shaders)
  95076. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  95077. * @param attributesNamesOrOptions defines either a list of attribute names or an EffectCreationOptions object
  95078. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  95079. * @param samplers defines an array of string used to represent textures
  95080. * @param defines defines the string containing the defines to use to compile the shaders
  95081. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  95082. * @param onCompiled defines a function to call when the effect creation is successful
  95083. * @param onError defines a function to call when the effect creation has failed
  95084. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  95085. * @returns the new Effect
  95086. */
  95087. createEffect(baseName: any, attributesNamesOrOptions: string[] | EffectCreationOptions, uniformsNamesOrEngine: string[] | Engine, samplers?: string[], defines?: string, fallbacks?: EffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  95088. private _compileShader;
  95089. private _compileRawShader;
  95090. /**
  95091. * Directly creates a webGL program
  95092. * @param pipelineContext defines the pipeline context to attach to
  95093. * @param vertexCode defines the vertex shader code to use
  95094. * @param fragmentCode defines the fragment shader code to use
  95095. * @param context defines the webGL context to use (if not set, the current one will be used)
  95096. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  95097. * @returns the new webGL program
  95098. */
  95099. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  95100. /**
  95101. * Creates a webGL program
  95102. * @param pipelineContext defines the pipeline context to attach to
  95103. * @param vertexCode defines the vertex shader code to use
  95104. * @param fragmentCode defines the fragment shader code to use
  95105. * @param defines defines the string containing the defines to use to compile the shaders
  95106. * @param context defines the webGL context to use (if not set, the current one will be used)
  95107. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  95108. * @returns the new webGL program
  95109. */
  95110. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  95111. /**
  95112. * Creates a new pipeline context
  95113. * @returns the new pipeline
  95114. */
  95115. createPipelineContext(): WebGLPipelineContext;
  95116. private _createShaderProgram;
  95117. private _finalizePipelineContext;
  95118. /** @hidden */
  95119. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  95120. /** @hidden */
  95121. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  95122. /** @hidden */
  95123. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  95124. /**
  95125. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  95126. * @param pipelineContext defines the pipeline context to use
  95127. * @param uniformsNames defines the list of uniform names
  95128. * @returns an array of webGL uniform locations
  95129. */
  95130. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  95131. /**
  95132. * Gets the lsit of active attributes for a given webGL program
  95133. * @param pipelineContext defines the pipeline context to use
  95134. * @param attributesNames defines the list of attribute names to get
  95135. * @returns an array of indices indicating the offset of each attribute
  95136. */
  95137. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  95138. /**
  95139. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  95140. * @param effect defines the effect to activate
  95141. */
  95142. enableEffect(effect: Nullable<Effect>): void;
  95143. /**
  95144. * Set the value of an uniform to an array of int32
  95145. * @param uniform defines the webGL uniform location where to store the value
  95146. * @param array defines the array of int32 to store
  95147. */
  95148. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  95149. /**
  95150. * Set the value of an uniform to an array of int32 (stored as vec2)
  95151. * @param uniform defines the webGL uniform location where to store the value
  95152. * @param array defines the array of int32 to store
  95153. */
  95154. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  95155. /**
  95156. * Set the value of an uniform to an array of int32 (stored as vec3)
  95157. * @param uniform defines the webGL uniform location where to store the value
  95158. * @param array defines the array of int32 to store
  95159. */
  95160. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  95161. /**
  95162. * Set the value of an uniform to an array of int32 (stored as vec4)
  95163. * @param uniform defines the webGL uniform location where to store the value
  95164. * @param array defines the array of int32 to store
  95165. */
  95166. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  95167. /**
  95168. * Set the value of an uniform to an array of float32
  95169. * @param uniform defines the webGL uniform location where to store the value
  95170. * @param array defines the array of float32 to store
  95171. */
  95172. setFloatArray(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  95173. /**
  95174. * Set the value of an uniform to an array of float32 (stored as vec2)
  95175. * @param uniform defines the webGL uniform location where to store the value
  95176. * @param array defines the array of float32 to store
  95177. */
  95178. setFloatArray2(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  95179. /**
  95180. * Set the value of an uniform to an array of float32 (stored as vec3)
  95181. * @param uniform defines the webGL uniform location where to store the value
  95182. * @param array defines the array of float32 to store
  95183. */
  95184. setFloatArray3(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  95185. /**
  95186. * Set the value of an uniform to an array of float32 (stored as vec4)
  95187. * @param uniform defines the webGL uniform location where to store the value
  95188. * @param array defines the array of float32 to store
  95189. */
  95190. setFloatArray4(uniform: Nullable<WebGLUniformLocation>, array: Float32Array): void;
  95191. /**
  95192. * Set the value of an uniform to an array of number
  95193. * @param uniform defines the webGL uniform location where to store the value
  95194. * @param array defines the array of number to store
  95195. */
  95196. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  95197. /**
  95198. * Set the value of an uniform to an array of number (stored as vec2)
  95199. * @param uniform defines the webGL uniform location where to store the value
  95200. * @param array defines the array of number to store
  95201. */
  95202. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  95203. /**
  95204. * Set the value of an uniform to an array of number (stored as vec3)
  95205. * @param uniform defines the webGL uniform location where to store the value
  95206. * @param array defines the array of number to store
  95207. */
  95208. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  95209. /**
  95210. * Set the value of an uniform to an array of number (stored as vec4)
  95211. * @param uniform defines the webGL uniform location where to store the value
  95212. * @param array defines the array of number to store
  95213. */
  95214. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[]): void;
  95215. /**
  95216. * Set the value of an uniform to an array of float32 (stored as matrices)
  95217. * @param uniform defines the webGL uniform location where to store the value
  95218. * @param matrices defines the array of float32 to store
  95219. */
  95220. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  95221. /**
  95222. * Set the value of an uniform to a matrix (3x3)
  95223. * @param uniform defines the webGL uniform location where to store the value
  95224. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  95225. */
  95226. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  95227. /**
  95228. * Set the value of an uniform to a matrix (2x2)
  95229. * @param uniform defines the webGL uniform location where to store the value
  95230. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  95231. */
  95232. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  95233. /**
  95234. * Set the value of an uniform to a number (int)
  95235. * @param uniform defines the webGL uniform location where to store the value
  95236. * @param value defines the int number to store
  95237. */
  95238. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  95239. /**
  95240. * Set the value of an uniform to a number (float)
  95241. * @param uniform defines the webGL uniform location where to store the value
  95242. * @param value defines the float number to store
  95243. */
  95244. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  95245. /**
  95246. * Set the value of an uniform to a vec2
  95247. * @param uniform defines the webGL uniform location where to store the value
  95248. * @param x defines the 1st component of the value
  95249. * @param y defines the 2nd component of the value
  95250. */
  95251. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  95252. /**
  95253. * Set the value of an uniform to a vec3
  95254. * @param uniform defines the webGL uniform location where to store the value
  95255. * @param x defines the 1st component of the value
  95256. * @param y defines the 2nd component of the value
  95257. * @param z defines the 3rd component of the value
  95258. */
  95259. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  95260. /**
  95261. * Set the value of an uniform to a boolean
  95262. * @param uniform defines the webGL uniform location where to store the value
  95263. * @param bool defines the boolean to store
  95264. */
  95265. setBool(uniform: Nullable<WebGLUniformLocation>, bool: number): void;
  95266. /**
  95267. * Set the value of an uniform to a vec4
  95268. * @param uniform defines the webGL uniform location where to store the value
  95269. * @param x defines the 1st component of the value
  95270. * @param y defines the 2nd component of the value
  95271. * @param z defines the 3rd component of the value
  95272. * @param w defines the 4th component of the value
  95273. */
  95274. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  95275. /**
  95276. * Sets a Color4 on a uniform variable
  95277. * @param uniform defines the uniform location
  95278. * @param color4 defines the value to be set
  95279. */
  95280. setDirectColor4(uniform: Nullable<WebGLUniformLocation>, color4: IColor4Like): void;
  95281. /**
  95282. * Set various states to the webGL context
  95283. * @param culling defines backface culling state
  95284. * @param zOffset defines the value to apply to zOffset (0 by default)
  95285. * @param force defines if states must be applied even if cache is up to date
  95286. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  95287. */
  95288. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  95289. /**
  95290. * Set the z offset to apply to current rendering
  95291. * @param value defines the offset to apply
  95292. */
  95293. setZOffset(value: number): void;
  95294. /**
  95295. * Gets the current value of the zOffset
  95296. * @returns the current zOffset state
  95297. */
  95298. getZOffset(): number;
  95299. /**
  95300. * Enable or disable depth buffering
  95301. * @param enable defines the state to set
  95302. */
  95303. setDepthBuffer(enable: boolean): void;
  95304. /**
  95305. * Gets a boolean indicating if depth writing is enabled
  95306. * @returns the current depth writing state
  95307. */
  95308. getDepthWrite(): boolean;
  95309. /**
  95310. * Enable or disable depth writing
  95311. * @param enable defines the state to set
  95312. */
  95313. setDepthWrite(enable: boolean): void;
  95314. /**
  95315. * Enable or disable color writing
  95316. * @param enable defines the state to set
  95317. */
  95318. setColorWrite(enable: boolean): void;
  95319. /**
  95320. * Gets a boolean indicating if color writing is enabled
  95321. * @returns the current color writing state
  95322. */
  95323. getColorWrite(): boolean;
  95324. /**
  95325. * Sets alpha constants used by some alpha blending modes
  95326. * @param r defines the red component
  95327. * @param g defines the green component
  95328. * @param b defines the blue component
  95329. * @param a defines the alpha component
  95330. */
  95331. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  95332. /**
  95333. * Sets the current alpha mode
  95334. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  95335. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  95336. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  95337. */
  95338. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  95339. /**
  95340. * Gets the current alpha mode
  95341. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  95342. * @returns the current alpha mode
  95343. */
  95344. getAlphaMode(): number;
  95345. /**
  95346. * Clears the list of texture accessible through engine.
  95347. * This can help preventing texture load conflict due to name collision.
  95348. */
  95349. clearInternalTexturesCache(): void;
  95350. /**
  95351. * Force the entire cache to be cleared
  95352. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  95353. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  95354. */
  95355. wipeCaches(bruteForce?: boolean): void;
  95356. /**
  95357. * Set the compressed texture format to use, based on the formats you have, and the formats
  95358. * supported by the hardware / browser.
  95359. *
  95360. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  95361. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  95362. * to API arguments needed to compressed textures. This puts the burden on the container
  95363. * generator to house the arcane code for determining these for current & future formats.
  95364. *
  95365. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  95366. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  95367. *
  95368. * Note: The result of this call is not taken into account when a texture is base64.
  95369. *
  95370. * @param formatsAvailable defines the list of those format families you have created
  95371. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  95372. *
  95373. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  95374. * @returns The extension selected.
  95375. */
  95376. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  95377. /** @hidden */
  95378. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  95379. min: number;
  95380. mag: number;
  95381. };
  95382. /** @hidden */
  95383. _createTexture(): WebGLTexture;
  95384. /**
  95385. * Usually called from Texture.ts.
  95386. * Passed information to create a WebGLTexture
  95387. * @param urlArg defines a value which contains one of the following:
  95388. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  95389. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  95390. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  95391. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  95392. * @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)
  95393. * @param scene needed for loading to the correct scene
  95394. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  95395. * @param onLoad optional callback to be called upon successful completion
  95396. * @param onError optional callback to be called upon failure
  95397. * @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
  95398. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  95399. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  95400. * @param forcedExtension defines the extension to use to pick the right loader
  95401. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  95402. * @returns a InternalTexture for assignment back into BABYLON.Texture
  95403. */
  95404. 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 | HTMLImageElement | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>): InternalTexture;
  95405. /**
  95406. * @hidden
  95407. * Rescales a texture
  95408. * @param source input texutre
  95409. * @param destination destination texture
  95410. * @param scene scene to use to render the resize
  95411. * @param internalFormat format to use when resizing
  95412. * @param onComplete callback to be called when resize has completed
  95413. */
  95414. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<Scene>, internalFormat: number, onComplete: () => void): void;
  95415. private _unpackFlipYCached;
  95416. /**
  95417. * In case you are sharing the context with other applications, it might
  95418. * be interested to not cache the unpack flip y state to ensure a consistent
  95419. * value would be set.
  95420. */
  95421. enableUnpackFlipYCached: boolean;
  95422. /** @hidden */
  95423. _unpackFlipY(value: boolean): void;
  95424. /** @hidden */
  95425. _getUnpackAlignement(): number;
  95426. /**
  95427. * Creates a dynamic texture
  95428. * @param width defines the width of the texture
  95429. * @param height defines the height of the texture
  95430. * @param generateMipMaps defines if the engine should generate the mip levels
  95431. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  95432. * @returns the dynamic texture inside an InternalTexture
  95433. */
  95434. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  95435. /**
  95436. * Update the sampling mode of a given texture
  95437. * @param samplingMode defines the required sampling mode
  95438. * @param texture defines the texture to update
  95439. */
  95440. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  95441. /**
  95442. * Update the content of a dynamic texture
  95443. * @param texture defines the texture to update
  95444. * @param canvas defines the canvas containing the source
  95445. * @param invertY defines if data must be stored with Y axis inverted
  95446. * @param premulAlpha defines if alpha is stored as premultiplied
  95447. * @param format defines the format of the data
  95448. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  95449. */
  95450. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  95451. /**
  95452. * Update a video texture
  95453. * @param texture defines the texture to update
  95454. * @param video defines the video element to use
  95455. * @param invertY defines if data must be stored with Y axis inverted
  95456. */
  95457. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  95458. /**
  95459. * Updates a depth texture Comparison Mode and Function.
  95460. * If the comparison Function is equal to 0, the mode will be set to none.
  95461. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  95462. * @param texture The texture to set the comparison function for
  95463. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  95464. */
  95465. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  95466. /** @hidden */
  95467. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  95468. width: number;
  95469. height: number;
  95470. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  95471. /**
  95472. * Creates a depth stencil texture.
  95473. * This is only available in WebGL 2 or with the depth texture extension available.
  95474. * @param size The size of face edge in the texture.
  95475. * @param options The options defining the texture.
  95476. * @returns The texture
  95477. */
  95478. createDepthStencilTexture(size: number | {
  95479. width: number;
  95480. height: number;
  95481. }, options: DepthTextureCreationOptions): InternalTexture;
  95482. /**
  95483. * Creates a depth stencil texture.
  95484. * This is only available in WebGL 2 or with the depth texture extension available.
  95485. * @param size The size of face edge in the texture.
  95486. * @param options The options defining the texture.
  95487. * @returns The texture
  95488. */
  95489. private _createDepthStencilTexture;
  95490. /**
  95491. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  95492. * @param renderTarget The render target to set the frame buffer for
  95493. */
  95494. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  95495. /**
  95496. * Creates a new render target texture
  95497. * @param size defines the size of the texture
  95498. * @param options defines the options used to create the texture
  95499. * @returns a new render target texture stored in an InternalTexture
  95500. */
  95501. createRenderTargetTexture(size: number | {
  95502. width: number;
  95503. height: number;
  95504. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  95505. /** @hidden */
  95506. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  95507. /**
  95508. * Updates the sample count of a render target texture
  95509. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  95510. * @param texture defines the texture to update
  95511. * @param samples defines the sample count to set
  95512. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  95513. */
  95514. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  95515. /** @hidden */
  95516. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  95517. /** @hidden */
  95518. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  95519. /** @hidden */
  95520. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  95521. /** @hidden */
  95522. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  95523. /**
  95524. * @hidden
  95525. */
  95526. _setCubeMapTextureParams(loadMipmap: boolean): void;
  95527. private _prepareWebGLTextureContinuation;
  95528. private _prepareWebGLTexture;
  95529. /** @hidden */
  95530. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  95531. /** @hidden */
  95532. _releaseFramebufferObjects(texture: InternalTexture): void;
  95533. /** @hidden */
  95534. _releaseTexture(texture: InternalTexture): void;
  95535. private setProgram;
  95536. private _boundUniforms;
  95537. /**
  95538. * Binds an effect to the webGL context
  95539. * @param effect defines the effect to bind
  95540. */
  95541. bindSamplers(effect: Effect): void;
  95542. private _activateCurrentTexture;
  95543. /** @hidden */
  95544. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  95545. /** @hidden */
  95546. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  95547. /**
  95548. * Sets a texture to the webGL context from a postprocess
  95549. * @param channel defines the channel to use
  95550. * @param postProcess defines the source postprocess
  95551. */
  95552. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  95553. /**
  95554. * Binds the output of the passed in post process to the texture channel specified
  95555. * @param channel The channel the texture should be bound to
  95556. * @param postProcess The post process which's output should be bound
  95557. */
  95558. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  95559. /**
  95560. * Unbind all textures from the webGL context
  95561. */
  95562. unbindAllTextures(): void;
  95563. /**
  95564. * Sets a texture to the according uniform.
  95565. * @param channel The texture channel
  95566. * @param uniform The uniform to set
  95567. * @param texture The texture to apply
  95568. */
  95569. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  95570. /**
  95571. * Sets a depth stencil texture from a render target to the according uniform.
  95572. * @param channel The texture channel
  95573. * @param uniform The uniform to set
  95574. * @param texture The render target texture containing the depth stencil texture to apply
  95575. */
  95576. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  95577. private _bindSamplerUniformToChannel;
  95578. private _getTextureWrapMode;
  95579. private _setTexture;
  95580. /**
  95581. * Sets an array of texture to the webGL context
  95582. * @param channel defines the channel where the texture array must be set
  95583. * @param uniform defines the associated uniform location
  95584. * @param textures defines the array of textures to bind
  95585. */
  95586. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  95587. /** @hidden */
  95588. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  95589. private _setTextureParameterFloat;
  95590. private _setTextureParameterInteger;
  95591. /**
  95592. * Reads pixels from the current frame buffer. Please note that this function can be slow
  95593. * @param x defines the x coordinate of the rectangle where pixels must be read
  95594. * @param y defines the y coordinate of the rectangle where pixels must be read
  95595. * @param width defines the width of the rectangle where pixels must be read
  95596. * @param height defines the height of the rectangle where pixels must be read
  95597. * @returns a Uint8Array containing RGBA colors
  95598. */
  95599. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  95600. /**
  95601. * Add an externaly attached data from its key.
  95602. * This method call will fail and return false, if such key already exists.
  95603. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  95604. * @param key the unique key that identifies the data
  95605. * @param data the data object to associate to the key for this Engine instance
  95606. * @return true if no such key were already present and the data was added successfully, false otherwise
  95607. */
  95608. addExternalData<T>(key: string, data: T): boolean;
  95609. /**
  95610. * Get an externaly attached data from its key
  95611. * @param key the unique key that identifies the data
  95612. * @return the associated data, if present (can be null), or undefined if not present
  95613. */
  95614. getExternalData<T>(key: string): T;
  95615. /**
  95616. * Get an externaly attached data from its key, create it using a factory if it's not already present
  95617. * @param key the unique key that identifies the data
  95618. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  95619. * @return the associated data, can be null if the factory returned null.
  95620. */
  95621. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  95622. /**
  95623. * Remove an externaly attached data from the Engine instance
  95624. * @param key the unique key that identifies the data
  95625. * @return true if the data was successfully removed, false if it doesn't exist
  95626. */
  95627. removeExternalData(key: string): boolean;
  95628. /**
  95629. * Unbind all vertex attributes from the webGL context
  95630. */
  95631. unbindAllAttributes(): void;
  95632. /**
  95633. * 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
  95634. */
  95635. releaseEffects(): void;
  95636. /**
  95637. * Dispose and release all associated resources
  95638. */
  95639. dispose(): void;
  95640. /**
  95641. * Display the loading screen
  95642. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  95643. */
  95644. displayLoadingUI(): void;
  95645. /**
  95646. * Hide the loading screen
  95647. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  95648. */
  95649. hideLoadingUI(): void;
  95650. /**
  95651. * Gets the current loading screen object
  95652. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  95653. */
  95654. /**
  95655. * Sets the current loading screen object
  95656. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  95657. */
  95658. loadingScreen: ILoadingScreen;
  95659. /**
  95660. * Sets the current loading screen text
  95661. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  95662. */
  95663. loadingUIText: string;
  95664. /**
  95665. * Sets the current loading screen background color
  95666. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  95667. */
  95668. loadingUIBackgroundColor: string;
  95669. /**
  95670. * Attach a new callback raised when context lost event is fired
  95671. * @param callback defines the callback to call
  95672. */
  95673. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  95674. /**
  95675. * Attach a new callback raised when context restored event is fired
  95676. * @param callback defines the callback to call
  95677. */
  95678. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  95679. /**
  95680. * Gets the source code of the vertex shader associated with a specific webGL program
  95681. * @param program defines the program to use
  95682. * @returns a string containing the source code of the vertex shader associated with the program
  95683. */
  95684. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  95685. /**
  95686. * Gets the source code of the fragment shader associated with a specific webGL program
  95687. * @param program defines the program to use
  95688. * @returns a string containing the source code of the fragment shader associated with the program
  95689. */
  95690. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  95691. /**
  95692. * Get the current error code of the webGL context
  95693. * @returns the error code
  95694. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  95695. */
  95696. getError(): number;
  95697. /**
  95698. * Gets the current framerate
  95699. * @returns a number representing the framerate
  95700. */
  95701. getFps(): number;
  95702. /**
  95703. * Gets the time spent between current and previous frame
  95704. * @returns a number representing the delta time in ms
  95705. */
  95706. getDeltaTime(): number;
  95707. private _measureFps;
  95708. /** @hidden */
  95709. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  95710. private _canRenderToFloatFramebuffer;
  95711. private _canRenderToHalfFloatFramebuffer;
  95712. private _canRenderToFramebuffer;
  95713. /** @hidden */
  95714. _getWebGLTextureType(type: number): number;
  95715. /** @hidden */
  95716. _getInternalFormat(format: number): number;
  95717. /** @hidden */
  95718. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  95719. /** @hidden */
  95720. _getRGBAMultiSampleBufferFormat(type: number): number;
  95721. /** @hidden */
  95722. _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;
  95723. /** @hidden */
  95724. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  95725. /**
  95726. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  95727. * @returns true if the engine can be created
  95728. * @ignorenaming
  95729. */
  95730. static isSupported(): boolean;
  95731. /**
  95732. * Find the next highest power of two.
  95733. * @param x Number to start search from.
  95734. * @return Next highest power of two.
  95735. */
  95736. static CeilingPOT(x: number): number;
  95737. /**
  95738. * Find the next lowest power of two.
  95739. * @param x Number to start search from.
  95740. * @return Next lowest power of two.
  95741. */
  95742. static FloorPOT(x: number): number;
  95743. /**
  95744. * Find the nearest power of two.
  95745. * @param x Number to start search from.
  95746. * @return Next nearest power of two.
  95747. */
  95748. static NearestPOT(x: number): number;
  95749. /**
  95750. * Get the closest exponent of two
  95751. * @param value defines the value to approximate
  95752. * @param max defines the maximum value to return
  95753. * @param mode defines how to define the closest value
  95754. * @returns closest exponent of two of the given value
  95755. */
  95756. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  95757. /**
  95758. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  95759. * @param func - the function to be called
  95760. * @param requester - the object that will request the next frame. Falls back to window.
  95761. * @returns frame number
  95762. */
  95763. static QueueNewFrame(func: () => void, requester?: any): number;
  95764. /**
  95765. * Ask the browser to promote the current element to pointerlock mode
  95766. * @param element defines the DOM element to promote
  95767. */
  95768. static _RequestPointerlock(element: HTMLElement): void;
  95769. /**
  95770. * Asks the browser to exit pointerlock mode
  95771. */
  95772. static _ExitPointerlock(): void;
  95773. /**
  95774. * Ask the browser to promote the current element to fullscreen rendering mode
  95775. * @param element defines the DOM element to promote
  95776. */
  95777. static _RequestFullscreen(element: HTMLElement): void;
  95778. /**
  95779. * Asks the browser to exit fullscreen mode
  95780. */
  95781. static _ExitFullscreen(): void;
  95782. }
  95783. }
  95784. declare module BABYLON {
  95785. /**
  95786. * The engine store class is responsible to hold all the instances of Engine and Scene created
  95787. * during the life time of the application.
  95788. */
  95789. export class EngineStore {
  95790. /** Gets the list of created engines */
  95791. static Instances: Engine[];
  95792. /** @hidden */
  95793. static _LastCreatedScene: Nullable<Scene>;
  95794. /**
  95795. * Gets the latest created engine
  95796. */
  95797. static readonly LastCreatedEngine: Nullable<Engine>;
  95798. /**
  95799. * Gets the latest created scene
  95800. */
  95801. static readonly LastCreatedScene: Nullable<Scene>;
  95802. /**
  95803. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  95804. * @ignorenaming
  95805. */
  95806. static UseFallbackTexture: boolean;
  95807. /**
  95808. * Texture content used if a texture cannot loaded
  95809. * @ignorenaming
  95810. */
  95811. static FallbackTexture: string;
  95812. }
  95813. }
  95814. declare module BABYLON {
  95815. /**
  95816. * Helper class that provides a small promise polyfill
  95817. */
  95818. export class PromisePolyfill {
  95819. /**
  95820. * Static function used to check if the polyfill is required
  95821. * If this is the case then the function will inject the polyfill to window.Promise
  95822. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  95823. */
  95824. static Apply(force?: boolean): void;
  95825. }
  95826. }
  95827. declare module BABYLON {
  95828. /**
  95829. * Interface for screenshot methods with describe argument called `size` as object with options
  95830. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  95831. */
  95832. export interface IScreenshotSize {
  95833. /**
  95834. * number in pixels for canvas height
  95835. */
  95836. height?: number;
  95837. /**
  95838. * multiplier allowing render at a higher or lower resolution
  95839. * If value is defined then height and width will be ignored and taken from camera
  95840. */
  95841. precision?: number;
  95842. /**
  95843. * number in pixels for canvas width
  95844. */
  95845. width?: number;
  95846. }
  95847. }
  95848. declare module BABYLON {
  95849. interface IColor4Like {
  95850. r: float;
  95851. g: float;
  95852. b: float;
  95853. a: float;
  95854. }
  95855. /**
  95856. * Class containing a set of static utilities functions
  95857. */
  95858. export class Tools {
  95859. /**
  95860. * Gets or sets the base URL to use to load assets
  95861. */
  95862. static BaseUrl: string;
  95863. /**
  95864. * Enable/Disable Custom HTTP Request Headers globally.
  95865. * default = false
  95866. * @see CustomRequestHeaders
  95867. */
  95868. static UseCustomRequestHeaders: boolean;
  95869. /**
  95870. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  95871. * i.e. when loading files, where the server/service expects an Authorization header
  95872. */
  95873. static CustomRequestHeaders: {
  95874. [key: string]: string;
  95875. };
  95876. /**
  95877. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  95878. */
  95879. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  95880. /**
  95881. * Default behaviour for cors in the application.
  95882. * It can be a string if the expected behavior is identical in the entire app.
  95883. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  95884. */
  95885. static CorsBehavior: string | ((url: string | string[]) => string);
  95886. /**
  95887. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  95888. * @ignorenaming
  95889. */
  95890. static UseFallbackTexture: boolean;
  95891. /**
  95892. * Use this object to register external classes like custom textures or material
  95893. * to allow the laoders to instantiate them
  95894. */
  95895. static RegisteredExternalClasses: {
  95896. [key: string]: Object;
  95897. };
  95898. /**
  95899. * Texture content used if a texture cannot loaded
  95900. * @ignorenaming
  95901. */
  95902. static fallbackTexture: string;
  95903. /**
  95904. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  95905. * @param u defines the coordinate on X axis
  95906. * @param v defines the coordinate on Y axis
  95907. * @param width defines the width of the source data
  95908. * @param height defines the height of the source data
  95909. * @param pixels defines the source byte array
  95910. * @param color defines the output color
  95911. */
  95912. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  95913. /**
  95914. * Interpolates between a and b via alpha
  95915. * @param a The lower value (returned when alpha = 0)
  95916. * @param b The upper value (returned when alpha = 1)
  95917. * @param alpha The interpolation-factor
  95918. * @return The mixed value
  95919. */
  95920. static Mix(a: number, b: number, alpha: number): number;
  95921. /**
  95922. * Tries to instantiate a new object from a given class name
  95923. * @param className defines the class name to instantiate
  95924. * @returns the new object or null if the system was not able to do the instantiation
  95925. */
  95926. static Instantiate(className: string): any;
  95927. /**
  95928. * Provides a slice function that will work even on IE
  95929. * @param data defines the array to slice
  95930. * @param start defines the start of the data (optional)
  95931. * @param end defines the end of the data (optional)
  95932. * @returns the new sliced array
  95933. */
  95934. static Slice<T>(data: T, start?: number, end?: number): T;
  95935. /**
  95936. * Polyfill for setImmediate
  95937. * @param action defines the action to execute after the current execution block
  95938. */
  95939. static SetImmediate(action: () => void): void;
  95940. /**
  95941. * Function indicating if a number is an exponent of 2
  95942. * @param value defines the value to test
  95943. * @returns true if the value is an exponent of 2
  95944. */
  95945. static IsExponentOfTwo(value: number): boolean;
  95946. private static _tmpFloatArray;
  95947. /**
  95948. * Returns the nearest 32-bit single precision float representation of a Number
  95949. * @param value A Number. If the parameter is of a different type, it will get converted
  95950. * to a number or to NaN if it cannot be converted
  95951. * @returns number
  95952. */
  95953. static FloatRound(value: number): number;
  95954. /**
  95955. * Extracts the filename from a path
  95956. * @param path defines the path to use
  95957. * @returns the filename
  95958. */
  95959. static GetFilename(path: string): string;
  95960. /**
  95961. * Extracts the "folder" part of a path (everything before the filename).
  95962. * @param uri The URI to extract the info from
  95963. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  95964. * @returns The "folder" part of the path
  95965. */
  95966. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  95967. /**
  95968. * Extracts text content from a DOM element hierarchy
  95969. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  95970. */
  95971. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  95972. /**
  95973. * Convert an angle in radians to degrees
  95974. * @param angle defines the angle to convert
  95975. * @returns the angle in degrees
  95976. */
  95977. static ToDegrees(angle: number): number;
  95978. /**
  95979. * Convert an angle in degrees to radians
  95980. * @param angle defines the angle to convert
  95981. * @returns the angle in radians
  95982. */
  95983. static ToRadians(angle: number): number;
  95984. /**
  95985. * Encode a buffer to a base64 string
  95986. * @param buffer defines the buffer to encode
  95987. * @returns the encoded string
  95988. */
  95989. static EncodeArrayBufferTobase64(buffer: ArrayBuffer): string;
  95990. /**
  95991. * Returns an array if obj is not an array
  95992. * @param obj defines the object to evaluate as an array
  95993. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  95994. * @returns either obj directly if obj is an array or a new array containing obj
  95995. */
  95996. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  95997. /**
  95998. * Gets the pointer prefix to use
  95999. * @returns "pointer" if touch is enabled. Else returns "mouse"
  96000. */
  96001. static GetPointerPrefix(): string;
  96002. /**
  96003. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  96004. * @param url define the url we are trying
  96005. * @param element define the dom element where to configure the cors policy
  96006. */
  96007. static SetCorsBehavior(url: string | string[], element: {
  96008. crossOrigin: string | null;
  96009. }): void;
  96010. /**
  96011. * Removes unwanted characters from an url
  96012. * @param url defines the url to clean
  96013. * @returns the cleaned url
  96014. */
  96015. static CleanUrl(url: string): string;
  96016. /**
  96017. * Gets or sets a function used to pre-process url before using them to load assets
  96018. */
  96019. static PreprocessUrl: (url: string) => string;
  96020. /**
  96021. * Loads an image as an HTMLImageElement.
  96022. * @param input url string, ArrayBuffer, or Blob to load
  96023. * @param onLoad callback called when the image successfully loads
  96024. * @param onError callback called when the image fails to load
  96025. * @param offlineProvider offline provider for caching
  96026. * @returns the HTMLImageElement of the loaded image
  96027. */
  96028. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>): HTMLImageElement;
  96029. /**
  96030. * Loads a file
  96031. * @param url url string, ArrayBuffer, or Blob to load
  96032. * @param onSuccess callback called when the file successfully loads
  96033. * @param onProgress callback called while file is loading (if the server supports this mode)
  96034. * @param offlineProvider defines the offline provider for caching
  96035. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  96036. * @param onError callback called when the file fails to load
  96037. * @returns a file request object
  96038. */
  96039. 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;
  96040. /**
  96041. * Loads a file from a url
  96042. * @param url the file url to load
  96043. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  96044. */
  96045. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  96046. /**
  96047. * Load a script (identified by an url). When the url returns, the
  96048. * content of this file is added into a new script element, attached to the DOM (body element)
  96049. * @param scriptUrl defines the url of the script to laod
  96050. * @param onSuccess defines the callback called when the script is loaded
  96051. * @param onError defines the callback to call if an error occurs
  96052. * @param scriptId defines the id of the script element
  96053. */
  96054. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  96055. /**
  96056. * Load an asynchronous script (identified by an url). When the url returns, the
  96057. * content of this file is added into a new script element, attached to the DOM (body element)
  96058. * @param scriptUrl defines the url of the script to laod
  96059. * @param scriptId defines the id of the script element
  96060. * @returns a promise request object
  96061. */
  96062. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  96063. /**
  96064. * Loads a file from a blob
  96065. * @param fileToLoad defines the blob to use
  96066. * @param callback defines the callback to call when data is loaded
  96067. * @param progressCallback defines the callback to call during loading process
  96068. * @returns a file request object
  96069. */
  96070. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  96071. /**
  96072. * Loads a file
  96073. * @param fileToLoad defines the file to load
  96074. * @param callback defines the callback to call when data is loaded
  96075. * @param progressCallBack defines the callback to call during loading process
  96076. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  96077. * @returns a file request object
  96078. */
  96079. static ReadFile(fileToLoad: File, callback: (data: any) => void, progressCallBack?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): IFileRequest;
  96080. /**
  96081. * Creates a data url from a given string content
  96082. * @param content defines the content to convert
  96083. * @returns the new data url link
  96084. */
  96085. static FileAsURL(content: string): string;
  96086. /**
  96087. * Format the given number to a specific decimal format
  96088. * @param value defines the number to format
  96089. * @param decimals defines the number of decimals to use
  96090. * @returns the formatted string
  96091. */
  96092. static Format(value: number, decimals?: number): string;
  96093. /**
  96094. * Tries to copy an object by duplicating every property
  96095. * @param source defines the source object
  96096. * @param destination defines the target object
  96097. * @param doNotCopyList defines a list of properties to avoid
  96098. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  96099. */
  96100. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  96101. /**
  96102. * Gets a boolean indicating if the given object has no own property
  96103. * @param obj defines the object to test
  96104. * @returns true if object has no own property
  96105. */
  96106. static IsEmpty(obj: any): boolean;
  96107. /**
  96108. * Function used to register events at window level
  96109. * @param windowElement defines the Window object to use
  96110. * @param events defines the events to register
  96111. */
  96112. static RegisterTopRootEvents(windowElement: Window, events: {
  96113. name: string;
  96114. handler: Nullable<(e: FocusEvent) => any>;
  96115. }[]): void;
  96116. /**
  96117. * Function used to unregister events from window level
  96118. * @param windowElement defines the Window object to use
  96119. * @param events defines the events to unregister
  96120. */
  96121. static UnregisterTopRootEvents(windowElement: Window, events: {
  96122. name: string;
  96123. handler: Nullable<(e: FocusEvent) => any>;
  96124. }[]): void;
  96125. /**
  96126. * @ignore
  96127. */
  96128. static _ScreenshotCanvas: HTMLCanvasElement;
  96129. /**
  96130. * Dumps the current bound framebuffer
  96131. * @param width defines the rendering width
  96132. * @param height defines the rendering height
  96133. * @param engine defines the hosting engine
  96134. * @param successCallback defines the callback triggered once the data are available
  96135. * @param mimeType defines the mime type of the result
  96136. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  96137. */
  96138. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  96139. /**
  96140. * Converts the canvas data to blob.
  96141. * This acts as a polyfill for browsers not supporting the to blob function.
  96142. * @param canvas Defines the canvas to extract the data from
  96143. * @param successCallback Defines the callback triggered once the data are available
  96144. * @param mimeType Defines the mime type of the result
  96145. */
  96146. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  96147. /**
  96148. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  96149. * @param successCallback defines the callback triggered once the data are available
  96150. * @param mimeType defines the mime type of the result
  96151. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  96152. */
  96153. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  96154. /**
  96155. * Downloads a blob in the browser
  96156. * @param blob defines the blob to download
  96157. * @param fileName defines the name of the downloaded file
  96158. */
  96159. static Download(blob: Blob, fileName: string): void;
  96160. /**
  96161. * Captures a screenshot of the current rendering
  96162. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  96163. * @param engine defines the rendering engine
  96164. * @param camera defines the source camera
  96165. * @param size This parameter can be set to a single number or to an object with the
  96166. * following (optional) properties: precision, width, height. If a single number is passed,
  96167. * it will be used for both width and height. If an object is passed, the screenshot size
  96168. * will be derived from the parameters. The precision property is a multiplier allowing
  96169. * rendering at a higher or lower resolution
  96170. * @param successCallback defines the callback receives a single parameter which contains the
  96171. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  96172. * src parameter of an <img> to display it
  96173. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  96174. * Check your browser for supported MIME types
  96175. */
  96176. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  96177. /**
  96178. * Captures a screenshot of the current rendering
  96179. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  96180. * @param engine defines the rendering engine
  96181. * @param camera defines the source camera
  96182. * @param size This parameter can be set to a single number or to an object with the
  96183. * following (optional) properties: precision, width, height. If a single number is passed,
  96184. * it will be used for both width and height. If an object is passed, the screenshot size
  96185. * will be derived from the parameters. The precision property is a multiplier allowing
  96186. * rendering at a higher or lower resolution
  96187. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  96188. * Check your browser for supported MIME types
  96189. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  96190. * to the src parameter of an <img> to display it
  96191. */
  96192. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  96193. /**
  96194. * Generates an image screenshot from the specified camera.
  96195. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  96196. * @param engine The engine to use for rendering
  96197. * @param camera The camera to use for rendering
  96198. * @param size This parameter can be set to a single number or to an object with the
  96199. * following (optional) properties: precision, width, height. If a single number is passed,
  96200. * it will be used for both width and height. If an object is passed, the screenshot size
  96201. * will be derived from the parameters. The precision property is a multiplier allowing
  96202. * rendering at a higher or lower resolution
  96203. * @param successCallback The callback receives a single parameter which contains the
  96204. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  96205. * src parameter of an <img> to display it
  96206. * @param mimeType The MIME type of the screenshot image (default: image/png).
  96207. * Check your browser for supported MIME types
  96208. * @param samples Texture samples (default: 1)
  96209. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  96210. * @param fileName A name for for the downloaded file.
  96211. */
  96212. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  96213. /**
  96214. * Generates an image screenshot from the specified camera.
  96215. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  96216. * @param engine The engine to use for rendering
  96217. * @param camera The camera to use for rendering
  96218. * @param size This parameter can be set to a single number or to an object with the
  96219. * following (optional) properties: precision, width, height. If a single number is passed,
  96220. * it will be used for both width and height. If an object is passed, the screenshot size
  96221. * will be derived from the parameters. The precision property is a multiplier allowing
  96222. * rendering at a higher or lower resolution
  96223. * @param mimeType The MIME type of the screenshot image (default: image/png).
  96224. * Check your browser for supported MIME types
  96225. * @param samples Texture samples (default: 1)
  96226. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  96227. * @param fileName A name for for the downloaded file.
  96228. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  96229. * to the src parameter of an <img> to display it
  96230. */
  96231. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  96232. /**
  96233. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  96234. * Be aware Math.random() could cause collisions, but:
  96235. * "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"
  96236. * @returns a pseudo random id
  96237. */
  96238. static RandomId(): string;
  96239. /**
  96240. * Test if the given uri is a base64 string
  96241. * @param uri The uri to test
  96242. * @return True if the uri is a base64 string or false otherwise
  96243. */
  96244. static IsBase64(uri: string): boolean;
  96245. /**
  96246. * Decode the given base64 uri.
  96247. * @param uri The uri to decode
  96248. * @return The decoded base64 data.
  96249. */
  96250. static DecodeBase64(uri: string): ArrayBuffer;
  96251. /**
  96252. * Gets the absolute url.
  96253. * @param url the input url
  96254. * @return the absolute url
  96255. */
  96256. static GetAbsoluteUrl(url: string): string;
  96257. /**
  96258. * No log
  96259. */
  96260. static readonly NoneLogLevel: number;
  96261. /**
  96262. * Only message logs
  96263. */
  96264. static readonly MessageLogLevel: number;
  96265. /**
  96266. * Only warning logs
  96267. */
  96268. static readonly WarningLogLevel: number;
  96269. /**
  96270. * Only error logs
  96271. */
  96272. static readonly ErrorLogLevel: number;
  96273. /**
  96274. * All logs
  96275. */
  96276. static readonly AllLogLevel: number;
  96277. /**
  96278. * Gets a value indicating the number of loading errors
  96279. * @ignorenaming
  96280. */
  96281. static readonly errorsCount: number;
  96282. /**
  96283. * Callback called when a new log is added
  96284. */
  96285. static OnNewCacheEntry: (entry: string) => void;
  96286. /**
  96287. * Log a message to the console
  96288. * @param message defines the message to log
  96289. */
  96290. static Log(message: string): void;
  96291. /**
  96292. * Write a warning message to the console
  96293. * @param message defines the message to log
  96294. */
  96295. static Warn(message: string): void;
  96296. /**
  96297. * Write an error message to the console
  96298. * @param message defines the message to log
  96299. */
  96300. static Error(message: string): void;
  96301. /**
  96302. * Gets current log cache (list of logs)
  96303. */
  96304. static readonly LogCache: string;
  96305. /**
  96306. * Clears the log cache
  96307. */
  96308. static ClearLogCache(): void;
  96309. /**
  96310. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  96311. */
  96312. static LogLevels: number;
  96313. /**
  96314. * Checks if the window object exists
  96315. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  96316. */
  96317. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  96318. /**
  96319. * No performance log
  96320. */
  96321. static readonly PerformanceNoneLogLevel: number;
  96322. /**
  96323. * Use user marks to log performance
  96324. */
  96325. static readonly PerformanceUserMarkLogLevel: number;
  96326. /**
  96327. * Log performance to the console
  96328. */
  96329. static readonly PerformanceConsoleLogLevel: number;
  96330. private static _performance;
  96331. /**
  96332. * Sets the current performance log level
  96333. */
  96334. static PerformanceLogLevel: number;
  96335. private static _StartPerformanceCounterDisabled;
  96336. private static _EndPerformanceCounterDisabled;
  96337. private static _StartUserMark;
  96338. private static _EndUserMark;
  96339. private static _StartPerformanceConsole;
  96340. private static _EndPerformanceConsole;
  96341. /**
  96342. * Starts a performance counter
  96343. */
  96344. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  96345. /**
  96346. * Ends a specific performance coutner
  96347. */
  96348. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  96349. /**
  96350. * Gets either window.performance.now() if supported or Date.now() else
  96351. */
  96352. static readonly Now: number;
  96353. /**
  96354. * This method will return the name of the class used to create the instance of the given object.
  96355. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  96356. * @param object the object to get the class name from
  96357. * @param isType defines if the object is actually a type
  96358. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  96359. */
  96360. static GetClassName(object: any, isType?: boolean): string;
  96361. /**
  96362. * Gets the first element of an array satisfying a given predicate
  96363. * @param array defines the array to browse
  96364. * @param predicate defines the predicate to use
  96365. * @returns null if not found or the element
  96366. */
  96367. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  96368. /**
  96369. * This method will return the name of the full name of the class, including its owning module (if any).
  96370. * 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).
  96371. * @param object the object to get the class name from
  96372. * @param isType defines if the object is actually a type
  96373. * @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.
  96374. * @ignorenaming
  96375. */
  96376. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  96377. /**
  96378. * Returns a promise that resolves after the given amount of time.
  96379. * @param delay Number of milliseconds to delay
  96380. * @returns Promise that resolves after the given amount of time
  96381. */
  96382. static DelayAsync(delay: number): Promise<void>;
  96383. }
  96384. /**
  96385. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  96386. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  96387. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  96388. * @param name The name of the class, case should be preserved
  96389. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  96390. */
  96391. export function className(name: string, module?: string): (target: Object) => void;
  96392. /**
  96393. * An implementation of a loop for asynchronous functions.
  96394. */
  96395. export class AsyncLoop {
  96396. /**
  96397. * Defines the number of iterations for the loop
  96398. */
  96399. iterations: number;
  96400. /**
  96401. * Defines the current index of the loop.
  96402. */
  96403. index: number;
  96404. private _done;
  96405. private _fn;
  96406. private _successCallback;
  96407. /**
  96408. * Constructor.
  96409. * @param iterations the number of iterations.
  96410. * @param func the function to run each iteration
  96411. * @param successCallback the callback that will be called upon succesful execution
  96412. * @param offset starting offset.
  96413. */
  96414. constructor(
  96415. /**
  96416. * Defines the number of iterations for the loop
  96417. */
  96418. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  96419. /**
  96420. * Execute the next iteration. Must be called after the last iteration was finished.
  96421. */
  96422. executeNext(): void;
  96423. /**
  96424. * Break the loop and run the success callback.
  96425. */
  96426. breakLoop(): void;
  96427. /**
  96428. * Create and run an async loop.
  96429. * @param iterations the number of iterations.
  96430. * @param fn the function to run each iteration
  96431. * @param successCallback the callback that will be called upon succesful execution
  96432. * @param offset starting offset.
  96433. * @returns the created async loop object
  96434. */
  96435. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  96436. /**
  96437. * A for-loop that will run a given number of iterations synchronous and the rest async.
  96438. * @param iterations total number of iterations
  96439. * @param syncedIterations number of synchronous iterations in each async iteration.
  96440. * @param fn the function to call each iteration.
  96441. * @param callback a success call back that will be called when iterating stops.
  96442. * @param breakFunction a break condition (optional)
  96443. * @param timeout timeout settings for the setTimeout function. default - 0.
  96444. * @returns the created async loop object
  96445. */
  96446. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  96447. }
  96448. }
  96449. declare module BABYLON {
  96450. /** @hidden */
  96451. export interface ICollisionCoordinator {
  96452. createCollider(): Collider;
  96453. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  96454. init(scene: Scene): void;
  96455. }
  96456. /** @hidden */
  96457. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  96458. private _scene;
  96459. private _scaledPosition;
  96460. private _scaledVelocity;
  96461. private _finalPosition;
  96462. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  96463. createCollider(): Collider;
  96464. init(scene: Scene): void;
  96465. private _collideWithWorld;
  96466. }
  96467. }
  96468. declare module BABYLON {
  96469. /**
  96470. * Class used to manage all inputs for the scene.
  96471. */
  96472. export class InputManager {
  96473. /** The distance in pixel that you have to move to prevent some events */
  96474. static DragMovementThreshold: number;
  96475. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  96476. static LongPressDelay: number;
  96477. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  96478. static DoubleClickDelay: number;
  96479. /** If you need to check double click without raising a single click at first click, enable this flag */
  96480. static ExclusiveDoubleClickMode: boolean;
  96481. private _wheelEventName;
  96482. private _onPointerMove;
  96483. private _onPointerDown;
  96484. private _onPointerUp;
  96485. private _initClickEvent;
  96486. private _initActionManager;
  96487. private _delayedSimpleClick;
  96488. private _delayedSimpleClickTimeout;
  96489. private _previousDelayedSimpleClickTimeout;
  96490. private _meshPickProceed;
  96491. private _previousButtonPressed;
  96492. private _currentPickResult;
  96493. private _previousPickResult;
  96494. private _totalPointersPressed;
  96495. private _doubleClickOccured;
  96496. private _pointerOverMesh;
  96497. private _pickedDownMesh;
  96498. private _pickedUpMesh;
  96499. private _pointerX;
  96500. private _pointerY;
  96501. private _unTranslatedPointerX;
  96502. private _unTranslatedPointerY;
  96503. private _startingPointerPosition;
  96504. private _previousStartingPointerPosition;
  96505. private _startingPointerTime;
  96506. private _previousStartingPointerTime;
  96507. private _pointerCaptures;
  96508. private _onKeyDown;
  96509. private _onKeyUp;
  96510. private _onCanvasFocusObserver;
  96511. private _onCanvasBlurObserver;
  96512. private _scene;
  96513. /**
  96514. * Creates a new InputManager
  96515. * @param scene defines the hosting scene
  96516. */
  96517. constructor(scene: Scene);
  96518. /**
  96519. * Gets the mesh that is currently under the pointer
  96520. */
  96521. readonly meshUnderPointer: Nullable<AbstractMesh>;
  96522. /**
  96523. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  96524. */
  96525. readonly unTranslatedPointer: Vector2;
  96526. /**
  96527. * Gets or sets the current on-screen X position of the pointer
  96528. */
  96529. pointerX: number;
  96530. /**
  96531. * Gets or sets the current on-screen Y position of the pointer
  96532. */
  96533. pointerY: number;
  96534. private _updatePointerPosition;
  96535. private _processPointerMove;
  96536. private _setRayOnPointerInfo;
  96537. private _checkPrePointerObservable;
  96538. /**
  96539. * Use this method to simulate a pointer move on a mesh
  96540. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  96541. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  96542. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  96543. */
  96544. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  96545. /**
  96546. * Use this method to simulate a pointer down on a mesh
  96547. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  96548. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  96549. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  96550. */
  96551. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  96552. private _processPointerDown;
  96553. /** @hidden */
  96554. _isPointerSwiping(): boolean;
  96555. /**
  96556. * Use this method to simulate a pointer up on a mesh
  96557. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  96558. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  96559. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  96560. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  96561. */
  96562. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  96563. private _processPointerUp;
  96564. /**
  96565. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  96566. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  96567. * @returns true if the pointer was captured
  96568. */
  96569. isPointerCaptured(pointerId?: number): boolean;
  96570. /**
  96571. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  96572. * @param attachUp defines if you want to attach events to pointerup
  96573. * @param attachDown defines if you want to attach events to pointerdown
  96574. * @param attachMove defines if you want to attach events to pointermove
  96575. */
  96576. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  96577. /**
  96578. * Detaches all event handlers
  96579. */
  96580. detachControl(): void;
  96581. /**
  96582. * Force the value of meshUnderPointer
  96583. * @param mesh defines the mesh to use
  96584. */
  96585. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  96586. /**
  96587. * Gets the mesh under the pointer
  96588. * @returns a Mesh or null if no mesh is under the pointer
  96589. */
  96590. getPointerOverMesh(): Nullable<AbstractMesh>;
  96591. }
  96592. }
  96593. declare module BABYLON {
  96594. /**
  96595. * Helper class used to generate session unique ID
  96596. */
  96597. export class UniqueIdGenerator {
  96598. private static _UniqueIdCounter;
  96599. /**
  96600. * Gets an unique (relatively to the current scene) Id
  96601. */
  96602. static readonly UniqueId: number;
  96603. }
  96604. }
  96605. declare module BABYLON {
  96606. /**
  96607. * This class defines the direct association between an animation and a target
  96608. */
  96609. export class TargetedAnimation {
  96610. /**
  96611. * Animation to perform
  96612. */
  96613. animation: Animation;
  96614. /**
  96615. * Target to animate
  96616. */
  96617. target: any;
  96618. /**
  96619. * Serialize the object
  96620. * @returns the JSON object representing the current entity
  96621. */
  96622. serialize(): any;
  96623. }
  96624. /**
  96625. * Use this class to create coordinated animations on multiple targets
  96626. */
  96627. export class AnimationGroup implements IDisposable {
  96628. /** The name of the animation group */
  96629. name: string;
  96630. private _scene;
  96631. private _targetedAnimations;
  96632. private _animatables;
  96633. private _from;
  96634. private _to;
  96635. private _isStarted;
  96636. private _isPaused;
  96637. private _speedRatio;
  96638. private _loopAnimation;
  96639. /**
  96640. * Gets or sets the unique id of the node
  96641. */
  96642. uniqueId: number;
  96643. /**
  96644. * This observable will notify when one animation have ended
  96645. */
  96646. onAnimationEndObservable: Observable<TargetedAnimation>;
  96647. /**
  96648. * Observer raised when one animation loops
  96649. */
  96650. onAnimationLoopObservable: Observable<TargetedAnimation>;
  96651. /**
  96652. * This observable will notify when all animations have ended.
  96653. */
  96654. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  96655. /**
  96656. * This observable will notify when all animations have paused.
  96657. */
  96658. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  96659. /**
  96660. * This observable will notify when all animations are playing.
  96661. */
  96662. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  96663. /**
  96664. * Gets the first frame
  96665. */
  96666. readonly from: number;
  96667. /**
  96668. * Gets the last frame
  96669. */
  96670. readonly to: number;
  96671. /**
  96672. * Define if the animations are started
  96673. */
  96674. readonly isStarted: boolean;
  96675. /**
  96676. * Gets a value indicating that the current group is playing
  96677. */
  96678. readonly isPlaying: boolean;
  96679. /**
  96680. * Gets or sets the speed ratio to use for all animations
  96681. */
  96682. /**
  96683. * Gets or sets the speed ratio to use for all animations
  96684. */
  96685. speedRatio: number;
  96686. /**
  96687. * Gets or sets if all animations should loop or not
  96688. */
  96689. loopAnimation: boolean;
  96690. /**
  96691. * Gets the targeted animations for this animation group
  96692. */
  96693. readonly targetedAnimations: Array<TargetedAnimation>;
  96694. /**
  96695. * returning the list of animatables controlled by this animation group.
  96696. */
  96697. readonly animatables: Array<Animatable>;
  96698. /**
  96699. * Instantiates a new Animation Group.
  96700. * This helps managing several animations at once.
  96701. * @see http://doc.babylonjs.com/how_to/group
  96702. * @param name Defines the name of the group
  96703. * @param scene Defines the scene the group belongs to
  96704. */
  96705. constructor(
  96706. /** The name of the animation group */
  96707. name: string, scene?: Nullable<Scene>);
  96708. /**
  96709. * Add an animation (with its target) in the group
  96710. * @param animation defines the animation we want to add
  96711. * @param target defines the target of the animation
  96712. * @returns the TargetedAnimation object
  96713. */
  96714. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  96715. /**
  96716. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  96717. * It can add constant keys at begin or end
  96718. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  96719. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  96720. * @returns the animation group
  96721. */
  96722. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  96723. /**
  96724. * Start all animations on given targets
  96725. * @param loop defines if animations must loop
  96726. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  96727. * @param from defines the from key (optional)
  96728. * @param to defines the to key (optional)
  96729. * @returns the current animation group
  96730. */
  96731. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  96732. /**
  96733. * Pause all animations
  96734. * @returns the animation group
  96735. */
  96736. pause(): AnimationGroup;
  96737. /**
  96738. * Play all animations to initial state
  96739. * This function will start() the animations if they were not started or will restart() them if they were paused
  96740. * @param loop defines if animations must loop
  96741. * @returns the animation group
  96742. */
  96743. play(loop?: boolean): AnimationGroup;
  96744. /**
  96745. * Reset all animations to initial state
  96746. * @returns the animation group
  96747. */
  96748. reset(): AnimationGroup;
  96749. /**
  96750. * Restart animations from key 0
  96751. * @returns the animation group
  96752. */
  96753. restart(): AnimationGroup;
  96754. /**
  96755. * Stop all animations
  96756. * @returns the animation group
  96757. */
  96758. stop(): AnimationGroup;
  96759. /**
  96760. * Set animation weight for all animatables
  96761. * @param weight defines the weight to use
  96762. * @return the animationGroup
  96763. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  96764. */
  96765. setWeightForAllAnimatables(weight: number): AnimationGroup;
  96766. /**
  96767. * Synchronize and normalize all animatables with a source animatable
  96768. * @param root defines the root animatable to synchronize with
  96769. * @return the animationGroup
  96770. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  96771. */
  96772. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  96773. /**
  96774. * Goes to a specific frame in this animation group
  96775. * @param frame the frame number to go to
  96776. * @return the animationGroup
  96777. */
  96778. goToFrame(frame: number): AnimationGroup;
  96779. /**
  96780. * Dispose all associated resources
  96781. */
  96782. dispose(): void;
  96783. private _checkAnimationGroupEnded;
  96784. /**
  96785. * Clone the current animation group and returns a copy
  96786. * @param newName defines the name of the new group
  96787. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  96788. * @returns the new aniamtion group
  96789. */
  96790. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  96791. /**
  96792. * Serializes the animationGroup to an object
  96793. * @returns Serialized object
  96794. */
  96795. serialize(): any;
  96796. /**
  96797. * Returns a new AnimationGroup object parsed from the source provided.
  96798. * @param parsedAnimationGroup defines the source
  96799. * @param scene defines the scene that will receive the animationGroup
  96800. * @returns a new AnimationGroup
  96801. */
  96802. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  96803. /**
  96804. * Returns the string "AnimationGroup"
  96805. * @returns "AnimationGroup"
  96806. */
  96807. getClassName(): string;
  96808. /**
  96809. * Creates a detailled string about the object
  96810. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  96811. * @returns a string representing the object
  96812. */
  96813. toString(fullDetails?: boolean): string;
  96814. }
  96815. }
  96816. declare module BABYLON {
  96817. /**
  96818. * Define an interface for all classes that will hold resources
  96819. */
  96820. export interface IDisposable {
  96821. /**
  96822. * Releases all held resources
  96823. */
  96824. dispose(): void;
  96825. }
  96826. /** Interface defining initialization parameters for Scene class */
  96827. export interface SceneOptions {
  96828. /**
  96829. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  96830. * It will improve performance when the number of geometries becomes important.
  96831. */
  96832. useGeometryUniqueIdsMap?: boolean;
  96833. /**
  96834. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  96835. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  96836. */
  96837. useMaterialMeshMap?: boolean;
  96838. /**
  96839. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  96840. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  96841. */
  96842. useClonedMeshhMap?: boolean;
  96843. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  96844. virtual?: boolean;
  96845. }
  96846. /**
  96847. * Represents a scene to be rendered by the engine.
  96848. * @see http://doc.babylonjs.com/features/scene
  96849. */
  96850. export class Scene extends AbstractScene implements IAnimatable {
  96851. /** The fog is deactivated */
  96852. static readonly FOGMODE_NONE: number;
  96853. /** The fog density is following an exponential function */
  96854. static readonly FOGMODE_EXP: number;
  96855. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  96856. static readonly FOGMODE_EXP2: number;
  96857. /** The fog density is following a linear function. */
  96858. static readonly FOGMODE_LINEAR: number;
  96859. /**
  96860. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  96861. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  96862. */
  96863. static MinDeltaTime: number;
  96864. /**
  96865. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  96866. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  96867. */
  96868. static MaxDeltaTime: number;
  96869. /**
  96870. * Factory used to create the default material.
  96871. * @param name The name of the material to create
  96872. * @param scene The scene to create the material for
  96873. * @returns The default material
  96874. */
  96875. static DefaultMaterialFactory(scene: Scene): Material;
  96876. /**
  96877. * Factory used to create the a collision coordinator.
  96878. * @returns The collision coordinator
  96879. */
  96880. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  96881. /** @hidden */
  96882. _inputManager: InputManager;
  96883. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  96884. cameraToUseForPointers: Nullable<Camera>;
  96885. /** @hidden */
  96886. readonly _isScene: boolean;
  96887. /**
  96888. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  96889. */
  96890. autoClear: boolean;
  96891. /**
  96892. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  96893. */
  96894. autoClearDepthAndStencil: boolean;
  96895. /**
  96896. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  96897. */
  96898. clearColor: Color4;
  96899. /**
  96900. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  96901. */
  96902. ambientColor: Color3;
  96903. /**
  96904. * This is use to store the default BRDF lookup for PBR materials in your scene.
  96905. * It should only be one of the following (if not the default embedded one):
  96906. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  96907. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  96908. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  96909. * The material properties need to be setup according to the type of texture in use.
  96910. */
  96911. environmentBRDFTexture: BaseTexture;
  96912. /** @hidden */
  96913. protected _environmentTexture: Nullable<BaseTexture>;
  96914. /**
  96915. * Texture used in all pbr material as the reflection texture.
  96916. * As in the majority of the scene they are the same (exception for multi room and so on),
  96917. * this is easier to reference from here than from all the materials.
  96918. */
  96919. /**
  96920. * Texture used in all pbr material as the reflection texture.
  96921. * As in the majority of the scene they are the same (exception for multi room and so on),
  96922. * this is easier to set here than in all the materials.
  96923. */
  96924. environmentTexture: Nullable<BaseTexture>;
  96925. /** @hidden */
  96926. protected _environmentIntensity: number;
  96927. /**
  96928. * Intensity of the environment in all pbr material.
  96929. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  96930. * As in the majority of the scene they are the same (exception for multi room and so on),
  96931. * this is easier to reference from here than from all the materials.
  96932. */
  96933. /**
  96934. * Intensity of the environment in all pbr material.
  96935. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  96936. * As in the majority of the scene they are the same (exception for multi room and so on),
  96937. * this is easier to set here than in all the materials.
  96938. */
  96939. environmentIntensity: number;
  96940. /** @hidden */
  96941. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  96942. /**
  96943. * Default image processing configuration used either in the rendering
  96944. * Forward main pass or through the imageProcessingPostProcess if present.
  96945. * As in the majority of the scene they are the same (exception for multi camera),
  96946. * this is easier to reference from here than from all the materials and post process.
  96947. *
  96948. * No setter as we it is a shared configuration, you can set the values instead.
  96949. */
  96950. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  96951. private _forceWireframe;
  96952. /**
  96953. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  96954. */
  96955. forceWireframe: boolean;
  96956. private _forcePointsCloud;
  96957. /**
  96958. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  96959. */
  96960. forcePointsCloud: boolean;
  96961. /**
  96962. * Gets or sets the active clipplane 1
  96963. */
  96964. clipPlane: Nullable<Plane>;
  96965. /**
  96966. * Gets or sets the active clipplane 2
  96967. */
  96968. clipPlane2: Nullable<Plane>;
  96969. /**
  96970. * Gets or sets the active clipplane 3
  96971. */
  96972. clipPlane3: Nullable<Plane>;
  96973. /**
  96974. * Gets or sets the active clipplane 4
  96975. */
  96976. clipPlane4: Nullable<Plane>;
  96977. /**
  96978. * Gets or sets a boolean indicating if animations are enabled
  96979. */
  96980. animationsEnabled: boolean;
  96981. private _animationPropertiesOverride;
  96982. /**
  96983. * Gets or sets the animation properties override
  96984. */
  96985. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  96986. /**
  96987. * Gets or sets a boolean indicating if a constant deltatime has to be used
  96988. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  96989. */
  96990. useConstantAnimationDeltaTime: boolean;
  96991. /**
  96992. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  96993. * Please note that it requires to run a ray cast through the scene on every frame
  96994. */
  96995. constantlyUpdateMeshUnderPointer: boolean;
  96996. /**
  96997. * Defines the HTML cursor to use when hovering over interactive elements
  96998. */
  96999. hoverCursor: string;
  97000. /**
  97001. * Defines the HTML default cursor to use (empty by default)
  97002. */
  97003. defaultCursor: string;
  97004. /**
  97005. * This is used to call preventDefault() on pointer down
  97006. * in order to block unwanted artifacts like system double clicks
  97007. */
  97008. preventDefaultOnPointerDown: boolean;
  97009. /**
  97010. * This is used to call preventDefault() on pointer up
  97011. * in order to block unwanted artifacts like system double clicks
  97012. */
  97013. preventDefaultOnPointerUp: boolean;
  97014. /**
  97015. * Gets or sets user defined metadata
  97016. */
  97017. metadata: any;
  97018. /**
  97019. * For internal use only. Please do not use.
  97020. */
  97021. reservedDataStore: any;
  97022. /**
  97023. * Gets the name of the plugin used to load this scene (null by default)
  97024. */
  97025. loadingPluginName: string;
  97026. /**
  97027. * Use this array to add regular expressions used to disable offline support for specific urls
  97028. */
  97029. disableOfflineSupportExceptionRules: RegExp[];
  97030. /**
  97031. * An event triggered when the scene is disposed.
  97032. */
  97033. onDisposeObservable: Observable<Scene>;
  97034. private _onDisposeObserver;
  97035. /** Sets a function to be executed when this scene is disposed. */
  97036. onDispose: () => void;
  97037. /**
  97038. * An event triggered before rendering the scene (right after animations and physics)
  97039. */
  97040. onBeforeRenderObservable: Observable<Scene>;
  97041. private _onBeforeRenderObserver;
  97042. /** Sets a function to be executed before rendering this scene */
  97043. beforeRender: Nullable<() => void>;
  97044. /**
  97045. * An event triggered after rendering the scene
  97046. */
  97047. onAfterRenderObservable: Observable<Scene>;
  97048. /**
  97049. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  97050. */
  97051. onAfterRenderCameraObservable: Observable<Camera>;
  97052. private _onAfterRenderObserver;
  97053. /** Sets a function to be executed after rendering this scene */
  97054. afterRender: Nullable<() => void>;
  97055. /**
  97056. * An event triggered before animating the scene
  97057. */
  97058. onBeforeAnimationsObservable: Observable<Scene>;
  97059. /**
  97060. * An event triggered after animations processing
  97061. */
  97062. onAfterAnimationsObservable: Observable<Scene>;
  97063. /**
  97064. * An event triggered before draw calls are ready to be sent
  97065. */
  97066. onBeforeDrawPhaseObservable: Observable<Scene>;
  97067. /**
  97068. * An event triggered after draw calls have been sent
  97069. */
  97070. onAfterDrawPhaseObservable: Observable<Scene>;
  97071. /**
  97072. * An event triggered when the scene is ready
  97073. */
  97074. onReadyObservable: Observable<Scene>;
  97075. /**
  97076. * An event triggered before rendering a camera
  97077. */
  97078. onBeforeCameraRenderObservable: Observable<Camera>;
  97079. private _onBeforeCameraRenderObserver;
  97080. /** Sets a function to be executed before rendering a camera*/
  97081. beforeCameraRender: () => void;
  97082. /**
  97083. * An event triggered after rendering a camera
  97084. */
  97085. onAfterCameraRenderObservable: Observable<Camera>;
  97086. private _onAfterCameraRenderObserver;
  97087. /** Sets a function to be executed after rendering a camera*/
  97088. afterCameraRender: () => void;
  97089. /**
  97090. * An event triggered when active meshes evaluation is about to start
  97091. */
  97092. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  97093. /**
  97094. * An event triggered when active meshes evaluation is done
  97095. */
  97096. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  97097. /**
  97098. * An event triggered when particles rendering is about to start
  97099. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  97100. */
  97101. onBeforeParticlesRenderingObservable: Observable<Scene>;
  97102. /**
  97103. * An event triggered when particles rendering is done
  97104. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  97105. */
  97106. onAfterParticlesRenderingObservable: Observable<Scene>;
  97107. /**
  97108. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  97109. */
  97110. onDataLoadedObservable: Observable<Scene>;
  97111. /**
  97112. * An event triggered when a camera is created
  97113. */
  97114. onNewCameraAddedObservable: Observable<Camera>;
  97115. /**
  97116. * An event triggered when a camera is removed
  97117. */
  97118. onCameraRemovedObservable: Observable<Camera>;
  97119. /**
  97120. * An event triggered when a light is created
  97121. */
  97122. onNewLightAddedObservable: Observable<Light>;
  97123. /**
  97124. * An event triggered when a light is removed
  97125. */
  97126. onLightRemovedObservable: Observable<Light>;
  97127. /**
  97128. * An event triggered when a geometry is created
  97129. */
  97130. onNewGeometryAddedObservable: Observable<Geometry>;
  97131. /**
  97132. * An event triggered when a geometry is removed
  97133. */
  97134. onGeometryRemovedObservable: Observable<Geometry>;
  97135. /**
  97136. * An event triggered when a transform node is created
  97137. */
  97138. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  97139. /**
  97140. * An event triggered when a transform node is removed
  97141. */
  97142. onTransformNodeRemovedObservable: Observable<TransformNode>;
  97143. /**
  97144. * An event triggered when a mesh is created
  97145. */
  97146. onNewMeshAddedObservable: Observable<AbstractMesh>;
  97147. /**
  97148. * An event triggered when a mesh is removed
  97149. */
  97150. onMeshRemovedObservable: Observable<AbstractMesh>;
  97151. /**
  97152. * An event triggered when a skeleton is created
  97153. */
  97154. onNewSkeletonAddedObservable: Observable<Skeleton>;
  97155. /**
  97156. * An event triggered when a skeleton is removed
  97157. */
  97158. onSkeletonRemovedObservable: Observable<Skeleton>;
  97159. /**
  97160. * An event triggered when a material is created
  97161. */
  97162. onNewMaterialAddedObservable: Observable<Material>;
  97163. /**
  97164. * An event triggered when a material is removed
  97165. */
  97166. onMaterialRemovedObservable: Observable<Material>;
  97167. /**
  97168. * An event triggered when a texture is created
  97169. */
  97170. onNewTextureAddedObservable: Observable<BaseTexture>;
  97171. /**
  97172. * An event triggered when a texture is removed
  97173. */
  97174. onTextureRemovedObservable: Observable<BaseTexture>;
  97175. /**
  97176. * An event triggered when render targets are about to be rendered
  97177. * Can happen multiple times per frame.
  97178. */
  97179. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  97180. /**
  97181. * An event triggered when render targets were rendered.
  97182. * Can happen multiple times per frame.
  97183. */
  97184. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  97185. /**
  97186. * An event triggered before calculating deterministic simulation step
  97187. */
  97188. onBeforeStepObservable: Observable<Scene>;
  97189. /**
  97190. * An event triggered after calculating deterministic simulation step
  97191. */
  97192. onAfterStepObservable: Observable<Scene>;
  97193. /**
  97194. * An event triggered when the activeCamera property is updated
  97195. */
  97196. onActiveCameraChanged: Observable<Scene>;
  97197. /**
  97198. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  97199. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  97200. * 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)
  97201. */
  97202. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  97203. /**
  97204. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  97205. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  97206. * 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)
  97207. */
  97208. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  97209. /**
  97210. * This Observable will when a mesh has been imported into the scene.
  97211. */
  97212. onMeshImportedObservable: Observable<AbstractMesh>;
  97213. /**
  97214. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  97215. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  97216. */
  97217. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  97218. /** @hidden */
  97219. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  97220. /**
  97221. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  97222. */
  97223. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  97224. /**
  97225. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  97226. */
  97227. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  97228. /**
  97229. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  97230. */
  97231. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  97232. /** Callback called when a pointer move is detected */
  97233. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  97234. /** Callback called when a pointer down is detected */
  97235. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  97236. /** Callback called when a pointer up is detected */
  97237. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  97238. /** Callback called when a pointer pick is detected */
  97239. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  97240. /**
  97241. * 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).
  97242. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  97243. */
  97244. onPrePointerObservable: Observable<PointerInfoPre>;
  97245. /**
  97246. * Observable event triggered each time an input event is received from the rendering canvas
  97247. */
  97248. onPointerObservable: Observable<PointerInfo>;
  97249. /**
  97250. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  97251. */
  97252. readonly unTranslatedPointer: Vector2;
  97253. /**
  97254. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  97255. */
  97256. static DragMovementThreshold: number;
  97257. /**
  97258. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  97259. */
  97260. static LongPressDelay: number;
  97261. /**
  97262. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  97263. */
  97264. static DoubleClickDelay: number;
  97265. /** If you need to check double click without raising a single click at first click, enable this flag */
  97266. static ExclusiveDoubleClickMode: boolean;
  97267. /** @hidden */
  97268. _mirroredCameraPosition: Nullable<Vector3>;
  97269. /**
  97270. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  97271. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  97272. */
  97273. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  97274. /**
  97275. * Observable event triggered each time an keyboard event is received from the hosting window
  97276. */
  97277. onKeyboardObservable: Observable<KeyboardInfo>;
  97278. private _useRightHandedSystem;
  97279. /**
  97280. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  97281. */
  97282. useRightHandedSystem: boolean;
  97283. private _timeAccumulator;
  97284. private _currentStepId;
  97285. private _currentInternalStep;
  97286. /**
  97287. * Sets the step Id used by deterministic lock step
  97288. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  97289. * @param newStepId defines the step Id
  97290. */
  97291. setStepId(newStepId: number): void;
  97292. /**
  97293. * Gets the step Id used by deterministic lock step
  97294. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  97295. * @returns the step Id
  97296. */
  97297. getStepId(): number;
  97298. /**
  97299. * Gets the internal step used by deterministic lock step
  97300. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  97301. * @returns the internal step
  97302. */
  97303. getInternalStep(): number;
  97304. private _fogEnabled;
  97305. /**
  97306. * Gets or sets a boolean indicating if fog is enabled on this scene
  97307. * @see http://doc.babylonjs.com/babylon101/environment#fog
  97308. * (Default is true)
  97309. */
  97310. fogEnabled: boolean;
  97311. private _fogMode;
  97312. /**
  97313. * Gets or sets the fog mode to use
  97314. * @see http://doc.babylonjs.com/babylon101/environment#fog
  97315. * | mode | value |
  97316. * | --- | --- |
  97317. * | FOGMODE_NONE | 0 |
  97318. * | FOGMODE_EXP | 1 |
  97319. * | FOGMODE_EXP2 | 2 |
  97320. * | FOGMODE_LINEAR | 3 |
  97321. */
  97322. fogMode: number;
  97323. /**
  97324. * Gets or sets the fog color to use
  97325. * @see http://doc.babylonjs.com/babylon101/environment#fog
  97326. * (Default is Color3(0.2, 0.2, 0.3))
  97327. */
  97328. fogColor: Color3;
  97329. /**
  97330. * Gets or sets the fog density to use
  97331. * @see http://doc.babylonjs.com/babylon101/environment#fog
  97332. * (Default is 0.1)
  97333. */
  97334. fogDensity: number;
  97335. /**
  97336. * Gets or sets the fog start distance to use
  97337. * @see http://doc.babylonjs.com/babylon101/environment#fog
  97338. * (Default is 0)
  97339. */
  97340. fogStart: number;
  97341. /**
  97342. * Gets or sets the fog end distance to use
  97343. * @see http://doc.babylonjs.com/babylon101/environment#fog
  97344. * (Default is 1000)
  97345. */
  97346. fogEnd: number;
  97347. private _shadowsEnabled;
  97348. /**
  97349. * Gets or sets a boolean indicating if shadows are enabled on this scene
  97350. */
  97351. shadowsEnabled: boolean;
  97352. private _lightsEnabled;
  97353. /**
  97354. * Gets or sets a boolean indicating if lights are enabled on this scene
  97355. */
  97356. lightsEnabled: boolean;
  97357. /** All of the active cameras added to this scene. */
  97358. activeCameras: Camera[];
  97359. /** @hidden */
  97360. _activeCamera: Nullable<Camera>;
  97361. /** Gets or sets the current active camera */
  97362. activeCamera: Nullable<Camera>;
  97363. private _defaultMaterial;
  97364. /** The default material used on meshes when no material is affected */
  97365. /** The default material used on meshes when no material is affected */
  97366. defaultMaterial: Material;
  97367. private _texturesEnabled;
  97368. /**
  97369. * Gets or sets a boolean indicating if textures are enabled on this scene
  97370. */
  97371. texturesEnabled: boolean;
  97372. /**
  97373. * Gets or sets a boolean indicating if particles are enabled on this scene
  97374. */
  97375. particlesEnabled: boolean;
  97376. /**
  97377. * Gets or sets a boolean indicating if sprites are enabled on this scene
  97378. */
  97379. spritesEnabled: boolean;
  97380. private _skeletonsEnabled;
  97381. /**
  97382. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  97383. */
  97384. skeletonsEnabled: boolean;
  97385. /**
  97386. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  97387. */
  97388. lensFlaresEnabled: boolean;
  97389. /**
  97390. * Gets or sets a boolean indicating if collisions are enabled on this scene
  97391. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  97392. */
  97393. collisionsEnabled: boolean;
  97394. private _collisionCoordinator;
  97395. /** @hidden */
  97396. readonly collisionCoordinator: ICollisionCoordinator;
  97397. /**
  97398. * Defines the gravity applied to this scene (used only for collisions)
  97399. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  97400. */
  97401. gravity: Vector3;
  97402. /**
  97403. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  97404. */
  97405. postProcessesEnabled: boolean;
  97406. /**
  97407. * The list of postprocesses added to the scene
  97408. */
  97409. postProcesses: PostProcess[];
  97410. /**
  97411. * Gets the current postprocess manager
  97412. */
  97413. postProcessManager: PostProcessManager;
  97414. /**
  97415. * Gets or sets a boolean indicating if render targets are enabled on this scene
  97416. */
  97417. renderTargetsEnabled: boolean;
  97418. /**
  97419. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  97420. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  97421. */
  97422. dumpNextRenderTargets: boolean;
  97423. /**
  97424. * The list of user defined render targets added to the scene
  97425. */
  97426. customRenderTargets: RenderTargetTexture[];
  97427. /**
  97428. * Defines if texture loading must be delayed
  97429. * If true, textures will only be loaded when they need to be rendered
  97430. */
  97431. useDelayedTextureLoading: boolean;
  97432. /**
  97433. * Gets the list of meshes imported to the scene through SceneLoader
  97434. */
  97435. importedMeshesFiles: String[];
  97436. /**
  97437. * Gets or sets a boolean indicating if probes are enabled on this scene
  97438. */
  97439. probesEnabled: boolean;
  97440. /**
  97441. * Gets or sets the current offline provider to use to store scene data
  97442. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  97443. */
  97444. offlineProvider: IOfflineProvider;
  97445. /**
  97446. * Gets or sets the action manager associated with the scene
  97447. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  97448. */
  97449. actionManager: AbstractActionManager;
  97450. private _meshesForIntersections;
  97451. /**
  97452. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  97453. */
  97454. proceduralTexturesEnabled: boolean;
  97455. private _engine;
  97456. private _totalVertices;
  97457. /** @hidden */
  97458. _activeIndices: PerfCounter;
  97459. /** @hidden */
  97460. _activeParticles: PerfCounter;
  97461. /** @hidden */
  97462. _activeBones: PerfCounter;
  97463. private _animationRatio;
  97464. /** @hidden */
  97465. _animationTimeLast: number;
  97466. /** @hidden */
  97467. _animationTime: number;
  97468. /**
  97469. * Gets or sets a general scale for animation speed
  97470. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  97471. */
  97472. animationTimeScale: number;
  97473. /** @hidden */
  97474. _cachedMaterial: Nullable<Material>;
  97475. /** @hidden */
  97476. _cachedEffect: Nullable<Effect>;
  97477. /** @hidden */
  97478. _cachedVisibility: Nullable<number>;
  97479. private _renderId;
  97480. private _frameId;
  97481. private _executeWhenReadyTimeoutId;
  97482. private _intermediateRendering;
  97483. private _viewUpdateFlag;
  97484. private _projectionUpdateFlag;
  97485. /** @hidden */
  97486. _toBeDisposed: Nullable<IDisposable>[];
  97487. private _activeRequests;
  97488. /** @hidden */
  97489. _pendingData: any[];
  97490. private _isDisposed;
  97491. /**
  97492. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  97493. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  97494. */
  97495. dispatchAllSubMeshesOfActiveMeshes: boolean;
  97496. private _activeMeshes;
  97497. private _processedMaterials;
  97498. private _renderTargets;
  97499. /** @hidden */
  97500. _activeParticleSystems: SmartArray<IParticleSystem>;
  97501. private _activeSkeletons;
  97502. private _softwareSkinnedMeshes;
  97503. private _renderingManager;
  97504. /** @hidden */
  97505. _activeAnimatables: Animatable[];
  97506. private _transformMatrix;
  97507. private _sceneUbo;
  97508. /** @hidden */
  97509. _viewMatrix: Matrix;
  97510. private _projectionMatrix;
  97511. /** @hidden */
  97512. _forcedViewPosition: Nullable<Vector3>;
  97513. /** @hidden */
  97514. _frustumPlanes: Plane[];
  97515. /**
  97516. * Gets the list of frustum planes (built from the active camera)
  97517. */
  97518. readonly frustumPlanes: Plane[];
  97519. /**
  97520. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  97521. * This is useful if there are more lights that the maximum simulteanous authorized
  97522. */
  97523. requireLightSorting: boolean;
  97524. /** @hidden */
  97525. readonly useMaterialMeshMap: boolean;
  97526. /** @hidden */
  97527. readonly useClonedMeshhMap: boolean;
  97528. private _externalData;
  97529. private _uid;
  97530. /**
  97531. * @hidden
  97532. * Backing store of defined scene components.
  97533. */
  97534. _components: ISceneComponent[];
  97535. /**
  97536. * @hidden
  97537. * Backing store of defined scene components.
  97538. */
  97539. _serializableComponents: ISceneSerializableComponent[];
  97540. /**
  97541. * List of components to register on the next registration step.
  97542. */
  97543. private _transientComponents;
  97544. /**
  97545. * Registers the transient components if needed.
  97546. */
  97547. private _registerTransientComponents;
  97548. /**
  97549. * @hidden
  97550. * Add a component to the scene.
  97551. * Note that the ccomponent could be registered on th next frame if this is called after
  97552. * the register component stage.
  97553. * @param component Defines the component to add to the scene
  97554. */
  97555. _addComponent(component: ISceneComponent): void;
  97556. /**
  97557. * @hidden
  97558. * Gets a component from the scene.
  97559. * @param name defines the name of the component to retrieve
  97560. * @returns the component or null if not present
  97561. */
  97562. _getComponent(name: string): Nullable<ISceneComponent>;
  97563. /**
  97564. * @hidden
  97565. * Defines the actions happening before camera updates.
  97566. */
  97567. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  97568. /**
  97569. * @hidden
  97570. * Defines the actions happening before clear the canvas.
  97571. */
  97572. _beforeClearStage: Stage<SimpleStageAction>;
  97573. /**
  97574. * @hidden
  97575. * Defines the actions when collecting render targets for the frame.
  97576. */
  97577. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  97578. /**
  97579. * @hidden
  97580. * Defines the actions happening for one camera in the frame.
  97581. */
  97582. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  97583. /**
  97584. * @hidden
  97585. * Defines the actions happening during the per mesh ready checks.
  97586. */
  97587. _isReadyForMeshStage: Stage<MeshStageAction>;
  97588. /**
  97589. * @hidden
  97590. * Defines the actions happening before evaluate active mesh checks.
  97591. */
  97592. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  97593. /**
  97594. * @hidden
  97595. * Defines the actions happening during the evaluate sub mesh checks.
  97596. */
  97597. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  97598. /**
  97599. * @hidden
  97600. * Defines the actions happening during the active mesh stage.
  97601. */
  97602. _activeMeshStage: Stage<ActiveMeshStageAction>;
  97603. /**
  97604. * @hidden
  97605. * Defines the actions happening during the per camera render target step.
  97606. */
  97607. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  97608. /**
  97609. * @hidden
  97610. * Defines the actions happening just before the active camera is drawing.
  97611. */
  97612. _beforeCameraDrawStage: Stage<CameraStageAction>;
  97613. /**
  97614. * @hidden
  97615. * Defines the actions happening just before a render target is drawing.
  97616. */
  97617. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  97618. /**
  97619. * @hidden
  97620. * Defines the actions happening just before a rendering group is drawing.
  97621. */
  97622. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  97623. /**
  97624. * @hidden
  97625. * Defines the actions happening just before a mesh is drawing.
  97626. */
  97627. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  97628. /**
  97629. * @hidden
  97630. * Defines the actions happening just after a mesh has been drawn.
  97631. */
  97632. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  97633. /**
  97634. * @hidden
  97635. * Defines the actions happening just after a rendering group has been drawn.
  97636. */
  97637. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  97638. /**
  97639. * @hidden
  97640. * Defines the actions happening just after the active camera has been drawn.
  97641. */
  97642. _afterCameraDrawStage: Stage<CameraStageAction>;
  97643. /**
  97644. * @hidden
  97645. * Defines the actions happening just after a render target has been drawn.
  97646. */
  97647. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  97648. /**
  97649. * @hidden
  97650. * Defines the actions happening just after rendering all cameras and computing intersections.
  97651. */
  97652. _afterRenderStage: Stage<SimpleStageAction>;
  97653. /**
  97654. * @hidden
  97655. * Defines the actions happening when a pointer move event happens.
  97656. */
  97657. _pointerMoveStage: Stage<PointerMoveStageAction>;
  97658. /**
  97659. * @hidden
  97660. * Defines the actions happening when a pointer down event happens.
  97661. */
  97662. _pointerDownStage: Stage<PointerUpDownStageAction>;
  97663. /**
  97664. * @hidden
  97665. * Defines the actions happening when a pointer up event happens.
  97666. */
  97667. _pointerUpStage: Stage<PointerUpDownStageAction>;
  97668. /**
  97669. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  97670. */
  97671. private geometriesByUniqueId;
  97672. /**
  97673. * Creates a new Scene
  97674. * @param engine defines the engine to use to render this scene
  97675. * @param options defines the scene options
  97676. */
  97677. constructor(engine: Engine, options?: SceneOptions);
  97678. /**
  97679. * Gets a string idenfifying the name of the class
  97680. * @returns "Scene" string
  97681. */
  97682. getClassName(): string;
  97683. private _defaultMeshCandidates;
  97684. /**
  97685. * @hidden
  97686. */
  97687. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  97688. private _defaultSubMeshCandidates;
  97689. /**
  97690. * @hidden
  97691. */
  97692. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  97693. /**
  97694. * Sets the default candidate providers for the scene.
  97695. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  97696. * and getCollidingSubMeshCandidates to their default function
  97697. */
  97698. setDefaultCandidateProviders(): void;
  97699. /**
  97700. * Gets the mesh that is currently under the pointer
  97701. */
  97702. readonly meshUnderPointer: Nullable<AbstractMesh>;
  97703. /**
  97704. * Gets or sets the current on-screen X position of the pointer
  97705. */
  97706. pointerX: number;
  97707. /**
  97708. * Gets or sets the current on-screen Y position of the pointer
  97709. */
  97710. pointerY: number;
  97711. /**
  97712. * Gets the cached material (ie. the latest rendered one)
  97713. * @returns the cached material
  97714. */
  97715. getCachedMaterial(): Nullable<Material>;
  97716. /**
  97717. * Gets the cached effect (ie. the latest rendered one)
  97718. * @returns the cached effect
  97719. */
  97720. getCachedEffect(): Nullable<Effect>;
  97721. /**
  97722. * Gets the cached visibility state (ie. the latest rendered one)
  97723. * @returns the cached visibility state
  97724. */
  97725. getCachedVisibility(): Nullable<number>;
  97726. /**
  97727. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  97728. * @param material defines the current material
  97729. * @param effect defines the current effect
  97730. * @param visibility defines the current visibility state
  97731. * @returns true if one parameter is not cached
  97732. */
  97733. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  97734. /**
  97735. * Gets the engine associated with the scene
  97736. * @returns an Engine
  97737. */
  97738. getEngine(): Engine;
  97739. /**
  97740. * Gets the total number of vertices rendered per frame
  97741. * @returns the total number of vertices rendered per frame
  97742. */
  97743. getTotalVertices(): number;
  97744. /**
  97745. * Gets the performance counter for total vertices
  97746. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  97747. */
  97748. readonly totalVerticesPerfCounter: PerfCounter;
  97749. /**
  97750. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  97751. * @returns the total number of active indices rendered per frame
  97752. */
  97753. getActiveIndices(): number;
  97754. /**
  97755. * Gets the performance counter for active indices
  97756. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  97757. */
  97758. readonly totalActiveIndicesPerfCounter: PerfCounter;
  97759. /**
  97760. * Gets the total number of active particles rendered per frame
  97761. * @returns the total number of active particles rendered per frame
  97762. */
  97763. getActiveParticles(): number;
  97764. /**
  97765. * Gets the performance counter for active particles
  97766. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  97767. */
  97768. readonly activeParticlesPerfCounter: PerfCounter;
  97769. /**
  97770. * Gets the total number of active bones rendered per frame
  97771. * @returns the total number of active bones rendered per frame
  97772. */
  97773. getActiveBones(): number;
  97774. /**
  97775. * Gets the performance counter for active bones
  97776. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  97777. */
  97778. readonly activeBonesPerfCounter: PerfCounter;
  97779. /**
  97780. * Gets the array of active meshes
  97781. * @returns an array of AbstractMesh
  97782. */
  97783. getActiveMeshes(): SmartArray<AbstractMesh>;
  97784. /**
  97785. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  97786. * @returns a number
  97787. */
  97788. getAnimationRatio(): number;
  97789. /**
  97790. * Gets an unique Id for the current render phase
  97791. * @returns a number
  97792. */
  97793. getRenderId(): number;
  97794. /**
  97795. * Gets an unique Id for the current frame
  97796. * @returns a number
  97797. */
  97798. getFrameId(): number;
  97799. /** Call this function if you want to manually increment the render Id*/
  97800. incrementRenderId(): void;
  97801. private _createUbo;
  97802. /**
  97803. * Use this method to simulate a pointer move on a mesh
  97804. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  97805. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  97806. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  97807. * @returns the current scene
  97808. */
  97809. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  97810. /**
  97811. * Use this method to simulate a pointer down on a mesh
  97812. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  97813. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  97814. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  97815. * @returns the current scene
  97816. */
  97817. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  97818. /**
  97819. * Use this method to simulate a pointer up on a mesh
  97820. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  97821. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  97822. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  97823. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  97824. * @returns the current scene
  97825. */
  97826. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  97827. /**
  97828. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  97829. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  97830. * @returns true if the pointer was captured
  97831. */
  97832. isPointerCaptured(pointerId?: number): boolean;
  97833. /**
  97834. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  97835. * @param attachUp defines if you want to attach events to pointerup
  97836. * @param attachDown defines if you want to attach events to pointerdown
  97837. * @param attachMove defines if you want to attach events to pointermove
  97838. */
  97839. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  97840. /** Detaches all event handlers*/
  97841. detachControl(): void;
  97842. /**
  97843. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  97844. * Delay loaded resources are not taking in account
  97845. * @return true if all required resources are ready
  97846. */
  97847. isReady(): boolean;
  97848. /** Resets all cached information relative to material (including effect and visibility) */
  97849. resetCachedMaterial(): void;
  97850. /**
  97851. * Registers a function to be called before every frame render
  97852. * @param func defines the function to register
  97853. */
  97854. registerBeforeRender(func: () => void): void;
  97855. /**
  97856. * Unregisters a function called before every frame render
  97857. * @param func defines the function to unregister
  97858. */
  97859. unregisterBeforeRender(func: () => void): void;
  97860. /**
  97861. * Registers a function to be called after every frame render
  97862. * @param func defines the function to register
  97863. */
  97864. registerAfterRender(func: () => void): void;
  97865. /**
  97866. * Unregisters a function called after every frame render
  97867. * @param func defines the function to unregister
  97868. */
  97869. unregisterAfterRender(func: () => void): void;
  97870. private _executeOnceBeforeRender;
  97871. /**
  97872. * The provided function will run before render once and will be disposed afterwards.
  97873. * A timeout delay can be provided so that the function will be executed in N ms.
  97874. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  97875. * @param func The function to be executed.
  97876. * @param timeout optional delay in ms
  97877. */
  97878. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  97879. /** @hidden */
  97880. _addPendingData(data: any): void;
  97881. /** @hidden */
  97882. _removePendingData(data: any): void;
  97883. /**
  97884. * Returns the number of items waiting to be loaded
  97885. * @returns the number of items waiting to be loaded
  97886. */
  97887. getWaitingItemsCount(): number;
  97888. /**
  97889. * Returns a boolean indicating if the scene is still loading data
  97890. */
  97891. readonly isLoading: boolean;
  97892. /**
  97893. * Registers a function to be executed when the scene is ready
  97894. * @param {Function} func - the function to be executed
  97895. */
  97896. executeWhenReady(func: () => void): void;
  97897. /**
  97898. * Returns a promise that resolves when the scene is ready
  97899. * @returns A promise that resolves when the scene is ready
  97900. */
  97901. whenReadyAsync(): Promise<void>;
  97902. /** @hidden */
  97903. _checkIsReady(): void;
  97904. /**
  97905. * Gets all animatable attached to the scene
  97906. */
  97907. readonly animatables: Animatable[];
  97908. /**
  97909. * Resets the last animation time frame.
  97910. * Useful to override when animations start running when loading a scene for the first time.
  97911. */
  97912. resetLastAnimationTimeFrame(): void;
  97913. /**
  97914. * Gets the current view matrix
  97915. * @returns a Matrix
  97916. */
  97917. getViewMatrix(): Matrix;
  97918. /**
  97919. * Gets the current projection matrix
  97920. * @returns a Matrix
  97921. */
  97922. getProjectionMatrix(): Matrix;
  97923. /**
  97924. * Gets the current transform matrix
  97925. * @returns a Matrix made of View * Projection
  97926. */
  97927. getTransformMatrix(): Matrix;
  97928. /**
  97929. * Sets the current transform matrix
  97930. * @param viewL defines the View matrix to use
  97931. * @param projectionL defines the Projection matrix to use
  97932. * @param viewR defines the right View matrix to use (if provided)
  97933. * @param projectionR defines the right Projection matrix to use (if provided)
  97934. */
  97935. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  97936. /**
  97937. * Gets the uniform buffer used to store scene data
  97938. * @returns a UniformBuffer
  97939. */
  97940. getSceneUniformBuffer(): UniformBuffer;
  97941. /**
  97942. * Gets an unique (relatively to the current scene) Id
  97943. * @returns an unique number for the scene
  97944. */
  97945. getUniqueId(): number;
  97946. /**
  97947. * Add a mesh to the list of scene's meshes
  97948. * @param newMesh defines the mesh to add
  97949. * @param recursive if all child meshes should also be added to the scene
  97950. */
  97951. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  97952. /**
  97953. * Remove a mesh for the list of scene's meshes
  97954. * @param toRemove defines the mesh to remove
  97955. * @param recursive if all child meshes should also be removed from the scene
  97956. * @returns the index where the mesh was in the mesh list
  97957. */
  97958. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  97959. /**
  97960. * Add a transform node to the list of scene's transform nodes
  97961. * @param newTransformNode defines the transform node to add
  97962. */
  97963. addTransformNode(newTransformNode: TransformNode): void;
  97964. /**
  97965. * Remove a transform node for the list of scene's transform nodes
  97966. * @param toRemove defines the transform node to remove
  97967. * @returns the index where the transform node was in the transform node list
  97968. */
  97969. removeTransformNode(toRemove: TransformNode): number;
  97970. /**
  97971. * Remove a skeleton for the list of scene's skeletons
  97972. * @param toRemove defines the skeleton to remove
  97973. * @returns the index where the skeleton was in the skeleton list
  97974. */
  97975. removeSkeleton(toRemove: Skeleton): number;
  97976. /**
  97977. * Remove a morph target for the list of scene's morph targets
  97978. * @param toRemove defines the morph target to remove
  97979. * @returns the index where the morph target was in the morph target list
  97980. */
  97981. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  97982. /**
  97983. * Remove a light for the list of scene's lights
  97984. * @param toRemove defines the light to remove
  97985. * @returns the index where the light was in the light list
  97986. */
  97987. removeLight(toRemove: Light): number;
  97988. /**
  97989. * Remove a camera for the list of scene's cameras
  97990. * @param toRemove defines the camera to remove
  97991. * @returns the index where the camera was in the camera list
  97992. */
  97993. removeCamera(toRemove: Camera): number;
  97994. /**
  97995. * Remove a particle system for the list of scene's particle systems
  97996. * @param toRemove defines the particle system to remove
  97997. * @returns the index where the particle system was in the particle system list
  97998. */
  97999. removeParticleSystem(toRemove: IParticleSystem): number;
  98000. /**
  98001. * Remove a animation for the list of scene's animations
  98002. * @param toRemove defines the animation to remove
  98003. * @returns the index where the animation was in the animation list
  98004. */
  98005. removeAnimation(toRemove: Animation): number;
  98006. /**
  98007. * Will stop the animation of the given target
  98008. * @param target - the target
  98009. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  98010. * @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)
  98011. */
  98012. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  98013. /**
  98014. * Removes the given animation group from this scene.
  98015. * @param toRemove The animation group to remove
  98016. * @returns The index of the removed animation group
  98017. */
  98018. removeAnimationGroup(toRemove: AnimationGroup): number;
  98019. /**
  98020. * Removes the given multi-material from this scene.
  98021. * @param toRemove The multi-material to remove
  98022. * @returns The index of the removed multi-material
  98023. */
  98024. removeMultiMaterial(toRemove: MultiMaterial): number;
  98025. /**
  98026. * Removes the given material from this scene.
  98027. * @param toRemove The material to remove
  98028. * @returns The index of the removed material
  98029. */
  98030. removeMaterial(toRemove: Material): number;
  98031. /**
  98032. * Removes the given action manager from this scene.
  98033. * @param toRemove The action manager to remove
  98034. * @returns The index of the removed action manager
  98035. */
  98036. removeActionManager(toRemove: AbstractActionManager): number;
  98037. /**
  98038. * Removes the given texture from this scene.
  98039. * @param toRemove The texture to remove
  98040. * @returns The index of the removed texture
  98041. */
  98042. removeTexture(toRemove: BaseTexture): number;
  98043. /**
  98044. * Adds the given light to this scene
  98045. * @param newLight The light to add
  98046. */
  98047. addLight(newLight: Light): void;
  98048. /**
  98049. * Sorts the list list based on light priorities
  98050. */
  98051. sortLightsByPriority(): void;
  98052. /**
  98053. * Adds the given camera to this scene
  98054. * @param newCamera The camera to add
  98055. */
  98056. addCamera(newCamera: Camera): void;
  98057. /**
  98058. * Adds the given skeleton to this scene
  98059. * @param newSkeleton The skeleton to add
  98060. */
  98061. addSkeleton(newSkeleton: Skeleton): void;
  98062. /**
  98063. * Adds the given particle system to this scene
  98064. * @param newParticleSystem The particle system to add
  98065. */
  98066. addParticleSystem(newParticleSystem: IParticleSystem): void;
  98067. /**
  98068. * Adds the given animation to this scene
  98069. * @param newAnimation The animation to add
  98070. */
  98071. addAnimation(newAnimation: Animation): void;
  98072. /**
  98073. * Adds the given animation group to this scene.
  98074. * @param newAnimationGroup The animation group to add
  98075. */
  98076. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  98077. /**
  98078. * Adds the given multi-material to this scene
  98079. * @param newMultiMaterial The multi-material to add
  98080. */
  98081. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  98082. /**
  98083. * Adds the given material to this scene
  98084. * @param newMaterial The material to add
  98085. */
  98086. addMaterial(newMaterial: Material): void;
  98087. /**
  98088. * Adds the given morph target to this scene
  98089. * @param newMorphTargetManager The morph target to add
  98090. */
  98091. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  98092. /**
  98093. * Adds the given geometry to this scene
  98094. * @param newGeometry The geometry to add
  98095. */
  98096. addGeometry(newGeometry: Geometry): void;
  98097. /**
  98098. * Adds the given action manager to this scene
  98099. * @param newActionManager The action manager to add
  98100. */
  98101. addActionManager(newActionManager: AbstractActionManager): void;
  98102. /**
  98103. * Adds the given texture to this scene.
  98104. * @param newTexture The texture to add
  98105. */
  98106. addTexture(newTexture: BaseTexture): void;
  98107. /**
  98108. * Switch active camera
  98109. * @param newCamera defines the new active camera
  98110. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  98111. */
  98112. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  98113. /**
  98114. * sets the active camera of the scene using its ID
  98115. * @param id defines the camera's ID
  98116. * @return the new active camera or null if none found.
  98117. */
  98118. setActiveCameraByID(id: string): Nullable<Camera>;
  98119. /**
  98120. * sets the active camera of the scene using its name
  98121. * @param name defines the camera's name
  98122. * @returns the new active camera or null if none found.
  98123. */
  98124. setActiveCameraByName(name: string): Nullable<Camera>;
  98125. /**
  98126. * get an animation group using its name
  98127. * @param name defines the material's name
  98128. * @return the animation group or null if none found.
  98129. */
  98130. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  98131. /**
  98132. * Get a material using its unique id
  98133. * @param uniqueId defines the material's unique id
  98134. * @return the material or null if none found.
  98135. */
  98136. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  98137. /**
  98138. * get a material using its id
  98139. * @param id defines the material's ID
  98140. * @return the material or null if none found.
  98141. */
  98142. getMaterialByID(id: string): Nullable<Material>;
  98143. /**
  98144. * Gets a the last added material using a given id
  98145. * @param id defines the material's ID
  98146. * @return the last material with the given id or null if none found.
  98147. */
  98148. getLastMaterialByID(id: string): Nullable<Material>;
  98149. /**
  98150. * Gets a material using its name
  98151. * @param name defines the material's name
  98152. * @return the material or null if none found.
  98153. */
  98154. getMaterialByName(name: string): Nullable<Material>;
  98155. /**
  98156. * Get a texture using its unique id
  98157. * @param uniqueId defines the texture's unique id
  98158. * @return the texture or null if none found.
  98159. */
  98160. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  98161. /**
  98162. * Gets a camera using its id
  98163. * @param id defines the id to look for
  98164. * @returns the camera or null if not found
  98165. */
  98166. getCameraByID(id: string): Nullable<Camera>;
  98167. /**
  98168. * Gets a camera using its unique id
  98169. * @param uniqueId defines the unique id to look for
  98170. * @returns the camera or null if not found
  98171. */
  98172. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  98173. /**
  98174. * Gets a camera using its name
  98175. * @param name defines the camera's name
  98176. * @return the camera or null if none found.
  98177. */
  98178. getCameraByName(name: string): Nullable<Camera>;
  98179. /**
  98180. * Gets a bone using its id
  98181. * @param id defines the bone's id
  98182. * @return the bone or null if not found
  98183. */
  98184. getBoneByID(id: string): Nullable<Bone>;
  98185. /**
  98186. * Gets a bone using its id
  98187. * @param name defines the bone's name
  98188. * @return the bone or null if not found
  98189. */
  98190. getBoneByName(name: string): Nullable<Bone>;
  98191. /**
  98192. * Gets a light node using its name
  98193. * @param name defines the the light's name
  98194. * @return the light or null if none found.
  98195. */
  98196. getLightByName(name: string): Nullable<Light>;
  98197. /**
  98198. * Gets a light node using its id
  98199. * @param id defines the light's id
  98200. * @return the light or null if none found.
  98201. */
  98202. getLightByID(id: string): Nullable<Light>;
  98203. /**
  98204. * Gets a light node using its scene-generated unique ID
  98205. * @param uniqueId defines the light's unique id
  98206. * @return the light or null if none found.
  98207. */
  98208. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  98209. /**
  98210. * Gets a particle system by id
  98211. * @param id defines the particle system id
  98212. * @return the corresponding system or null if none found
  98213. */
  98214. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  98215. /**
  98216. * Gets a geometry using its ID
  98217. * @param id defines the geometry's id
  98218. * @return the geometry or null if none found.
  98219. */
  98220. getGeometryByID(id: string): Nullable<Geometry>;
  98221. private _getGeometryByUniqueID;
  98222. /**
  98223. * Add a new geometry to this scene
  98224. * @param geometry defines the geometry to be added to the scene.
  98225. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  98226. * @return a boolean defining if the geometry was added or not
  98227. */
  98228. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  98229. /**
  98230. * Removes an existing geometry
  98231. * @param geometry defines the geometry to be removed from the scene
  98232. * @return a boolean defining if the geometry was removed or not
  98233. */
  98234. removeGeometry(geometry: Geometry): boolean;
  98235. /**
  98236. * Gets the list of geometries attached to the scene
  98237. * @returns an array of Geometry
  98238. */
  98239. getGeometries(): Geometry[];
  98240. /**
  98241. * Gets the first added mesh found of a given ID
  98242. * @param id defines the id to search for
  98243. * @return the mesh found or null if not found at all
  98244. */
  98245. getMeshByID(id: string): Nullable<AbstractMesh>;
  98246. /**
  98247. * Gets a list of meshes using their id
  98248. * @param id defines the id to search for
  98249. * @returns a list of meshes
  98250. */
  98251. getMeshesByID(id: string): Array<AbstractMesh>;
  98252. /**
  98253. * Gets the first added transform node found of a given ID
  98254. * @param id defines the id to search for
  98255. * @return the found transform node or null if not found at all.
  98256. */
  98257. getTransformNodeByID(id: string): Nullable<TransformNode>;
  98258. /**
  98259. * Gets a transform node with its auto-generated unique id
  98260. * @param uniqueId efines the unique id to search for
  98261. * @return the found transform node or null if not found at all.
  98262. */
  98263. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  98264. /**
  98265. * Gets a list of transform nodes using their id
  98266. * @param id defines the id to search for
  98267. * @returns a list of transform nodes
  98268. */
  98269. getTransformNodesByID(id: string): Array<TransformNode>;
  98270. /**
  98271. * Gets a mesh with its auto-generated unique id
  98272. * @param uniqueId defines the unique id to search for
  98273. * @return the found mesh or null if not found at all.
  98274. */
  98275. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  98276. /**
  98277. * Gets a the last added mesh using a given id
  98278. * @param id defines the id to search for
  98279. * @return the found mesh or null if not found at all.
  98280. */
  98281. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  98282. /**
  98283. * Gets a the last added node (Mesh, Camera, Light) using a given id
  98284. * @param id defines the id to search for
  98285. * @return the found node or null if not found at all
  98286. */
  98287. getLastEntryByID(id: string): Nullable<Node>;
  98288. /**
  98289. * Gets a node (Mesh, Camera, Light) using a given id
  98290. * @param id defines the id to search for
  98291. * @return the found node or null if not found at all
  98292. */
  98293. getNodeByID(id: string): Nullable<Node>;
  98294. /**
  98295. * Gets a node (Mesh, Camera, Light) using a given name
  98296. * @param name defines the name to search for
  98297. * @return the found node or null if not found at all.
  98298. */
  98299. getNodeByName(name: string): Nullable<Node>;
  98300. /**
  98301. * Gets a mesh using a given name
  98302. * @param name defines the name to search for
  98303. * @return the found mesh or null if not found at all.
  98304. */
  98305. getMeshByName(name: string): Nullable<AbstractMesh>;
  98306. /**
  98307. * Gets a transform node using a given name
  98308. * @param name defines the name to search for
  98309. * @return the found transform node or null if not found at all.
  98310. */
  98311. getTransformNodeByName(name: string): Nullable<TransformNode>;
  98312. /**
  98313. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  98314. * @param id defines the id to search for
  98315. * @return the found skeleton or null if not found at all.
  98316. */
  98317. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  98318. /**
  98319. * Gets a skeleton using a given auto generated unique id
  98320. * @param uniqueId defines the unique id to search for
  98321. * @return the found skeleton or null if not found at all.
  98322. */
  98323. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  98324. /**
  98325. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  98326. * @param id defines the id to search for
  98327. * @return the found skeleton or null if not found at all.
  98328. */
  98329. getSkeletonById(id: string): Nullable<Skeleton>;
  98330. /**
  98331. * Gets a skeleton using a given name
  98332. * @param name defines the name to search for
  98333. * @return the found skeleton or null if not found at all.
  98334. */
  98335. getSkeletonByName(name: string): Nullable<Skeleton>;
  98336. /**
  98337. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  98338. * @param id defines the id to search for
  98339. * @return the found morph target manager or null if not found at all.
  98340. */
  98341. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  98342. /**
  98343. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  98344. * @param id defines the id to search for
  98345. * @return the found morph target or null if not found at all.
  98346. */
  98347. getMorphTargetById(id: string): Nullable<MorphTarget>;
  98348. /**
  98349. * Gets a boolean indicating if the given mesh is active
  98350. * @param mesh defines the mesh to look for
  98351. * @returns true if the mesh is in the active list
  98352. */
  98353. isActiveMesh(mesh: AbstractMesh): boolean;
  98354. /**
  98355. * Return a unique id as a string which can serve as an identifier for the scene
  98356. */
  98357. readonly uid: string;
  98358. /**
  98359. * Add an externaly attached data from its key.
  98360. * This method call will fail and return false, if such key already exists.
  98361. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  98362. * @param key the unique key that identifies the data
  98363. * @param data the data object to associate to the key for this Engine instance
  98364. * @return true if no such key were already present and the data was added successfully, false otherwise
  98365. */
  98366. addExternalData<T>(key: string, data: T): boolean;
  98367. /**
  98368. * Get an externaly attached data from its key
  98369. * @param key the unique key that identifies the data
  98370. * @return the associated data, if present (can be null), or undefined if not present
  98371. */
  98372. getExternalData<T>(key: string): Nullable<T>;
  98373. /**
  98374. * Get an externaly attached data from its key, create it using a factory if it's not already present
  98375. * @param key the unique key that identifies the data
  98376. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  98377. * @return the associated data, can be null if the factory returned null.
  98378. */
  98379. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  98380. /**
  98381. * Remove an externaly attached data from the Engine instance
  98382. * @param key the unique key that identifies the data
  98383. * @return true if the data was successfully removed, false if it doesn't exist
  98384. */
  98385. removeExternalData(key: string): boolean;
  98386. private _evaluateSubMesh;
  98387. /**
  98388. * Clear the processed materials smart array preventing retention point in material dispose.
  98389. */
  98390. freeProcessedMaterials(): void;
  98391. private _preventFreeActiveMeshesAndRenderingGroups;
  98392. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  98393. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  98394. * when disposing several meshes in a row or a hierarchy of meshes.
  98395. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  98396. */
  98397. blockfreeActiveMeshesAndRenderingGroups: boolean;
  98398. /**
  98399. * Clear the active meshes smart array preventing retention point in mesh dispose.
  98400. */
  98401. freeActiveMeshes(): void;
  98402. /**
  98403. * Clear the info related to rendering groups preventing retention points during dispose.
  98404. */
  98405. freeRenderingGroups(): void;
  98406. /** @hidden */
  98407. _isInIntermediateRendering(): boolean;
  98408. /**
  98409. * Lambda returning the list of potentially active meshes.
  98410. */
  98411. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  98412. /**
  98413. * Lambda returning the list of potentially active sub meshes.
  98414. */
  98415. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  98416. /**
  98417. * Lambda returning the list of potentially intersecting sub meshes.
  98418. */
  98419. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  98420. /**
  98421. * Lambda returning the list of potentially colliding sub meshes.
  98422. */
  98423. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  98424. private _activeMeshesFrozen;
  98425. /**
  98426. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  98427. * @returns the current scene
  98428. */
  98429. freezeActiveMeshes(): Scene;
  98430. /**
  98431. * Use this function to restart evaluating active meshes on every frame
  98432. * @returns the current scene
  98433. */
  98434. unfreezeActiveMeshes(): Scene;
  98435. private _evaluateActiveMeshes;
  98436. private _activeMesh;
  98437. /**
  98438. * Update the transform matrix to update from the current active camera
  98439. * @param force defines a boolean used to force the update even if cache is up to date
  98440. */
  98441. updateTransformMatrix(force?: boolean): void;
  98442. private _bindFrameBuffer;
  98443. /** @hidden */
  98444. _allowPostProcessClearColor: boolean;
  98445. /** @hidden */
  98446. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  98447. private _processSubCameras;
  98448. private _checkIntersections;
  98449. /** @hidden */
  98450. _advancePhysicsEngineStep(step: number): void;
  98451. /**
  98452. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  98453. */
  98454. getDeterministicFrameTime: () => number;
  98455. /** @hidden */
  98456. _animate(): void;
  98457. /** Execute all animations (for a frame) */
  98458. animate(): void;
  98459. /**
  98460. * Render the scene
  98461. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  98462. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  98463. */
  98464. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  98465. /**
  98466. * Freeze all materials
  98467. * A frozen material will not be updatable but should be faster to render
  98468. */
  98469. freezeMaterials(): void;
  98470. /**
  98471. * Unfreeze all materials
  98472. * A frozen material will not be updatable but should be faster to render
  98473. */
  98474. unfreezeMaterials(): void;
  98475. /**
  98476. * Releases all held ressources
  98477. */
  98478. dispose(): void;
  98479. /**
  98480. * Gets if the scene is already disposed
  98481. */
  98482. readonly isDisposed: boolean;
  98483. /**
  98484. * Call this function to reduce memory footprint of the scene.
  98485. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  98486. */
  98487. clearCachedVertexData(): void;
  98488. /**
  98489. * This function will remove the local cached buffer data from texture.
  98490. * It will save memory but will prevent the texture from being rebuilt
  98491. */
  98492. cleanCachedTextureBuffer(): void;
  98493. /**
  98494. * Get the world extend vectors with an optional filter
  98495. *
  98496. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  98497. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  98498. */
  98499. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  98500. min: Vector3;
  98501. max: Vector3;
  98502. };
  98503. /**
  98504. * Creates a ray that can be used to pick in the scene
  98505. * @param x defines the x coordinate of the origin (on-screen)
  98506. * @param y defines the y coordinate of the origin (on-screen)
  98507. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  98508. * @param camera defines the camera to use for the picking
  98509. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  98510. * @returns a Ray
  98511. */
  98512. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  98513. /**
  98514. * Creates a ray that can be used to pick in the scene
  98515. * @param x defines the x coordinate of the origin (on-screen)
  98516. * @param y defines the y coordinate of the origin (on-screen)
  98517. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  98518. * @param result defines the ray where to store the picking ray
  98519. * @param camera defines the camera to use for the picking
  98520. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  98521. * @returns the current scene
  98522. */
  98523. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  98524. /**
  98525. * Creates a ray that can be used to pick in the scene
  98526. * @param x defines the x coordinate of the origin (on-screen)
  98527. * @param y defines the y coordinate of the origin (on-screen)
  98528. * @param camera defines the camera to use for the picking
  98529. * @returns a Ray
  98530. */
  98531. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  98532. /**
  98533. * Creates a ray that can be used to pick in the scene
  98534. * @param x defines the x coordinate of the origin (on-screen)
  98535. * @param y defines the y coordinate of the origin (on-screen)
  98536. * @param result defines the ray where to store the picking ray
  98537. * @param camera defines the camera to use for the picking
  98538. * @returns the current scene
  98539. */
  98540. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  98541. /** Launch a ray to try to pick a mesh in the scene
  98542. * @param x position on screen
  98543. * @param y position on screen
  98544. * @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
  98545. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  98546. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  98547. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  98548. * @returns a PickingInfo
  98549. */
  98550. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  98551. /** Use the given ray to pick a mesh in the scene
  98552. * @param ray The ray to use to pick meshes
  98553. * @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
  98554. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  98555. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  98556. * @returns a PickingInfo
  98557. */
  98558. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  98559. /**
  98560. * Launch a ray to try to pick a mesh in the scene
  98561. * @param x X position on screen
  98562. * @param y Y position on screen
  98563. * @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
  98564. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  98565. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  98566. * @returns an array of PickingInfo
  98567. */
  98568. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  98569. /**
  98570. * Launch a ray to try to pick a mesh in the scene
  98571. * @param ray Ray to use
  98572. * @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
  98573. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  98574. * @returns an array of PickingInfo
  98575. */
  98576. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  98577. /**
  98578. * Force the value of meshUnderPointer
  98579. * @param mesh defines the mesh to use
  98580. */
  98581. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  98582. /**
  98583. * Gets the mesh under the pointer
  98584. * @returns a Mesh or null if no mesh is under the pointer
  98585. */
  98586. getPointerOverMesh(): Nullable<AbstractMesh>;
  98587. /** @hidden */
  98588. _rebuildGeometries(): void;
  98589. /** @hidden */
  98590. _rebuildTextures(): void;
  98591. private _getByTags;
  98592. /**
  98593. * Get a list of meshes by tags
  98594. * @param tagsQuery defines the tags query to use
  98595. * @param forEach defines a predicate used to filter results
  98596. * @returns an array of Mesh
  98597. */
  98598. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  98599. /**
  98600. * Get a list of cameras by tags
  98601. * @param tagsQuery defines the tags query to use
  98602. * @param forEach defines a predicate used to filter results
  98603. * @returns an array of Camera
  98604. */
  98605. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  98606. /**
  98607. * Get a list of lights by tags
  98608. * @param tagsQuery defines the tags query to use
  98609. * @param forEach defines a predicate used to filter results
  98610. * @returns an array of Light
  98611. */
  98612. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  98613. /**
  98614. * Get a list of materials by tags
  98615. * @param tagsQuery defines the tags query to use
  98616. * @param forEach defines a predicate used to filter results
  98617. * @returns an array of Material
  98618. */
  98619. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  98620. /**
  98621. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  98622. * This allowed control for front to back rendering or reversly depending of the special needs.
  98623. *
  98624. * @param renderingGroupId The rendering group id corresponding to its index
  98625. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  98626. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  98627. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  98628. */
  98629. 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;
  98630. /**
  98631. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  98632. *
  98633. * @param renderingGroupId The rendering group id corresponding to its index
  98634. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  98635. * @param depth Automatically clears depth between groups if true and autoClear is true.
  98636. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  98637. */
  98638. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  98639. /**
  98640. * Gets the current auto clear configuration for one rendering group of the rendering
  98641. * manager.
  98642. * @param index the rendering group index to get the information for
  98643. * @returns The auto clear setup for the requested rendering group
  98644. */
  98645. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  98646. private _blockMaterialDirtyMechanism;
  98647. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  98648. blockMaterialDirtyMechanism: boolean;
  98649. /**
  98650. * Will flag all materials as dirty to trigger new shader compilation
  98651. * @param flag defines the flag used to specify which material part must be marked as dirty
  98652. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  98653. */
  98654. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  98655. /** @hidden */
  98656. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  98657. /** @hidden */
  98658. _loadFileAsync(url: string, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  98659. }
  98660. }
  98661. declare module BABYLON {
  98662. /**
  98663. * Set of assets to keep when moving a scene into an asset container.
  98664. */
  98665. export class KeepAssets extends AbstractScene {
  98666. }
  98667. /**
  98668. * Container with a set of assets that can be added or removed from a scene.
  98669. */
  98670. export class AssetContainer extends AbstractScene {
  98671. /**
  98672. * The scene the AssetContainer belongs to.
  98673. */
  98674. scene: Scene;
  98675. /**
  98676. * Instantiates an AssetContainer.
  98677. * @param scene The scene the AssetContainer belongs to.
  98678. */
  98679. constructor(scene: Scene);
  98680. /**
  98681. * Adds all the assets from the container to the scene.
  98682. */
  98683. addAllToScene(): void;
  98684. /**
  98685. * Removes all the assets in the container from the scene
  98686. */
  98687. removeAllFromScene(): void;
  98688. /**
  98689. * Disposes all the assets in the container
  98690. */
  98691. dispose(): void;
  98692. private _moveAssets;
  98693. /**
  98694. * Removes all the assets contained in the scene and adds them to the container.
  98695. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  98696. */
  98697. moveAllFromScene(keepAssets?: KeepAssets): void;
  98698. /**
  98699. * 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.
  98700. * @returns the root mesh
  98701. */
  98702. createRootMesh(): Mesh;
  98703. }
  98704. }
  98705. declare module BABYLON {
  98706. /**
  98707. * Defines how the parser contract is defined.
  98708. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  98709. */
  98710. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  98711. /**
  98712. * Defines how the individual parser contract is defined.
  98713. * These parser can parse an individual asset
  98714. */
  98715. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  98716. /**
  98717. * Base class of the scene acting as a container for the different elements composing a scene.
  98718. * This class is dynamically extended by the different components of the scene increasing
  98719. * flexibility and reducing coupling
  98720. */
  98721. export abstract class AbstractScene {
  98722. /**
  98723. * Stores the list of available parsers in the application.
  98724. */
  98725. private static _BabylonFileParsers;
  98726. /**
  98727. * Stores the list of available individual parsers in the application.
  98728. */
  98729. private static _IndividualBabylonFileParsers;
  98730. /**
  98731. * Adds a parser in the list of available ones
  98732. * @param name Defines the name of the parser
  98733. * @param parser Defines the parser to add
  98734. */
  98735. static AddParser(name: string, parser: BabylonFileParser): void;
  98736. /**
  98737. * Gets a general parser from the list of avaialble ones
  98738. * @param name Defines the name of the parser
  98739. * @returns the requested parser or null
  98740. */
  98741. static GetParser(name: string): Nullable<BabylonFileParser>;
  98742. /**
  98743. * Adds n individual parser in the list of available ones
  98744. * @param name Defines the name of the parser
  98745. * @param parser Defines the parser to add
  98746. */
  98747. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  98748. /**
  98749. * Gets an individual parser from the list of avaialble ones
  98750. * @param name Defines the name of the parser
  98751. * @returns the requested parser or null
  98752. */
  98753. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  98754. /**
  98755. * Parser json data and populate both a scene and its associated container object
  98756. * @param jsonData Defines the data to parse
  98757. * @param scene Defines the scene to parse the data for
  98758. * @param container Defines the container attached to the parsing sequence
  98759. * @param rootUrl Defines the root url of the data
  98760. */
  98761. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  98762. /**
  98763. * Gets the list of root nodes (ie. nodes with no parent)
  98764. */
  98765. rootNodes: Node[];
  98766. /** All of the cameras added to this scene
  98767. * @see http://doc.babylonjs.com/babylon101/cameras
  98768. */
  98769. cameras: Camera[];
  98770. /**
  98771. * All of the lights added to this scene
  98772. * @see http://doc.babylonjs.com/babylon101/lights
  98773. */
  98774. lights: Light[];
  98775. /**
  98776. * All of the (abstract) meshes added to this scene
  98777. */
  98778. meshes: AbstractMesh[];
  98779. /**
  98780. * The list of skeletons added to the scene
  98781. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  98782. */
  98783. skeletons: Skeleton[];
  98784. /**
  98785. * All of the particle systems added to this scene
  98786. * @see http://doc.babylonjs.com/babylon101/particles
  98787. */
  98788. particleSystems: IParticleSystem[];
  98789. /**
  98790. * Gets a list of Animations associated with the scene
  98791. */
  98792. animations: Animation[];
  98793. /**
  98794. * All of the animation groups added to this scene
  98795. * @see http://doc.babylonjs.com/how_to/group
  98796. */
  98797. animationGroups: AnimationGroup[];
  98798. /**
  98799. * All of the multi-materials added to this scene
  98800. * @see http://doc.babylonjs.com/how_to/multi_materials
  98801. */
  98802. multiMaterials: MultiMaterial[];
  98803. /**
  98804. * All of the materials added to this scene
  98805. * In the context of a Scene, it is not supposed to be modified manually.
  98806. * Any addition or removal should be done using the addMaterial and removeMAterial Scene methods.
  98807. * Note also that the order of the Material wihin the array is not significant and might change.
  98808. * @see http://doc.babylonjs.com/babylon101/materials
  98809. */
  98810. materials: Material[];
  98811. /**
  98812. * The list of morph target managers added to the scene
  98813. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  98814. */
  98815. morphTargetManagers: MorphTargetManager[];
  98816. /**
  98817. * The list of geometries used in the scene.
  98818. */
  98819. geometries: Geometry[];
  98820. /**
  98821. * All of the tranform nodes added to this scene
  98822. * In the context of a Scene, it is not supposed to be modified manually.
  98823. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  98824. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  98825. * @see http://doc.babylonjs.com/how_to/transformnode
  98826. */
  98827. transformNodes: TransformNode[];
  98828. /**
  98829. * ActionManagers available on the scene.
  98830. */
  98831. actionManagers: AbstractActionManager[];
  98832. /**
  98833. * Textures to keep.
  98834. */
  98835. textures: BaseTexture[];
  98836. /**
  98837. * Environment texture for the scene
  98838. */
  98839. environmentTexture: Nullable<BaseTexture>;
  98840. }
  98841. }
  98842. declare module BABYLON {
  98843. /**
  98844. * Interface used to define options for Sound class
  98845. */
  98846. export interface ISoundOptions {
  98847. /**
  98848. * Does the sound autoplay once loaded.
  98849. */
  98850. autoplay?: boolean;
  98851. /**
  98852. * Does the sound loop after it finishes playing once.
  98853. */
  98854. loop?: boolean;
  98855. /**
  98856. * Sound's volume
  98857. */
  98858. volume?: number;
  98859. /**
  98860. * Is it a spatial sound?
  98861. */
  98862. spatialSound?: boolean;
  98863. /**
  98864. * Maximum distance to hear that sound
  98865. */
  98866. maxDistance?: number;
  98867. /**
  98868. * Uses user defined attenuation function
  98869. */
  98870. useCustomAttenuation?: boolean;
  98871. /**
  98872. * Define the roll off factor of spatial sounds.
  98873. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98874. */
  98875. rolloffFactor?: number;
  98876. /**
  98877. * Define the reference distance the sound should be heard perfectly.
  98878. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98879. */
  98880. refDistance?: number;
  98881. /**
  98882. * Define the distance attenuation model the sound will follow.
  98883. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98884. */
  98885. distanceModel?: string;
  98886. /**
  98887. * Defines the playback speed (1 by default)
  98888. */
  98889. playbackRate?: number;
  98890. /**
  98891. * Defines if the sound is from a streaming source
  98892. */
  98893. streaming?: boolean;
  98894. /**
  98895. * Defines an optional length (in seconds) inside the sound file
  98896. */
  98897. length?: number;
  98898. /**
  98899. * Defines an optional offset (in seconds) inside the sound file
  98900. */
  98901. offset?: number;
  98902. /**
  98903. * If true, URLs will not be required to state the audio file codec to use.
  98904. */
  98905. skipCodecCheck?: boolean;
  98906. }
  98907. /**
  98908. * Defines a sound that can be played in the application.
  98909. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  98910. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98911. */
  98912. export class Sound {
  98913. /**
  98914. * The name of the sound in the scene.
  98915. */
  98916. name: string;
  98917. /**
  98918. * Does the sound autoplay once loaded.
  98919. */
  98920. autoplay: boolean;
  98921. /**
  98922. * Does the sound loop after it finishes playing once.
  98923. */
  98924. loop: boolean;
  98925. /**
  98926. * Does the sound use a custom attenuation curve to simulate the falloff
  98927. * happening when the source gets further away from the camera.
  98928. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  98929. */
  98930. useCustomAttenuation: boolean;
  98931. /**
  98932. * The sound track id this sound belongs to.
  98933. */
  98934. soundTrackId: number;
  98935. /**
  98936. * Is this sound currently played.
  98937. */
  98938. isPlaying: boolean;
  98939. /**
  98940. * Is this sound currently paused.
  98941. */
  98942. isPaused: boolean;
  98943. /**
  98944. * Does this sound enables spatial sound.
  98945. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98946. */
  98947. spatialSound: boolean;
  98948. /**
  98949. * Define the reference distance the sound should be heard perfectly.
  98950. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98951. */
  98952. refDistance: number;
  98953. /**
  98954. * Define the roll off factor of spatial sounds.
  98955. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98956. */
  98957. rolloffFactor: number;
  98958. /**
  98959. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  98960. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98961. */
  98962. maxDistance: number;
  98963. /**
  98964. * Define the distance attenuation model the sound will follow.
  98965. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  98966. */
  98967. distanceModel: string;
  98968. /**
  98969. * @hidden
  98970. * Back Compat
  98971. **/
  98972. onended: () => any;
  98973. /**
  98974. * Observable event when the current playing sound finishes.
  98975. */
  98976. onEndedObservable: Observable<Sound>;
  98977. private _panningModel;
  98978. private _playbackRate;
  98979. private _streaming;
  98980. private _startTime;
  98981. private _startOffset;
  98982. private _position;
  98983. /** @hidden */
  98984. _positionInEmitterSpace: boolean;
  98985. private _localDirection;
  98986. private _volume;
  98987. private _isReadyToPlay;
  98988. private _isDirectional;
  98989. private _readyToPlayCallback;
  98990. private _audioBuffer;
  98991. private _soundSource;
  98992. private _streamingSource;
  98993. private _soundPanner;
  98994. private _soundGain;
  98995. private _inputAudioNode;
  98996. private _outputAudioNode;
  98997. private _coneInnerAngle;
  98998. private _coneOuterAngle;
  98999. private _coneOuterGain;
  99000. private _scene;
  99001. private _connectedTransformNode;
  99002. private _customAttenuationFunction;
  99003. private _registerFunc;
  99004. private _isOutputConnected;
  99005. private _htmlAudioElement;
  99006. private _urlType;
  99007. private _length?;
  99008. private _offset?;
  99009. /** @hidden */
  99010. static _SceneComponentInitialization: (scene: Scene) => void;
  99011. /**
  99012. * Create a sound and attach it to a scene
  99013. * @param name Name of your sound
  99014. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  99015. * @param scene defines the scene the sound belongs to
  99016. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  99017. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  99018. */
  99019. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  99020. /**
  99021. * Release the sound and its associated resources
  99022. */
  99023. dispose(): void;
  99024. /**
  99025. * Gets if the sounds is ready to be played or not.
  99026. * @returns true if ready, otherwise false
  99027. */
  99028. isReady(): boolean;
  99029. private _soundLoaded;
  99030. /**
  99031. * Sets the data of the sound from an audiobuffer
  99032. * @param audioBuffer The audioBuffer containing the data
  99033. */
  99034. setAudioBuffer(audioBuffer: AudioBuffer): void;
  99035. /**
  99036. * Updates the current sounds options such as maxdistance, loop...
  99037. * @param options A JSON object containing values named as the object properties
  99038. */
  99039. updateOptions(options: ISoundOptions): void;
  99040. private _createSpatialParameters;
  99041. private _updateSpatialParameters;
  99042. /**
  99043. * Switch the panning model to HRTF:
  99044. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  99045. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  99046. */
  99047. switchPanningModelToHRTF(): void;
  99048. /**
  99049. * Switch the panning model to Equal Power:
  99050. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  99051. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  99052. */
  99053. switchPanningModelToEqualPower(): void;
  99054. private _switchPanningModel;
  99055. /**
  99056. * Connect this sound to a sound track audio node like gain...
  99057. * @param soundTrackAudioNode the sound track audio node to connect to
  99058. */
  99059. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  99060. /**
  99061. * Transform this sound into a directional source
  99062. * @param coneInnerAngle Size of the inner cone in degree
  99063. * @param coneOuterAngle Size of the outer cone in degree
  99064. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  99065. */
  99066. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  99067. /**
  99068. * Gets or sets the inner angle for the directional cone.
  99069. */
  99070. /**
  99071. * Gets or sets the inner angle for the directional cone.
  99072. */
  99073. directionalConeInnerAngle: number;
  99074. /**
  99075. * Gets or sets the outer angle for the directional cone.
  99076. */
  99077. /**
  99078. * Gets or sets the outer angle for the directional cone.
  99079. */
  99080. directionalConeOuterAngle: number;
  99081. /**
  99082. * Sets the position of the emitter if spatial sound is enabled
  99083. * @param newPosition Defines the new posisiton
  99084. */
  99085. setPosition(newPosition: Vector3): void;
  99086. /**
  99087. * Sets the local direction of the emitter if spatial sound is enabled
  99088. * @param newLocalDirection Defines the new local direction
  99089. */
  99090. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  99091. private _updateDirection;
  99092. /** @hidden */
  99093. updateDistanceFromListener(): void;
  99094. /**
  99095. * Sets a new custom attenuation function for the sound.
  99096. * @param callback Defines the function used for the attenuation
  99097. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  99098. */
  99099. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  99100. /**
  99101. * Play the sound
  99102. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  99103. * @param offset (optional) Start the sound at a specific time in seconds
  99104. * @param length (optional) Sound duration (in seconds)
  99105. */
  99106. play(time?: number, offset?: number, length?: number): void;
  99107. private _onended;
  99108. /**
  99109. * Stop the sound
  99110. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  99111. */
  99112. stop(time?: number): void;
  99113. /**
  99114. * Put the sound in pause
  99115. */
  99116. pause(): void;
  99117. /**
  99118. * Sets a dedicated volume for this sounds
  99119. * @param newVolume Define the new volume of the sound
  99120. * @param time Define time for gradual change to new volume
  99121. */
  99122. setVolume(newVolume: number, time?: number): void;
  99123. /**
  99124. * Set the sound play back rate
  99125. * @param newPlaybackRate Define the playback rate the sound should be played at
  99126. */
  99127. setPlaybackRate(newPlaybackRate: number): void;
  99128. /**
  99129. * Gets the volume of the sound.
  99130. * @returns the volume of the sound
  99131. */
  99132. getVolume(): number;
  99133. /**
  99134. * Attach the sound to a dedicated mesh
  99135. * @param transformNode The transform node to connect the sound with
  99136. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  99137. */
  99138. attachToMesh(transformNode: TransformNode): void;
  99139. /**
  99140. * Detach the sound from the previously attached mesh
  99141. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  99142. */
  99143. detachFromMesh(): void;
  99144. private _onRegisterAfterWorldMatrixUpdate;
  99145. /**
  99146. * Clone the current sound in the scene.
  99147. * @returns the new sound clone
  99148. */
  99149. clone(): Nullable<Sound>;
  99150. /**
  99151. * Gets the current underlying audio buffer containing the data
  99152. * @returns the audio buffer
  99153. */
  99154. getAudioBuffer(): Nullable<AudioBuffer>;
  99155. /**
  99156. * Serializes the Sound in a JSON representation
  99157. * @returns the JSON representation of the sound
  99158. */
  99159. serialize(): any;
  99160. /**
  99161. * Parse a JSON representation of a sound to innstantiate in a given scene
  99162. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  99163. * @param scene Define the scene the new parsed sound should be created in
  99164. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  99165. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  99166. * @returns the newly parsed sound
  99167. */
  99168. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  99169. }
  99170. }
  99171. declare module BABYLON {
  99172. /**
  99173. * This defines an action helpful to play a defined sound on a triggered action.
  99174. */
  99175. export class PlaySoundAction extends Action {
  99176. private _sound;
  99177. /**
  99178. * Instantiate the action
  99179. * @param triggerOptions defines the trigger options
  99180. * @param sound defines the sound to play
  99181. * @param condition defines the trigger related conditions
  99182. */
  99183. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  99184. /** @hidden */
  99185. _prepare(): void;
  99186. /**
  99187. * Execute the action and play the sound.
  99188. */
  99189. execute(): void;
  99190. /**
  99191. * Serializes the actions and its related information.
  99192. * @param parent defines the object to serialize in
  99193. * @returns the serialized object
  99194. */
  99195. serialize(parent: any): any;
  99196. }
  99197. /**
  99198. * This defines an action helpful to stop a defined sound on a triggered action.
  99199. */
  99200. export class StopSoundAction extends Action {
  99201. private _sound;
  99202. /**
  99203. * Instantiate the action
  99204. * @param triggerOptions defines the trigger options
  99205. * @param sound defines the sound to stop
  99206. * @param condition defines the trigger related conditions
  99207. */
  99208. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  99209. /** @hidden */
  99210. _prepare(): void;
  99211. /**
  99212. * Execute the action and stop the sound.
  99213. */
  99214. execute(): void;
  99215. /**
  99216. * Serializes the actions and its related information.
  99217. * @param parent defines the object to serialize in
  99218. * @returns the serialized object
  99219. */
  99220. serialize(parent: any): any;
  99221. }
  99222. }
  99223. declare module BABYLON {
  99224. /**
  99225. * This defines an action responsible to change the value of a property
  99226. * by interpolating between its current value and the newly set one once triggered.
  99227. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  99228. */
  99229. export class InterpolateValueAction extends Action {
  99230. /**
  99231. * Defines the path of the property where the value should be interpolated
  99232. */
  99233. propertyPath: string;
  99234. /**
  99235. * Defines the target value at the end of the interpolation.
  99236. */
  99237. value: any;
  99238. /**
  99239. * Defines the time it will take for the property to interpolate to the value.
  99240. */
  99241. duration: number;
  99242. /**
  99243. * Defines if the other scene animations should be stopped when the action has been triggered
  99244. */
  99245. stopOtherAnimations?: boolean;
  99246. /**
  99247. * Defines a callback raised once the interpolation animation has been done.
  99248. */
  99249. onInterpolationDone?: () => void;
  99250. /**
  99251. * Observable triggered once the interpolation animation has been done.
  99252. */
  99253. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  99254. private _target;
  99255. private _effectiveTarget;
  99256. private _property;
  99257. /**
  99258. * Instantiate the action
  99259. * @param triggerOptions defines the trigger options
  99260. * @param target defines the object containing the value to interpolate
  99261. * @param propertyPath defines the path to the property in the target object
  99262. * @param value defines the target value at the end of the interpolation
  99263. * @param duration deines the time it will take for the property to interpolate to the value.
  99264. * @param condition defines the trigger related conditions
  99265. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  99266. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  99267. */
  99268. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  99269. /** @hidden */
  99270. _prepare(): void;
  99271. /**
  99272. * Execute the action starts the value interpolation.
  99273. */
  99274. execute(): void;
  99275. /**
  99276. * Serializes the actions and its related information.
  99277. * @param parent defines the object to serialize in
  99278. * @returns the serialized object
  99279. */
  99280. serialize(parent: any): any;
  99281. }
  99282. }
  99283. declare module BABYLON {
  99284. /**
  99285. * Options allowed during the creation of a sound track.
  99286. */
  99287. export interface ISoundTrackOptions {
  99288. /**
  99289. * The volume the sound track should take during creation
  99290. */
  99291. volume?: number;
  99292. /**
  99293. * Define if the sound track is the main sound track of the scene
  99294. */
  99295. mainTrack?: boolean;
  99296. }
  99297. /**
  99298. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  99299. * It will be also used in a future release to apply effects on a specific track.
  99300. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  99301. */
  99302. export class SoundTrack {
  99303. /**
  99304. * The unique identifier of the sound track in the scene.
  99305. */
  99306. id: number;
  99307. /**
  99308. * The list of sounds included in the sound track.
  99309. */
  99310. soundCollection: Array<Sound>;
  99311. private _outputAudioNode;
  99312. private _scene;
  99313. private _isMainTrack;
  99314. private _connectedAnalyser;
  99315. private _options;
  99316. private _isInitialized;
  99317. /**
  99318. * Creates a new sound track.
  99319. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  99320. * @param scene Define the scene the sound track belongs to
  99321. * @param options
  99322. */
  99323. constructor(scene: Scene, options?: ISoundTrackOptions);
  99324. private _initializeSoundTrackAudioGraph;
  99325. /**
  99326. * Release the sound track and its associated resources
  99327. */
  99328. dispose(): void;
  99329. /**
  99330. * Adds a sound to this sound track
  99331. * @param sound define the cound to add
  99332. * @ignoreNaming
  99333. */
  99334. AddSound(sound: Sound): void;
  99335. /**
  99336. * Removes a sound to this sound track
  99337. * @param sound define the cound to remove
  99338. * @ignoreNaming
  99339. */
  99340. RemoveSound(sound: Sound): void;
  99341. /**
  99342. * Set a global volume for the full sound track.
  99343. * @param newVolume Define the new volume of the sound track
  99344. */
  99345. setVolume(newVolume: number): void;
  99346. /**
  99347. * Switch the panning model to HRTF:
  99348. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  99349. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  99350. */
  99351. switchPanningModelToHRTF(): void;
  99352. /**
  99353. * Switch the panning model to Equal Power:
  99354. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  99355. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  99356. */
  99357. switchPanningModelToEqualPower(): void;
  99358. /**
  99359. * Connect the sound track to an audio analyser allowing some amazing
  99360. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  99361. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  99362. * @param analyser The analyser to connect to the engine
  99363. */
  99364. connectToAnalyser(analyser: Analyser): void;
  99365. }
  99366. }
  99367. declare module BABYLON {
  99368. interface AbstractScene {
  99369. /**
  99370. * The list of sounds used in the scene.
  99371. */
  99372. sounds: Nullable<Array<Sound>>;
  99373. }
  99374. interface Scene {
  99375. /**
  99376. * @hidden
  99377. * Backing field
  99378. */
  99379. _mainSoundTrack: SoundTrack;
  99380. /**
  99381. * The main sound track played by the scene.
  99382. * It cotains your primary collection of sounds.
  99383. */
  99384. mainSoundTrack: SoundTrack;
  99385. /**
  99386. * The list of sound tracks added to the scene
  99387. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99388. */
  99389. soundTracks: Nullable<Array<SoundTrack>>;
  99390. /**
  99391. * Gets a sound using a given name
  99392. * @param name defines the name to search for
  99393. * @return the found sound or null if not found at all.
  99394. */
  99395. getSoundByName(name: string): Nullable<Sound>;
  99396. /**
  99397. * Gets or sets if audio support is enabled
  99398. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99399. */
  99400. audioEnabled: boolean;
  99401. /**
  99402. * Gets or sets if audio will be output to headphones
  99403. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99404. */
  99405. headphone: boolean;
  99406. }
  99407. /**
  99408. * Defines the sound scene component responsible to manage any sounds
  99409. * in a given scene.
  99410. */
  99411. export class AudioSceneComponent implements ISceneSerializableComponent {
  99412. /**
  99413. * The component name helpfull to identify the component in the list of scene components.
  99414. */
  99415. readonly name: string;
  99416. /**
  99417. * The scene the component belongs to.
  99418. */
  99419. scene: Scene;
  99420. private _audioEnabled;
  99421. /**
  99422. * Gets whether audio is enabled or not.
  99423. * Please use related enable/disable method to switch state.
  99424. */
  99425. readonly audioEnabled: boolean;
  99426. private _headphone;
  99427. /**
  99428. * Gets whether audio is outputing to headphone or not.
  99429. * Please use the according Switch methods to change output.
  99430. */
  99431. readonly headphone: boolean;
  99432. /**
  99433. * Creates a new instance of the component for the given scene
  99434. * @param scene Defines the scene to register the component in
  99435. */
  99436. constructor(scene: Scene);
  99437. /**
  99438. * Registers the component in a given scene
  99439. */
  99440. register(): void;
  99441. /**
  99442. * Rebuilds the elements related to this component in case of
  99443. * context lost for instance.
  99444. */
  99445. rebuild(): void;
  99446. /**
  99447. * Serializes the component data to the specified json object
  99448. * @param serializationObject The object to serialize to
  99449. */
  99450. serialize(serializationObject: any): void;
  99451. /**
  99452. * Adds all the elements from the container to the scene
  99453. * @param container the container holding the elements
  99454. */
  99455. addFromContainer(container: AbstractScene): void;
  99456. /**
  99457. * Removes all the elements in the container from the scene
  99458. * @param container contains the elements to remove
  99459. * @param dispose if the removed element should be disposed (default: false)
  99460. */
  99461. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  99462. /**
  99463. * Disposes the component and the associated ressources.
  99464. */
  99465. dispose(): void;
  99466. /**
  99467. * Disables audio in the associated scene.
  99468. */
  99469. disableAudio(): void;
  99470. /**
  99471. * Enables audio in the associated scene.
  99472. */
  99473. enableAudio(): void;
  99474. /**
  99475. * Switch audio to headphone output.
  99476. */
  99477. switchAudioModeForHeadphones(): void;
  99478. /**
  99479. * Switch audio to normal speakers.
  99480. */
  99481. switchAudioModeForNormalSpeakers(): void;
  99482. private _afterRender;
  99483. }
  99484. }
  99485. declare module BABYLON {
  99486. /**
  99487. * Wraps one or more Sound objects and selects one with random weight for playback.
  99488. */
  99489. export class WeightedSound {
  99490. /** When true a Sound will be selected and played when the current playing Sound completes. */
  99491. loop: boolean;
  99492. private _coneInnerAngle;
  99493. private _coneOuterAngle;
  99494. private _volume;
  99495. /** A Sound is currently playing. */
  99496. isPlaying: boolean;
  99497. /** A Sound is currently paused. */
  99498. isPaused: boolean;
  99499. private _sounds;
  99500. private _weights;
  99501. private _currentIndex?;
  99502. /**
  99503. * Creates a new WeightedSound from the list of sounds given.
  99504. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  99505. * @param sounds Array of Sounds that will be selected from.
  99506. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  99507. */
  99508. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  99509. /**
  99510. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  99511. */
  99512. /**
  99513. * The size of cone in degress for a directional sound in which there will be no attenuation.
  99514. */
  99515. directionalConeInnerAngle: number;
  99516. /**
  99517. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  99518. * Listener angles between innerAngle and outerAngle will falloff linearly.
  99519. */
  99520. /**
  99521. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  99522. * Listener angles between innerAngle and outerAngle will falloff linearly.
  99523. */
  99524. directionalConeOuterAngle: number;
  99525. /**
  99526. * Playback volume.
  99527. */
  99528. /**
  99529. * Playback volume.
  99530. */
  99531. volume: number;
  99532. private _onended;
  99533. /**
  99534. * Suspend playback
  99535. */
  99536. pause(): void;
  99537. /**
  99538. * Stop playback
  99539. */
  99540. stop(): void;
  99541. /**
  99542. * Start playback.
  99543. * @param startOffset Position the clip head at a specific time in seconds.
  99544. */
  99545. play(startOffset?: number): void;
  99546. }
  99547. }
  99548. declare module BABYLON {
  99549. /**
  99550. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  99551. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  99552. */
  99553. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  99554. /**
  99555. * Gets the name of the behavior.
  99556. */
  99557. readonly name: string;
  99558. /**
  99559. * The easing function used by animations
  99560. */
  99561. static EasingFunction: BackEase;
  99562. /**
  99563. * The easing mode used by animations
  99564. */
  99565. static EasingMode: number;
  99566. /**
  99567. * The duration of the animation, in milliseconds
  99568. */
  99569. transitionDuration: number;
  99570. /**
  99571. * Length of the distance animated by the transition when lower radius is reached
  99572. */
  99573. lowerRadiusTransitionRange: number;
  99574. /**
  99575. * Length of the distance animated by the transition when upper radius is reached
  99576. */
  99577. upperRadiusTransitionRange: number;
  99578. private _autoTransitionRange;
  99579. /**
  99580. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  99581. */
  99582. /**
  99583. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  99584. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  99585. */
  99586. autoTransitionRange: boolean;
  99587. private _attachedCamera;
  99588. private _onAfterCheckInputsObserver;
  99589. private _onMeshTargetChangedObserver;
  99590. /**
  99591. * Initializes the behavior.
  99592. */
  99593. init(): void;
  99594. /**
  99595. * Attaches the behavior to its arc rotate camera.
  99596. * @param camera Defines the camera to attach the behavior to
  99597. */
  99598. attach(camera: ArcRotateCamera): void;
  99599. /**
  99600. * Detaches the behavior from its current arc rotate camera.
  99601. */
  99602. detach(): void;
  99603. private _radiusIsAnimating;
  99604. private _radiusBounceTransition;
  99605. private _animatables;
  99606. private _cachedWheelPrecision;
  99607. /**
  99608. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  99609. * @param radiusLimit The limit to check against.
  99610. * @return Bool to indicate if at limit.
  99611. */
  99612. private _isRadiusAtLimit;
  99613. /**
  99614. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  99615. * @param radiusDelta The delta by which to animate to. Can be negative.
  99616. */
  99617. private _applyBoundRadiusAnimation;
  99618. /**
  99619. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  99620. */
  99621. protected _clearAnimationLocks(): void;
  99622. /**
  99623. * Stops and removes all animations that have been applied to the camera
  99624. */
  99625. stopAllAnimations(): void;
  99626. }
  99627. }
  99628. declare module BABYLON {
  99629. /**
  99630. * 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.
  99631. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  99632. */
  99633. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  99634. /**
  99635. * Gets the name of the behavior.
  99636. */
  99637. readonly name: string;
  99638. private _mode;
  99639. private _radiusScale;
  99640. private _positionScale;
  99641. private _defaultElevation;
  99642. private _elevationReturnTime;
  99643. private _elevationReturnWaitTime;
  99644. private _zoomStopsAnimation;
  99645. private _framingTime;
  99646. /**
  99647. * The easing function used by animations
  99648. */
  99649. static EasingFunction: ExponentialEase;
  99650. /**
  99651. * The easing mode used by animations
  99652. */
  99653. static EasingMode: number;
  99654. /**
  99655. * Sets the current mode used by the behavior
  99656. */
  99657. /**
  99658. * Gets current mode used by the behavior.
  99659. */
  99660. mode: number;
  99661. /**
  99662. * Sets the scale applied to the radius (1 by default)
  99663. */
  99664. /**
  99665. * Gets the scale applied to the radius
  99666. */
  99667. radiusScale: number;
  99668. /**
  99669. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  99670. */
  99671. /**
  99672. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  99673. */
  99674. positionScale: number;
  99675. /**
  99676. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  99677. * behaviour is triggered, in radians.
  99678. */
  99679. /**
  99680. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  99681. * behaviour is triggered, in radians.
  99682. */
  99683. defaultElevation: number;
  99684. /**
  99685. * Sets the time (in milliseconds) taken to return to the default beta position.
  99686. * Negative value indicates camera should not return to default.
  99687. */
  99688. /**
  99689. * Gets the time (in milliseconds) taken to return to the default beta position.
  99690. * Negative value indicates camera should not return to default.
  99691. */
  99692. elevationReturnTime: number;
  99693. /**
  99694. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  99695. */
  99696. /**
  99697. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  99698. */
  99699. elevationReturnWaitTime: number;
  99700. /**
  99701. * Sets the flag that indicates if user zooming should stop animation.
  99702. */
  99703. /**
  99704. * Gets the flag that indicates if user zooming should stop animation.
  99705. */
  99706. zoomStopsAnimation: boolean;
  99707. /**
  99708. * Sets the transition time when framing the mesh, in milliseconds
  99709. */
  99710. /**
  99711. * Gets the transition time when framing the mesh, in milliseconds
  99712. */
  99713. framingTime: number;
  99714. /**
  99715. * Define if the behavior should automatically change the configured
  99716. * camera limits and sensibilities.
  99717. */
  99718. autoCorrectCameraLimitsAndSensibility: boolean;
  99719. private _onPrePointerObservableObserver;
  99720. private _onAfterCheckInputsObserver;
  99721. private _onMeshTargetChangedObserver;
  99722. private _attachedCamera;
  99723. private _isPointerDown;
  99724. private _lastInteractionTime;
  99725. /**
  99726. * Initializes the behavior.
  99727. */
  99728. init(): void;
  99729. /**
  99730. * Attaches the behavior to its arc rotate camera.
  99731. * @param camera Defines the camera to attach the behavior to
  99732. */
  99733. attach(camera: ArcRotateCamera): void;
  99734. /**
  99735. * Detaches the behavior from its current arc rotate camera.
  99736. */
  99737. detach(): void;
  99738. private _animatables;
  99739. private _betaIsAnimating;
  99740. private _betaTransition;
  99741. private _radiusTransition;
  99742. private _vectorTransition;
  99743. /**
  99744. * Targets the given mesh and updates zoom level accordingly.
  99745. * @param mesh The mesh to target.
  99746. * @param radius Optional. If a cached radius position already exists, overrides default.
  99747. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  99748. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  99749. * @param onAnimationEnd Callback triggered at the end of the framing animation
  99750. */
  99751. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  99752. /**
  99753. * Targets the given mesh with its children and updates zoom level accordingly.
  99754. * @param mesh The mesh to target.
  99755. * @param radius Optional. If a cached radius position already exists, overrides default.
  99756. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  99757. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  99758. * @param onAnimationEnd Callback triggered at the end of the framing animation
  99759. */
  99760. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  99761. /**
  99762. * Targets the given meshes with their children and updates zoom level accordingly.
  99763. * @param meshes The mesh to target.
  99764. * @param radius Optional. If a cached radius position already exists, overrides default.
  99765. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  99766. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  99767. * @param onAnimationEnd Callback triggered at the end of the framing animation
  99768. */
  99769. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  99770. /**
  99771. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  99772. * @param minimumWorld Determines the smaller position of the bounding box extend
  99773. * @param maximumWorld Determines the bigger position of the bounding box extend
  99774. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  99775. * @param onAnimationEnd Callback triggered at the end of the framing animation
  99776. */
  99777. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  99778. /**
  99779. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  99780. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  99781. * frustum width.
  99782. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  99783. * to fully enclose the mesh in the viewing frustum.
  99784. */
  99785. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  99786. /**
  99787. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  99788. * is automatically returned to its default position (expected to be above ground plane).
  99789. */
  99790. private _maintainCameraAboveGround;
  99791. /**
  99792. * Returns the frustum slope based on the canvas ratio and camera FOV
  99793. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  99794. */
  99795. private _getFrustumSlope;
  99796. /**
  99797. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  99798. */
  99799. private _clearAnimationLocks;
  99800. /**
  99801. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  99802. */
  99803. private _applyUserInteraction;
  99804. /**
  99805. * Stops and removes all animations that have been applied to the camera
  99806. */
  99807. stopAllAnimations(): void;
  99808. /**
  99809. * Gets a value indicating if the user is moving the camera
  99810. */
  99811. readonly isUserIsMoving: boolean;
  99812. /**
  99813. * The camera can move all the way towards the mesh.
  99814. */
  99815. static IgnoreBoundsSizeMode: number;
  99816. /**
  99817. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  99818. */
  99819. static FitFrustumSidesMode: number;
  99820. }
  99821. }
  99822. declare module BABYLON {
  99823. /**
  99824. * Base class for Camera Pointer Inputs.
  99825. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  99826. * for example usage.
  99827. */
  99828. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  99829. /**
  99830. * Defines the camera the input is attached to.
  99831. */
  99832. abstract camera: Camera;
  99833. /**
  99834. * Whether keyboard modifier keys are pressed at time of last mouse event.
  99835. */
  99836. protected _altKey: boolean;
  99837. protected _ctrlKey: boolean;
  99838. protected _metaKey: boolean;
  99839. protected _shiftKey: boolean;
  99840. /**
  99841. * Which mouse buttons were pressed at time of last mouse event.
  99842. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  99843. */
  99844. protected _buttonsPressed: number;
  99845. /**
  99846. * Defines the buttons associated with the input to handle camera move.
  99847. */
  99848. buttons: number[];
  99849. /**
  99850. * Attach the input controls to a specific dom element to get the input from.
  99851. * @param element Defines the element the controls should be listened from
  99852. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99853. */
  99854. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99855. /**
  99856. * Detach the current controls from the specified dom element.
  99857. * @param element Defines the element to stop listening the inputs from
  99858. */
  99859. detachControl(element: Nullable<HTMLElement>): void;
  99860. /**
  99861. * Gets the class name of the current input.
  99862. * @returns the class name
  99863. */
  99864. getClassName(): string;
  99865. /**
  99866. * Get the friendly name associated with the input class.
  99867. * @returns the input friendly name
  99868. */
  99869. getSimpleName(): string;
  99870. /**
  99871. * Called on pointer POINTERDOUBLETAP event.
  99872. * Override this method to provide functionality on POINTERDOUBLETAP event.
  99873. */
  99874. protected onDoubleTap(type: string): void;
  99875. /**
  99876. * Called on pointer POINTERMOVE event if only a single touch is active.
  99877. * Override this method to provide functionality.
  99878. */
  99879. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  99880. /**
  99881. * Called on pointer POINTERMOVE event if multiple touches are active.
  99882. * Override this method to provide functionality.
  99883. */
  99884. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  99885. /**
  99886. * Called on JS contextmenu event.
  99887. * Override this method to provide functionality.
  99888. */
  99889. protected onContextMenu(evt: PointerEvent): void;
  99890. /**
  99891. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  99892. * press.
  99893. * Override this method to provide functionality.
  99894. */
  99895. protected onButtonDown(evt: PointerEvent): void;
  99896. /**
  99897. * Called each time a new POINTERUP event occurs. Ie, for each button
  99898. * release.
  99899. * Override this method to provide functionality.
  99900. */
  99901. protected onButtonUp(evt: PointerEvent): void;
  99902. /**
  99903. * Called when window becomes inactive.
  99904. * Override this method to provide functionality.
  99905. */
  99906. protected onLostFocus(): void;
  99907. private _pointerInput;
  99908. private _observer;
  99909. private _onLostFocus;
  99910. private pointA;
  99911. private pointB;
  99912. }
  99913. }
  99914. declare module BABYLON {
  99915. /**
  99916. * Manage the pointers inputs to control an arc rotate camera.
  99917. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  99918. */
  99919. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  99920. /**
  99921. * Defines the camera the input is attached to.
  99922. */
  99923. camera: ArcRotateCamera;
  99924. /**
  99925. * Gets the class name of the current input.
  99926. * @returns the class name
  99927. */
  99928. getClassName(): string;
  99929. /**
  99930. * Defines the buttons associated with the input to handle camera move.
  99931. */
  99932. buttons: number[];
  99933. /**
  99934. * Defines the pointer angular sensibility along the X axis or how fast is
  99935. * the camera rotating.
  99936. */
  99937. angularSensibilityX: number;
  99938. /**
  99939. * Defines the pointer angular sensibility along the Y axis or how fast is
  99940. * the camera rotating.
  99941. */
  99942. angularSensibilityY: number;
  99943. /**
  99944. * Defines the pointer pinch precision or how fast is the camera zooming.
  99945. */
  99946. pinchPrecision: number;
  99947. /**
  99948. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  99949. * from 0.
  99950. * It defines the percentage of current camera.radius to use as delta when
  99951. * pinch zoom is used.
  99952. */
  99953. pinchDeltaPercentage: number;
  99954. /**
  99955. * Defines the pointer panning sensibility or how fast is the camera moving.
  99956. */
  99957. panningSensibility: number;
  99958. /**
  99959. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  99960. */
  99961. multiTouchPanning: boolean;
  99962. /**
  99963. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  99964. * zoom (pinch) through multitouch.
  99965. */
  99966. multiTouchPanAndZoom: boolean;
  99967. /**
  99968. * Revers pinch action direction.
  99969. */
  99970. pinchInwards: boolean;
  99971. private _isPanClick;
  99972. private _twoFingerActivityCount;
  99973. private _isPinching;
  99974. /**
  99975. * Called on pointer POINTERMOVE event if only a single touch is active.
  99976. */
  99977. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  99978. /**
  99979. * Called on pointer POINTERDOUBLETAP event.
  99980. */
  99981. protected onDoubleTap(type: string): void;
  99982. /**
  99983. * Called on pointer POINTERMOVE event if multiple touches are active.
  99984. */
  99985. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  99986. /**
  99987. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  99988. * press.
  99989. */
  99990. protected onButtonDown(evt: PointerEvent): void;
  99991. /**
  99992. * Called each time a new POINTERUP event occurs. Ie, for each button
  99993. * release.
  99994. */
  99995. protected onButtonUp(evt: PointerEvent): void;
  99996. /**
  99997. * Called when window becomes inactive.
  99998. */
  99999. protected onLostFocus(): void;
  100000. }
  100001. }
  100002. declare module BABYLON {
  100003. /**
  100004. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  100005. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  100006. */
  100007. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  100008. /**
  100009. * Defines the camera the input is attached to.
  100010. */
  100011. camera: ArcRotateCamera;
  100012. /**
  100013. * Defines the list of key codes associated with the up action (increase alpha)
  100014. */
  100015. keysUp: number[];
  100016. /**
  100017. * Defines the list of key codes associated with the down action (decrease alpha)
  100018. */
  100019. keysDown: number[];
  100020. /**
  100021. * Defines the list of key codes associated with the left action (increase beta)
  100022. */
  100023. keysLeft: number[];
  100024. /**
  100025. * Defines the list of key codes associated with the right action (decrease beta)
  100026. */
  100027. keysRight: number[];
  100028. /**
  100029. * Defines the list of key codes associated with the reset action.
  100030. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  100031. */
  100032. keysReset: number[];
  100033. /**
  100034. * Defines the panning sensibility of the inputs.
  100035. * (How fast is the camera paning)
  100036. */
  100037. panningSensibility: number;
  100038. /**
  100039. * Defines the zooming sensibility of the inputs.
  100040. * (How fast is the camera zooming)
  100041. */
  100042. zoomingSensibility: number;
  100043. /**
  100044. * Defines wether maintaining the alt key down switch the movement mode from
  100045. * orientation to zoom.
  100046. */
  100047. useAltToZoom: boolean;
  100048. /**
  100049. * Rotation speed of the camera
  100050. */
  100051. angularSpeed: number;
  100052. private _keys;
  100053. private _ctrlPressed;
  100054. private _altPressed;
  100055. private _onCanvasBlurObserver;
  100056. private _onKeyboardObserver;
  100057. private _engine;
  100058. private _scene;
  100059. /**
  100060. * Attach the input controls to a specific dom element to get the input from.
  100061. * @param element Defines the element the controls should be listened from
  100062. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  100063. */
  100064. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  100065. /**
  100066. * Detach the current controls from the specified dom element.
  100067. * @param element Defines the element to stop listening the inputs from
  100068. */
  100069. detachControl(element: Nullable<HTMLElement>): void;
  100070. /**
  100071. * Update the current camera state depending on the inputs that have been used this frame.
  100072. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  100073. */
  100074. checkInputs(): void;
  100075. /**
  100076. * Gets the class name of the current intput.
  100077. * @returns the class name
  100078. */
  100079. getClassName(): string;
  100080. /**
  100081. * Get the friendly name associated with the input class.
  100082. * @returns the input friendly name
  100083. */
  100084. getSimpleName(): string;
  100085. }
  100086. }
  100087. declare module BABYLON {
  100088. /**
  100089. * Manage the mouse wheel inputs to control an arc rotate camera.
  100090. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  100091. */
  100092. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  100093. /**
  100094. * Defines the camera the input is attached to.
  100095. */
  100096. camera: ArcRotateCamera;
  100097. /**
  100098. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  100099. */
  100100. wheelPrecision: number;
  100101. /**
  100102. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  100103. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  100104. */
  100105. wheelDeltaPercentage: number;
  100106. private _wheel;
  100107. private _observer;
  100108. private computeDeltaFromMouseWheelLegacyEvent;
  100109. /**
  100110. * Attach the input controls to a specific dom element to get the input from.
  100111. * @param element Defines the element the controls should be listened from
  100112. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  100113. */
  100114. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  100115. /**
  100116. * Detach the current controls from the specified dom element.
  100117. * @param element Defines the element to stop listening the inputs from
  100118. */
  100119. detachControl(element: Nullable<HTMLElement>): void;
  100120. /**
  100121. * Gets the class name of the current intput.
  100122. * @returns the class name
  100123. */
  100124. getClassName(): string;
  100125. /**
  100126. * Get the friendly name associated with the input class.
  100127. * @returns the input friendly name
  100128. */
  100129. getSimpleName(): string;
  100130. }
  100131. }
  100132. declare module BABYLON {
  100133. /**
  100134. * Default Inputs manager for the ArcRotateCamera.
  100135. * It groups all the default supported inputs for ease of use.
  100136. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  100137. */
  100138. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  100139. /**
  100140. * Instantiates a new ArcRotateCameraInputsManager.
  100141. * @param camera Defines the camera the inputs belong to
  100142. */
  100143. constructor(camera: ArcRotateCamera);
  100144. /**
  100145. * Add mouse wheel input support to the input manager.
  100146. * @returns the current input manager
  100147. */
  100148. addMouseWheel(): ArcRotateCameraInputsManager;
  100149. /**
  100150. * Add pointers input support to the input manager.
  100151. * @returns the current input manager
  100152. */
  100153. addPointers(): ArcRotateCameraInputsManager;
  100154. /**
  100155. * Add keyboard input support to the input manager.
  100156. * @returns the current input manager
  100157. */
  100158. addKeyboard(): ArcRotateCameraInputsManager;
  100159. }
  100160. }
  100161. declare module BABYLON {
  100162. /**
  100163. * This represents an orbital type of camera.
  100164. *
  100165. * 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.
  100166. * 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.
  100167. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  100168. */
  100169. export class ArcRotateCamera extends TargetCamera {
  100170. /**
  100171. * Defines the rotation angle of the camera along the longitudinal axis.
  100172. */
  100173. alpha: number;
  100174. /**
  100175. * Defines the rotation angle of the camera along the latitudinal axis.
  100176. */
  100177. beta: number;
  100178. /**
  100179. * Defines the radius of the camera from it s target point.
  100180. */
  100181. radius: number;
  100182. protected _target: Vector3;
  100183. protected _targetHost: Nullable<AbstractMesh>;
  100184. /**
  100185. * Defines the target point of the camera.
  100186. * The camera looks towards it form the radius distance.
  100187. */
  100188. target: Vector3;
  100189. /**
  100190. * Define the current local position of the camera in the scene
  100191. */
  100192. position: Vector3;
  100193. protected _upVector: Vector3;
  100194. protected _upToYMatrix: Matrix;
  100195. protected _YToUpMatrix: Matrix;
  100196. /**
  100197. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  100198. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  100199. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  100200. */
  100201. upVector: Vector3;
  100202. /**
  100203. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  100204. */
  100205. setMatUp(): void;
  100206. /**
  100207. * Current inertia value on the longitudinal axis.
  100208. * The bigger this number the longer it will take for the camera to stop.
  100209. */
  100210. inertialAlphaOffset: number;
  100211. /**
  100212. * Current inertia value on the latitudinal axis.
  100213. * The bigger this number the longer it will take for the camera to stop.
  100214. */
  100215. inertialBetaOffset: number;
  100216. /**
  100217. * Current inertia value on the radius axis.
  100218. * The bigger this number the longer it will take for the camera to stop.
  100219. */
  100220. inertialRadiusOffset: number;
  100221. /**
  100222. * Minimum allowed angle on the longitudinal axis.
  100223. * This can help limiting how the Camera is able to move in the scene.
  100224. */
  100225. lowerAlphaLimit: Nullable<number>;
  100226. /**
  100227. * Maximum allowed angle on the longitudinal axis.
  100228. * This can help limiting how the Camera is able to move in the scene.
  100229. */
  100230. upperAlphaLimit: Nullable<number>;
  100231. /**
  100232. * Minimum allowed angle on the latitudinal axis.
  100233. * This can help limiting how the Camera is able to move in the scene.
  100234. */
  100235. lowerBetaLimit: number;
  100236. /**
  100237. * Maximum allowed angle on the latitudinal axis.
  100238. * This can help limiting how the Camera is able to move in the scene.
  100239. */
  100240. upperBetaLimit: number;
  100241. /**
  100242. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  100243. * This can help limiting how the Camera is able to move in the scene.
  100244. */
  100245. lowerRadiusLimit: Nullable<number>;
  100246. /**
  100247. * Maximum allowed distance of the camera to the target (The camera can not get further).
  100248. * This can help limiting how the Camera is able to move in the scene.
  100249. */
  100250. upperRadiusLimit: Nullable<number>;
  100251. /**
  100252. * Defines the current inertia value used during panning of the camera along the X axis.
  100253. */
  100254. inertialPanningX: number;
  100255. /**
  100256. * Defines the current inertia value used during panning of the camera along the Y axis.
  100257. */
  100258. inertialPanningY: number;
  100259. /**
  100260. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  100261. * Basically if your fingers moves away from more than this distance you will be considered
  100262. * in pinch mode.
  100263. */
  100264. pinchToPanMaxDistance: number;
  100265. /**
  100266. * Defines the maximum distance the camera can pan.
  100267. * This could help keeping the cammera always in your scene.
  100268. */
  100269. panningDistanceLimit: Nullable<number>;
  100270. /**
  100271. * Defines the target of the camera before paning.
  100272. */
  100273. panningOriginTarget: Vector3;
  100274. /**
  100275. * Defines the value of the inertia used during panning.
  100276. * 0 would mean stop inertia and one would mean no decelleration at all.
  100277. */
  100278. panningInertia: number;
  100279. /**
  100280. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  100281. */
  100282. angularSensibilityX: number;
  100283. /**
  100284. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  100285. */
  100286. angularSensibilityY: number;
  100287. /**
  100288. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  100289. */
  100290. pinchPrecision: number;
  100291. /**
  100292. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  100293. * It will be used instead of pinchDeltaPrecision if different from 0.
  100294. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  100295. */
  100296. pinchDeltaPercentage: number;
  100297. /**
  100298. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  100299. */
  100300. panningSensibility: number;
  100301. /**
  100302. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  100303. */
  100304. keysUp: number[];
  100305. /**
  100306. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  100307. */
  100308. keysDown: number[];
  100309. /**
  100310. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  100311. */
  100312. keysLeft: number[];
  100313. /**
  100314. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  100315. */
  100316. keysRight: number[];
  100317. /**
  100318. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  100319. */
  100320. wheelPrecision: number;
  100321. /**
  100322. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  100323. * It will be used instead of pinchDeltaPrecision if different from 0.
  100324. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  100325. */
  100326. wheelDeltaPercentage: number;
  100327. /**
  100328. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  100329. */
  100330. zoomOnFactor: number;
  100331. /**
  100332. * Defines a screen offset for the camera position.
  100333. */
  100334. targetScreenOffset: Vector2;
  100335. /**
  100336. * Allows the camera to be completely reversed.
  100337. * If false the camera can not arrive upside down.
  100338. */
  100339. allowUpsideDown: boolean;
  100340. /**
  100341. * Define if double tap/click is used to restore the previously saved state of the camera.
  100342. */
  100343. useInputToRestoreState: boolean;
  100344. /** @hidden */
  100345. _viewMatrix: Matrix;
  100346. /** @hidden */
  100347. _useCtrlForPanning: boolean;
  100348. /** @hidden */
  100349. _panningMouseButton: number;
  100350. /**
  100351. * Defines the input associated to the camera.
  100352. */
  100353. inputs: ArcRotateCameraInputsManager;
  100354. /** @hidden */
  100355. _reset: () => void;
  100356. /**
  100357. * Defines the allowed panning axis.
  100358. */
  100359. panningAxis: Vector3;
  100360. protected _localDirection: Vector3;
  100361. protected _transformedDirection: Vector3;
  100362. private _bouncingBehavior;
  100363. /**
  100364. * Gets the bouncing behavior of the camera if it has been enabled.
  100365. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  100366. */
  100367. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  100368. /**
  100369. * Defines if the bouncing behavior of the camera is enabled on the camera.
  100370. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  100371. */
  100372. useBouncingBehavior: boolean;
  100373. private _framingBehavior;
  100374. /**
  100375. * Gets the framing behavior of the camera if it has been enabled.
  100376. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  100377. */
  100378. readonly framingBehavior: Nullable<FramingBehavior>;
  100379. /**
  100380. * Defines if the framing behavior of the camera is enabled on the camera.
  100381. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  100382. */
  100383. useFramingBehavior: boolean;
  100384. private _autoRotationBehavior;
  100385. /**
  100386. * Gets the auto rotation behavior of the camera if it has been enabled.
  100387. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  100388. */
  100389. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  100390. /**
  100391. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  100392. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  100393. */
  100394. useAutoRotationBehavior: boolean;
  100395. /**
  100396. * Observable triggered when the mesh target has been changed on the camera.
  100397. */
  100398. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  100399. /**
  100400. * Event raised when the camera is colliding with a mesh.
  100401. */
  100402. onCollide: (collidedMesh: AbstractMesh) => void;
  100403. /**
  100404. * Defines whether the camera should check collision with the objects oh the scene.
  100405. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  100406. */
  100407. checkCollisions: boolean;
  100408. /**
  100409. * Defines the collision radius of the camera.
  100410. * This simulates a sphere around the camera.
  100411. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  100412. */
  100413. collisionRadius: Vector3;
  100414. protected _collider: Collider;
  100415. protected _previousPosition: Vector3;
  100416. protected _collisionVelocity: Vector3;
  100417. protected _newPosition: Vector3;
  100418. protected _previousAlpha: number;
  100419. protected _previousBeta: number;
  100420. protected _previousRadius: number;
  100421. protected _collisionTriggered: boolean;
  100422. protected _targetBoundingCenter: Nullable<Vector3>;
  100423. private _computationVector;
  100424. /**
  100425. * Instantiates a new ArcRotateCamera in a given scene
  100426. * @param name Defines the name of the camera
  100427. * @param alpha Defines the camera rotation along the logitudinal axis
  100428. * @param beta Defines the camera rotation along the latitudinal axis
  100429. * @param radius Defines the camera distance from its target
  100430. * @param target Defines the camera target
  100431. * @param scene Defines the scene the camera belongs to
  100432. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  100433. */
  100434. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  100435. /** @hidden */
  100436. _initCache(): void;
  100437. /** @hidden */
  100438. _updateCache(ignoreParentClass?: boolean): void;
  100439. protected _getTargetPosition(): Vector3;
  100440. private _storedAlpha;
  100441. private _storedBeta;
  100442. private _storedRadius;
  100443. private _storedTarget;
  100444. /**
  100445. * Stores the current state of the camera (alpha, beta, radius and target)
  100446. * @returns the camera itself
  100447. */
  100448. storeState(): Camera;
  100449. /**
  100450. * @hidden
  100451. * Restored camera state. You must call storeState() first
  100452. */
  100453. _restoreStateValues(): boolean;
  100454. /** @hidden */
  100455. _isSynchronizedViewMatrix(): boolean;
  100456. /**
  100457. * Attached controls to the current camera.
  100458. * @param element Defines the element the controls should be listened from
  100459. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  100460. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  100461. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  100462. */
  100463. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  100464. /**
  100465. * Detach the current controls from the camera.
  100466. * The camera will stop reacting to inputs.
  100467. * @param element Defines the element to stop listening the inputs from
  100468. */
  100469. detachControl(element: HTMLElement): void;
  100470. /** @hidden */
  100471. _checkInputs(): void;
  100472. protected _checkLimits(): void;
  100473. /**
  100474. * Rebuilds angles (alpha, beta) and radius from the give position and target
  100475. */
  100476. rebuildAnglesAndRadius(): void;
  100477. /**
  100478. * Use a position to define the current camera related information like aplha, beta and radius
  100479. * @param position Defines the position to set the camera at
  100480. */
  100481. setPosition(position: Vector3): void;
  100482. /**
  100483. * Defines the target the camera should look at.
  100484. * This will automatically adapt alpha beta and radius to fit within the new target.
  100485. * @param target Defines the new target as a Vector or a mesh
  100486. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  100487. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  100488. */
  100489. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  100490. /** @hidden */
  100491. _getViewMatrix(): Matrix;
  100492. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  100493. /**
  100494. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  100495. * @param meshes Defines the mesh to zoom on
  100496. * @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)
  100497. */
  100498. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  100499. /**
  100500. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  100501. * The target will be changed but the radius
  100502. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  100503. * @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)
  100504. */
  100505. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  100506. min: Vector3;
  100507. max: Vector3;
  100508. distance: number;
  100509. }, doNotUpdateMaxZ?: boolean): void;
  100510. /**
  100511. * @override
  100512. * Override Camera.createRigCamera
  100513. */
  100514. createRigCamera(name: string, cameraIndex: number): Camera;
  100515. /**
  100516. * @hidden
  100517. * @override
  100518. * Override Camera._updateRigCameras
  100519. */
  100520. _updateRigCameras(): void;
  100521. /**
  100522. * Destroy the camera and release the current resources hold by it.
  100523. */
  100524. dispose(): void;
  100525. /**
  100526. * Gets the current object class name.
  100527. * @return the class name
  100528. */
  100529. getClassName(): string;
  100530. }
  100531. }
  100532. declare module BABYLON {
  100533. /**
  100534. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  100535. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  100536. */
  100537. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  100538. /**
  100539. * Gets the name of the behavior.
  100540. */
  100541. readonly name: string;
  100542. private _zoomStopsAnimation;
  100543. private _idleRotationSpeed;
  100544. private _idleRotationWaitTime;
  100545. private _idleRotationSpinupTime;
  100546. /**
  100547. * Sets the flag that indicates if user zooming should stop animation.
  100548. */
  100549. /**
  100550. * Gets the flag that indicates if user zooming should stop animation.
  100551. */
  100552. zoomStopsAnimation: boolean;
  100553. /**
  100554. * Sets the default speed at which the camera rotates around the model.
  100555. */
  100556. /**
  100557. * Gets the default speed at which the camera rotates around the model.
  100558. */
  100559. idleRotationSpeed: number;
  100560. /**
  100561. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  100562. */
  100563. /**
  100564. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  100565. */
  100566. idleRotationWaitTime: number;
  100567. /**
  100568. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  100569. */
  100570. /**
  100571. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  100572. */
  100573. idleRotationSpinupTime: number;
  100574. /**
  100575. * Gets a value indicating if the camera is currently rotating because of this behavior
  100576. */
  100577. readonly rotationInProgress: boolean;
  100578. private _onPrePointerObservableObserver;
  100579. private _onAfterCheckInputsObserver;
  100580. private _attachedCamera;
  100581. private _isPointerDown;
  100582. private _lastFrameTime;
  100583. private _lastInteractionTime;
  100584. private _cameraRotationSpeed;
  100585. /**
  100586. * Initializes the behavior.
  100587. */
  100588. init(): void;
  100589. /**
  100590. * Attaches the behavior to its arc rotate camera.
  100591. * @param camera Defines the camera to attach the behavior to
  100592. */
  100593. attach(camera: ArcRotateCamera): void;
  100594. /**
  100595. * Detaches the behavior from its current arc rotate camera.
  100596. */
  100597. detach(): void;
  100598. /**
  100599. * Returns true if user is scrolling.
  100600. * @return true if user is scrolling.
  100601. */
  100602. private _userIsZooming;
  100603. private _lastFrameRadius;
  100604. private _shouldAnimationStopForInteraction;
  100605. /**
  100606. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  100607. */
  100608. private _applyUserInteraction;
  100609. private _userIsMoving;
  100610. }
  100611. }
  100612. declare module BABYLON {
  100613. /**
  100614. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  100615. */
  100616. export class AttachToBoxBehavior implements Behavior<Mesh> {
  100617. private ui;
  100618. /**
  100619. * The name of the behavior
  100620. */
  100621. name: string;
  100622. /**
  100623. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  100624. */
  100625. distanceAwayFromFace: number;
  100626. /**
  100627. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  100628. */
  100629. distanceAwayFromBottomOfFace: number;
  100630. private _faceVectors;
  100631. private _target;
  100632. private _scene;
  100633. private _onRenderObserver;
  100634. private _tmpMatrix;
  100635. private _tmpVector;
  100636. /**
  100637. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  100638. * @param ui The transform node that should be attched to the mesh
  100639. */
  100640. constructor(ui: TransformNode);
  100641. /**
  100642. * Initializes the behavior
  100643. */
  100644. init(): void;
  100645. private _closestFace;
  100646. private _zeroVector;
  100647. private _lookAtTmpMatrix;
  100648. private _lookAtToRef;
  100649. /**
  100650. * Attaches the AttachToBoxBehavior to the passed in mesh
  100651. * @param target The mesh that the specified node will be attached to
  100652. */
  100653. attach(target: Mesh): void;
  100654. /**
  100655. * Detaches the behavior from the mesh
  100656. */
  100657. detach(): void;
  100658. }
  100659. }
  100660. declare module BABYLON {
  100661. /**
  100662. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  100663. */
  100664. export class FadeInOutBehavior implements Behavior<Mesh> {
  100665. /**
  100666. * Time in milliseconds to delay before fading in (Default: 0)
  100667. */
  100668. delay: number;
  100669. /**
  100670. * Time in milliseconds for the mesh to fade in (Default: 300)
  100671. */
  100672. fadeInTime: number;
  100673. private _millisecondsPerFrame;
  100674. private _hovered;
  100675. private _hoverValue;
  100676. private _ownerNode;
  100677. /**
  100678. * Instatiates the FadeInOutBehavior
  100679. */
  100680. constructor();
  100681. /**
  100682. * The name of the behavior
  100683. */
  100684. readonly name: string;
  100685. /**
  100686. * Initializes the behavior
  100687. */
  100688. init(): void;
  100689. /**
  100690. * Attaches the fade behavior on the passed in mesh
  100691. * @param ownerNode The mesh that will be faded in/out once attached
  100692. */
  100693. attach(ownerNode: Mesh): void;
  100694. /**
  100695. * Detaches the behavior from the mesh
  100696. */
  100697. detach(): void;
  100698. /**
  100699. * Triggers the mesh to begin fading in or out
  100700. * @param value if the object should fade in or out (true to fade in)
  100701. */
  100702. fadeIn(value: boolean): void;
  100703. private _update;
  100704. private _setAllVisibility;
  100705. }
  100706. }
  100707. declare module BABYLON {
  100708. /**
  100709. * Class containing a set of static utilities functions for managing Pivots
  100710. * @hidden
  100711. */
  100712. export class PivotTools {
  100713. private static _PivotCached;
  100714. private static _OldPivotPoint;
  100715. private static _PivotTranslation;
  100716. private static _PivotTmpVector;
  100717. /** @hidden */
  100718. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  100719. /** @hidden */
  100720. static _RestorePivotPoint(mesh: AbstractMesh): void;
  100721. }
  100722. }
  100723. declare module BABYLON {
  100724. /**
  100725. * Class containing static functions to help procedurally build meshes
  100726. */
  100727. export class PlaneBuilder {
  100728. /**
  100729. * Creates a plane mesh
  100730. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  100731. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  100732. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  100733. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  100734. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  100735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  100736. * @param name defines the name of the mesh
  100737. * @param options defines the options used to create the mesh
  100738. * @param scene defines the hosting scene
  100739. * @returns the plane mesh
  100740. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  100741. */
  100742. static CreatePlane(name: string, options: {
  100743. size?: number;
  100744. width?: number;
  100745. height?: number;
  100746. sideOrientation?: number;
  100747. frontUVs?: Vector4;
  100748. backUVs?: Vector4;
  100749. updatable?: boolean;
  100750. sourcePlane?: Plane;
  100751. }, scene?: Nullable<Scene>): Mesh;
  100752. }
  100753. }
  100754. declare module BABYLON {
  100755. /**
  100756. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  100757. */
  100758. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  100759. private static _AnyMouseID;
  100760. /**
  100761. * Abstract mesh the behavior is set on
  100762. */
  100763. attachedNode: AbstractMesh;
  100764. private _dragPlane;
  100765. private _scene;
  100766. private _pointerObserver;
  100767. private _beforeRenderObserver;
  100768. private static _planeScene;
  100769. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  100770. /**
  100771. * 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)
  100772. */
  100773. maxDragAngle: number;
  100774. /**
  100775. * @hidden
  100776. */
  100777. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  100778. /**
  100779. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  100780. */
  100781. currentDraggingPointerID: number;
  100782. /**
  100783. * The last position where the pointer hit the drag plane in world space
  100784. */
  100785. lastDragPosition: Vector3;
  100786. /**
  100787. * If the behavior is currently in a dragging state
  100788. */
  100789. dragging: boolean;
  100790. /**
  100791. * 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)
  100792. */
  100793. dragDeltaRatio: number;
  100794. /**
  100795. * If the drag plane orientation should be updated during the dragging (Default: true)
  100796. */
  100797. updateDragPlane: boolean;
  100798. private _debugMode;
  100799. private _moving;
  100800. /**
  100801. * Fires each time the attached mesh is dragged with the pointer
  100802. * * delta between last drag position and current drag position in world space
  100803. * * dragDistance along the drag axis
  100804. * * dragPlaneNormal normal of the current drag plane used during the drag
  100805. * * dragPlanePoint in world space where the drag intersects the drag plane
  100806. */
  100807. onDragObservable: Observable<{
  100808. delta: Vector3;
  100809. dragPlanePoint: Vector3;
  100810. dragPlaneNormal: Vector3;
  100811. dragDistance: number;
  100812. pointerId: number;
  100813. }>;
  100814. /**
  100815. * Fires each time a drag begins (eg. mouse down on mesh)
  100816. */
  100817. onDragStartObservable: Observable<{
  100818. dragPlanePoint: Vector3;
  100819. pointerId: number;
  100820. }>;
  100821. /**
  100822. * Fires each time a drag ends (eg. mouse release after drag)
  100823. */
  100824. onDragEndObservable: Observable<{
  100825. dragPlanePoint: Vector3;
  100826. pointerId: number;
  100827. }>;
  100828. /**
  100829. * If the attached mesh should be moved when dragged
  100830. */
  100831. moveAttached: boolean;
  100832. /**
  100833. * If the drag behavior will react to drag events (Default: true)
  100834. */
  100835. enabled: boolean;
  100836. /**
  100837. * If pointer events should start and release the drag (Default: true)
  100838. */
  100839. startAndReleaseDragOnPointerEvents: boolean;
  100840. /**
  100841. * If camera controls should be detached during the drag
  100842. */
  100843. detachCameraControls: boolean;
  100844. /**
  100845. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  100846. */
  100847. useObjectOrienationForDragging: boolean;
  100848. private _options;
  100849. /**
  100850. * Creates a pointer drag behavior that can be attached to a mesh
  100851. * @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)
  100852. */
  100853. constructor(options?: {
  100854. dragAxis?: Vector3;
  100855. dragPlaneNormal?: Vector3;
  100856. });
  100857. /**
  100858. * Predicate to determine if it is valid to move the object to a new position when it is moved
  100859. */
  100860. validateDrag: (targetPosition: Vector3) => boolean;
  100861. /**
  100862. * The name of the behavior
  100863. */
  100864. readonly name: string;
  100865. /**
  100866. * Initializes the behavior
  100867. */
  100868. init(): void;
  100869. private _tmpVector;
  100870. private _alternatePickedPoint;
  100871. private _worldDragAxis;
  100872. private _targetPosition;
  100873. private _attachedElement;
  100874. /**
  100875. * Attaches the drag behavior the passed in mesh
  100876. * @param ownerNode The mesh that will be dragged around once attached
  100877. */
  100878. attach(ownerNode: AbstractMesh): void;
  100879. /**
  100880. * Force relase the drag action by code.
  100881. */
  100882. releaseDrag(): void;
  100883. private _startDragRay;
  100884. private _lastPointerRay;
  100885. /**
  100886. * Simulates the start of a pointer drag event on the behavior
  100887. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  100888. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  100889. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  100890. */
  100891. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  100892. private _startDrag;
  100893. private _dragDelta;
  100894. private _moveDrag;
  100895. private _pickWithRayOnDragPlane;
  100896. private _pointA;
  100897. private _pointB;
  100898. private _pointC;
  100899. private _lineA;
  100900. private _lineB;
  100901. private _localAxis;
  100902. private _lookAt;
  100903. private _updateDragPlanePosition;
  100904. /**
  100905. * Detaches the behavior from the mesh
  100906. */
  100907. detach(): void;
  100908. }
  100909. }
  100910. declare module BABYLON {
  100911. /**
  100912. * A behavior that when attached to a mesh will allow the mesh to be scaled
  100913. */
  100914. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  100915. private _dragBehaviorA;
  100916. private _dragBehaviorB;
  100917. private _startDistance;
  100918. private _initialScale;
  100919. private _targetScale;
  100920. private _ownerNode;
  100921. private _sceneRenderObserver;
  100922. /**
  100923. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  100924. */
  100925. constructor();
  100926. /**
  100927. * The name of the behavior
  100928. */
  100929. readonly name: string;
  100930. /**
  100931. * Initializes the behavior
  100932. */
  100933. init(): void;
  100934. private _getCurrentDistance;
  100935. /**
  100936. * Attaches the scale behavior the passed in mesh
  100937. * @param ownerNode The mesh that will be scaled around once attached
  100938. */
  100939. attach(ownerNode: Mesh): void;
  100940. /**
  100941. * Detaches the behavior from the mesh
  100942. */
  100943. detach(): void;
  100944. }
  100945. }
  100946. declare module BABYLON {
  100947. /**
  100948. * 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
  100949. */
  100950. export class SixDofDragBehavior implements Behavior<Mesh> {
  100951. private static _virtualScene;
  100952. private _ownerNode;
  100953. private _sceneRenderObserver;
  100954. private _scene;
  100955. private _targetPosition;
  100956. private _virtualOriginMesh;
  100957. private _virtualDragMesh;
  100958. private _pointerObserver;
  100959. private _moving;
  100960. private _startingOrientation;
  100961. /**
  100962. * 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)
  100963. */
  100964. private zDragFactor;
  100965. /**
  100966. * If the object should rotate to face the drag origin
  100967. */
  100968. rotateDraggedObject: boolean;
  100969. /**
  100970. * If the behavior is currently in a dragging state
  100971. */
  100972. dragging: boolean;
  100973. /**
  100974. * 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)
  100975. */
  100976. dragDeltaRatio: number;
  100977. /**
  100978. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  100979. */
  100980. currentDraggingPointerID: number;
  100981. /**
  100982. * If camera controls should be detached during the drag
  100983. */
  100984. detachCameraControls: boolean;
  100985. /**
  100986. * Fires each time a drag starts
  100987. */
  100988. onDragStartObservable: Observable<{}>;
  100989. /**
  100990. * Fires each time a drag ends (eg. mouse release after drag)
  100991. */
  100992. onDragEndObservable: Observable<{}>;
  100993. /**
  100994. * 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
  100995. */
  100996. constructor();
  100997. /**
  100998. * The name of the behavior
  100999. */
  101000. readonly name: string;
  101001. /**
  101002. * Initializes the behavior
  101003. */
  101004. init(): void;
  101005. /**
  101006. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  101007. */
  101008. private readonly _pointerCamera;
  101009. /**
  101010. * Attaches the scale behavior the passed in mesh
  101011. * @param ownerNode The mesh that will be scaled around once attached
  101012. */
  101013. attach(ownerNode: Mesh): void;
  101014. /**
  101015. * Detaches the behavior from the mesh
  101016. */
  101017. detach(): void;
  101018. }
  101019. }
  101020. declare module BABYLON {
  101021. /**
  101022. * Class used to apply inverse kinematics to bones
  101023. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  101024. */
  101025. export class BoneIKController {
  101026. private static _tmpVecs;
  101027. private static _tmpQuat;
  101028. private static _tmpMats;
  101029. /**
  101030. * Gets or sets the target mesh
  101031. */
  101032. targetMesh: AbstractMesh;
  101033. /** Gets or sets the mesh used as pole */
  101034. poleTargetMesh: AbstractMesh;
  101035. /**
  101036. * Gets or sets the bone used as pole
  101037. */
  101038. poleTargetBone: Nullable<Bone>;
  101039. /**
  101040. * Gets or sets the target position
  101041. */
  101042. targetPosition: Vector3;
  101043. /**
  101044. * Gets or sets the pole target position
  101045. */
  101046. poleTargetPosition: Vector3;
  101047. /**
  101048. * Gets or sets the pole target local offset
  101049. */
  101050. poleTargetLocalOffset: Vector3;
  101051. /**
  101052. * Gets or sets the pole angle
  101053. */
  101054. poleAngle: number;
  101055. /**
  101056. * Gets or sets the mesh associated with the controller
  101057. */
  101058. mesh: AbstractMesh;
  101059. /**
  101060. * 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)
  101061. */
  101062. slerpAmount: number;
  101063. private _bone1Quat;
  101064. private _bone1Mat;
  101065. private _bone2Ang;
  101066. private _bone1;
  101067. private _bone2;
  101068. private _bone1Length;
  101069. private _bone2Length;
  101070. private _maxAngle;
  101071. private _maxReach;
  101072. private _rightHandedSystem;
  101073. private _bendAxis;
  101074. private _slerping;
  101075. private _adjustRoll;
  101076. /**
  101077. * Gets or sets maximum allowed angle
  101078. */
  101079. maxAngle: number;
  101080. /**
  101081. * Creates a new BoneIKController
  101082. * @param mesh defines the mesh to control
  101083. * @param bone defines the bone to control
  101084. * @param options defines options to set up the controller
  101085. */
  101086. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  101087. targetMesh?: AbstractMesh;
  101088. poleTargetMesh?: AbstractMesh;
  101089. poleTargetBone?: Bone;
  101090. poleTargetLocalOffset?: Vector3;
  101091. poleAngle?: number;
  101092. bendAxis?: Vector3;
  101093. maxAngle?: number;
  101094. slerpAmount?: number;
  101095. });
  101096. private _setMaxAngle;
  101097. /**
  101098. * Force the controller to update the bones
  101099. */
  101100. update(): void;
  101101. }
  101102. }
  101103. declare module BABYLON {
  101104. /**
  101105. * Class used to make a bone look toward a point in space
  101106. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  101107. */
  101108. export class BoneLookController {
  101109. private static _tmpVecs;
  101110. private static _tmpQuat;
  101111. private static _tmpMats;
  101112. /**
  101113. * The target Vector3 that the bone will look at
  101114. */
  101115. target: Vector3;
  101116. /**
  101117. * The mesh that the bone is attached to
  101118. */
  101119. mesh: AbstractMesh;
  101120. /**
  101121. * The bone that will be looking to the target
  101122. */
  101123. bone: Bone;
  101124. /**
  101125. * The up axis of the coordinate system that is used when the bone is rotated
  101126. */
  101127. upAxis: Vector3;
  101128. /**
  101129. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  101130. */
  101131. upAxisSpace: Space;
  101132. /**
  101133. * Used to make an adjustment to the yaw of the bone
  101134. */
  101135. adjustYaw: number;
  101136. /**
  101137. * Used to make an adjustment to the pitch of the bone
  101138. */
  101139. adjustPitch: number;
  101140. /**
  101141. * Used to make an adjustment to the roll of the bone
  101142. */
  101143. adjustRoll: number;
  101144. /**
  101145. * 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)
  101146. */
  101147. slerpAmount: number;
  101148. private _minYaw;
  101149. private _maxYaw;
  101150. private _minPitch;
  101151. private _maxPitch;
  101152. private _minYawSin;
  101153. private _minYawCos;
  101154. private _maxYawSin;
  101155. private _maxYawCos;
  101156. private _midYawConstraint;
  101157. private _minPitchTan;
  101158. private _maxPitchTan;
  101159. private _boneQuat;
  101160. private _slerping;
  101161. private _transformYawPitch;
  101162. private _transformYawPitchInv;
  101163. private _firstFrameSkipped;
  101164. private _yawRange;
  101165. private _fowardAxis;
  101166. /**
  101167. * Gets or sets the minimum yaw angle that the bone can look to
  101168. */
  101169. minYaw: number;
  101170. /**
  101171. * Gets or sets the maximum yaw angle that the bone can look to
  101172. */
  101173. maxYaw: number;
  101174. /**
  101175. * Gets or sets the minimum pitch angle that the bone can look to
  101176. */
  101177. minPitch: number;
  101178. /**
  101179. * Gets or sets the maximum pitch angle that the bone can look to
  101180. */
  101181. maxPitch: number;
  101182. /**
  101183. * Create a BoneLookController
  101184. * @param mesh the mesh that the bone belongs to
  101185. * @param bone the bone that will be looking to the target
  101186. * @param target the target Vector3 to look at
  101187. * @param options optional settings:
  101188. * * maxYaw: the maximum angle the bone will yaw to
  101189. * * minYaw: the minimum angle the bone will yaw to
  101190. * * maxPitch: the maximum angle the bone will pitch to
  101191. * * minPitch: the minimum angle the bone will yaw to
  101192. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  101193. * * upAxis: the up axis of the coordinate system
  101194. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  101195. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  101196. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  101197. * * adjustYaw: used to make an adjustment to the yaw of the bone
  101198. * * adjustPitch: used to make an adjustment to the pitch of the bone
  101199. * * adjustRoll: used to make an adjustment to the roll of the bone
  101200. **/
  101201. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  101202. maxYaw?: number;
  101203. minYaw?: number;
  101204. maxPitch?: number;
  101205. minPitch?: number;
  101206. slerpAmount?: number;
  101207. upAxis?: Vector3;
  101208. upAxisSpace?: Space;
  101209. yawAxis?: Vector3;
  101210. pitchAxis?: Vector3;
  101211. adjustYaw?: number;
  101212. adjustPitch?: number;
  101213. adjustRoll?: number;
  101214. });
  101215. /**
  101216. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  101217. */
  101218. update(): void;
  101219. private _getAngleDiff;
  101220. private _getAngleBetween;
  101221. private _isAngleBetween;
  101222. }
  101223. }
  101224. declare module BABYLON {
  101225. /**
  101226. * Manage the gamepad inputs to control an arc rotate camera.
  101227. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101228. */
  101229. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  101230. /**
  101231. * Defines the camera the input is attached to.
  101232. */
  101233. camera: ArcRotateCamera;
  101234. /**
  101235. * Defines the gamepad the input is gathering event from.
  101236. */
  101237. gamepad: Nullable<Gamepad>;
  101238. /**
  101239. * Defines the gamepad rotation sensiblity.
  101240. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  101241. */
  101242. gamepadRotationSensibility: number;
  101243. /**
  101244. * Defines the gamepad move sensiblity.
  101245. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  101246. */
  101247. gamepadMoveSensibility: number;
  101248. private _onGamepadConnectedObserver;
  101249. private _onGamepadDisconnectedObserver;
  101250. /**
  101251. * Attach the input controls to a specific dom element to get the input from.
  101252. * @param element Defines the element the controls should be listened from
  101253. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101254. */
  101255. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101256. /**
  101257. * Detach the current controls from the specified dom element.
  101258. * @param element Defines the element to stop listening the inputs from
  101259. */
  101260. detachControl(element: Nullable<HTMLElement>): void;
  101261. /**
  101262. * Update the current camera state depending on the inputs that have been used this frame.
  101263. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  101264. */
  101265. checkInputs(): void;
  101266. /**
  101267. * Gets the class name of the current intput.
  101268. * @returns the class name
  101269. */
  101270. getClassName(): string;
  101271. /**
  101272. * Get the friendly name associated with the input class.
  101273. * @returns the input friendly name
  101274. */
  101275. getSimpleName(): string;
  101276. }
  101277. }
  101278. declare module BABYLON {
  101279. interface ArcRotateCameraInputsManager {
  101280. /**
  101281. * Add orientation input support to the input manager.
  101282. * @returns the current input manager
  101283. */
  101284. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  101285. }
  101286. /**
  101287. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  101288. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101289. */
  101290. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  101291. /**
  101292. * Defines the camera the input is attached to.
  101293. */
  101294. camera: ArcRotateCamera;
  101295. /**
  101296. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  101297. */
  101298. alphaCorrection: number;
  101299. /**
  101300. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  101301. */
  101302. gammaCorrection: number;
  101303. private _alpha;
  101304. private _gamma;
  101305. private _dirty;
  101306. private _deviceOrientationHandler;
  101307. /**
  101308. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  101309. */
  101310. constructor();
  101311. /**
  101312. * Attach the input controls to a specific dom element to get the input from.
  101313. * @param element Defines the element the controls should be listened from
  101314. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101315. */
  101316. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101317. /** @hidden */
  101318. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  101319. /**
  101320. * Update the current camera state depending on the inputs that have been used this frame.
  101321. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  101322. */
  101323. checkInputs(): void;
  101324. /**
  101325. * Detach the current controls from the specified dom element.
  101326. * @param element Defines the element to stop listening the inputs from
  101327. */
  101328. detachControl(element: Nullable<HTMLElement>): void;
  101329. /**
  101330. * Gets the class name of the current intput.
  101331. * @returns the class name
  101332. */
  101333. getClassName(): string;
  101334. /**
  101335. * Get the friendly name associated with the input class.
  101336. * @returns the input friendly name
  101337. */
  101338. getSimpleName(): string;
  101339. }
  101340. }
  101341. declare module BABYLON {
  101342. /**
  101343. * Listen to mouse events to control the camera.
  101344. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101345. */
  101346. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  101347. /**
  101348. * Defines the camera the input is attached to.
  101349. */
  101350. camera: FlyCamera;
  101351. /**
  101352. * Defines if touch is enabled. (Default is true.)
  101353. */
  101354. touchEnabled: boolean;
  101355. /**
  101356. * Defines the buttons associated with the input to handle camera rotation.
  101357. */
  101358. buttons: number[];
  101359. /**
  101360. * Assign buttons for Yaw control.
  101361. */
  101362. buttonsYaw: number[];
  101363. /**
  101364. * Assign buttons for Pitch control.
  101365. */
  101366. buttonsPitch: number[];
  101367. /**
  101368. * Assign buttons for Roll control.
  101369. */
  101370. buttonsRoll: number[];
  101371. /**
  101372. * Detect if any button is being pressed while mouse is moved.
  101373. * -1 = Mouse locked.
  101374. * 0 = Left button.
  101375. * 1 = Middle Button.
  101376. * 2 = Right Button.
  101377. */
  101378. activeButton: number;
  101379. /**
  101380. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  101381. * Higher values reduce its sensitivity.
  101382. */
  101383. angularSensibility: number;
  101384. private _mousemoveCallback;
  101385. private _observer;
  101386. private _rollObserver;
  101387. private previousPosition;
  101388. private noPreventDefault;
  101389. private element;
  101390. /**
  101391. * Listen to mouse events to control the camera.
  101392. * @param touchEnabled Define if touch is enabled. (Default is true.)
  101393. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101394. */
  101395. constructor(touchEnabled?: boolean);
  101396. /**
  101397. * Attach the mouse control to the HTML DOM element.
  101398. * @param element Defines the element that listens to the input events.
  101399. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  101400. */
  101401. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101402. /**
  101403. * Detach the current controls from the specified dom element.
  101404. * @param element Defines the element to stop listening the inputs from
  101405. */
  101406. detachControl(element: Nullable<HTMLElement>): void;
  101407. /**
  101408. * Gets the class name of the current input.
  101409. * @returns the class name.
  101410. */
  101411. getClassName(): string;
  101412. /**
  101413. * Get the friendly name associated with the input class.
  101414. * @returns the input's friendly name.
  101415. */
  101416. getSimpleName(): string;
  101417. private _pointerInput;
  101418. private _onMouseMove;
  101419. /**
  101420. * Rotate camera by mouse offset.
  101421. */
  101422. private rotateCamera;
  101423. }
  101424. }
  101425. declare module BABYLON {
  101426. /**
  101427. * Default Inputs manager for the FlyCamera.
  101428. * It groups all the default supported inputs for ease of use.
  101429. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101430. */
  101431. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  101432. /**
  101433. * Instantiates a new FlyCameraInputsManager.
  101434. * @param camera Defines the camera the inputs belong to.
  101435. */
  101436. constructor(camera: FlyCamera);
  101437. /**
  101438. * Add keyboard input support to the input manager.
  101439. * @returns the new FlyCameraKeyboardMoveInput().
  101440. */
  101441. addKeyboard(): FlyCameraInputsManager;
  101442. /**
  101443. * Add mouse input support to the input manager.
  101444. * @param touchEnabled Enable touch screen support.
  101445. * @returns the new FlyCameraMouseInput().
  101446. */
  101447. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  101448. }
  101449. }
  101450. declare module BABYLON {
  101451. /**
  101452. * This is a flying camera, designed for 3D movement and rotation in all directions,
  101453. * such as in a 3D Space Shooter or a Flight Simulator.
  101454. */
  101455. export class FlyCamera extends TargetCamera {
  101456. /**
  101457. * Define the collision ellipsoid of the camera.
  101458. * This is helpful for simulating a camera body, like a player's body.
  101459. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  101460. */
  101461. ellipsoid: Vector3;
  101462. /**
  101463. * Define an offset for the position of the ellipsoid around the camera.
  101464. * This can be helpful if the camera is attached away from the player's body center,
  101465. * such as at its head.
  101466. */
  101467. ellipsoidOffset: Vector3;
  101468. /**
  101469. * Enable or disable collisions of the camera with the rest of the scene objects.
  101470. */
  101471. checkCollisions: boolean;
  101472. /**
  101473. * Enable or disable gravity on the camera.
  101474. */
  101475. applyGravity: boolean;
  101476. /**
  101477. * Define the current direction the camera is moving to.
  101478. */
  101479. cameraDirection: Vector3;
  101480. /**
  101481. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  101482. * This overrides and empties cameraRotation.
  101483. */
  101484. rotationQuaternion: Quaternion;
  101485. /**
  101486. * Track Roll to maintain the wanted Rolling when looking around.
  101487. */
  101488. _trackRoll: number;
  101489. /**
  101490. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  101491. */
  101492. rollCorrect: number;
  101493. /**
  101494. * Mimic a banked turn, Rolling the camera when Yawing.
  101495. * It's recommended to use rollCorrect = 10 for faster banking correction.
  101496. */
  101497. bankedTurn: boolean;
  101498. /**
  101499. * Limit in radians for how much Roll banking will add. (Default: 90°)
  101500. */
  101501. bankedTurnLimit: number;
  101502. /**
  101503. * Value of 0 disables the banked Roll.
  101504. * Value of 1 is equal to the Yaw angle in radians.
  101505. */
  101506. bankedTurnMultiplier: number;
  101507. /**
  101508. * The inputs manager loads all the input sources, such as keyboard and mouse.
  101509. */
  101510. inputs: FlyCameraInputsManager;
  101511. /**
  101512. * Gets the input sensibility for mouse input.
  101513. * Higher values reduce sensitivity.
  101514. */
  101515. /**
  101516. * Sets the input sensibility for a mouse input.
  101517. * Higher values reduce sensitivity.
  101518. */
  101519. angularSensibility: number;
  101520. /**
  101521. * Get the keys for camera movement forward.
  101522. */
  101523. /**
  101524. * Set the keys for camera movement forward.
  101525. */
  101526. keysForward: number[];
  101527. /**
  101528. * Get the keys for camera movement backward.
  101529. */
  101530. keysBackward: number[];
  101531. /**
  101532. * Get the keys for camera movement up.
  101533. */
  101534. /**
  101535. * Set the keys for camera movement up.
  101536. */
  101537. keysUp: number[];
  101538. /**
  101539. * Get the keys for camera movement down.
  101540. */
  101541. /**
  101542. * Set the keys for camera movement down.
  101543. */
  101544. keysDown: number[];
  101545. /**
  101546. * Get the keys for camera movement left.
  101547. */
  101548. /**
  101549. * Set the keys for camera movement left.
  101550. */
  101551. keysLeft: number[];
  101552. /**
  101553. * Set the keys for camera movement right.
  101554. */
  101555. /**
  101556. * Set the keys for camera movement right.
  101557. */
  101558. keysRight: number[];
  101559. /**
  101560. * Event raised when the camera collides with a mesh in the scene.
  101561. */
  101562. onCollide: (collidedMesh: AbstractMesh) => void;
  101563. private _collider;
  101564. private _needMoveForGravity;
  101565. private _oldPosition;
  101566. private _diffPosition;
  101567. private _newPosition;
  101568. /** @hidden */
  101569. _localDirection: Vector3;
  101570. /** @hidden */
  101571. _transformedDirection: Vector3;
  101572. /**
  101573. * Instantiates a FlyCamera.
  101574. * This is a flying camera, designed for 3D movement and rotation in all directions,
  101575. * such as in a 3D Space Shooter or a Flight Simulator.
  101576. * @param name Define the name of the camera in the scene.
  101577. * @param position Define the starting position of the camera in the scene.
  101578. * @param scene Define the scene the camera belongs to.
  101579. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  101580. */
  101581. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  101582. /**
  101583. * Attach a control to the HTML DOM element.
  101584. * @param element Defines the element that listens to the input events.
  101585. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  101586. */
  101587. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101588. /**
  101589. * Detach a control from the HTML DOM element.
  101590. * The camera will stop reacting to that input.
  101591. * @param element Defines the element that listens to the input events.
  101592. */
  101593. detachControl(element: HTMLElement): void;
  101594. private _collisionMask;
  101595. /**
  101596. * Get the mask that the camera ignores in collision events.
  101597. */
  101598. /**
  101599. * Set the mask that the camera ignores in collision events.
  101600. */
  101601. collisionMask: number;
  101602. /** @hidden */
  101603. _collideWithWorld(displacement: Vector3): void;
  101604. /** @hidden */
  101605. private _onCollisionPositionChange;
  101606. /** @hidden */
  101607. _checkInputs(): void;
  101608. /** @hidden */
  101609. _decideIfNeedsToMove(): boolean;
  101610. /** @hidden */
  101611. _updatePosition(): void;
  101612. /**
  101613. * Restore the Roll to its target value at the rate specified.
  101614. * @param rate - Higher means slower restoring.
  101615. * @hidden
  101616. */
  101617. restoreRoll(rate: number): void;
  101618. /**
  101619. * Destroy the camera and release the current resources held by it.
  101620. */
  101621. dispose(): void;
  101622. /**
  101623. * Get the current object class name.
  101624. * @returns the class name.
  101625. */
  101626. getClassName(): string;
  101627. }
  101628. }
  101629. declare module BABYLON {
  101630. /**
  101631. * Listen to keyboard events to control the camera.
  101632. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101633. */
  101634. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  101635. /**
  101636. * Defines the camera the input is attached to.
  101637. */
  101638. camera: FlyCamera;
  101639. /**
  101640. * The list of keyboard keys used to control the forward move of the camera.
  101641. */
  101642. keysForward: number[];
  101643. /**
  101644. * The list of keyboard keys used to control the backward move of the camera.
  101645. */
  101646. keysBackward: number[];
  101647. /**
  101648. * The list of keyboard keys used to control the forward move of the camera.
  101649. */
  101650. keysUp: number[];
  101651. /**
  101652. * The list of keyboard keys used to control the backward move of the camera.
  101653. */
  101654. keysDown: number[];
  101655. /**
  101656. * The list of keyboard keys used to control the right strafe move of the camera.
  101657. */
  101658. keysRight: number[];
  101659. /**
  101660. * The list of keyboard keys used to control the left strafe move of the camera.
  101661. */
  101662. keysLeft: number[];
  101663. private _keys;
  101664. private _onCanvasBlurObserver;
  101665. private _onKeyboardObserver;
  101666. private _engine;
  101667. private _scene;
  101668. /**
  101669. * Attach the input controls to a specific dom element to get the input from.
  101670. * @param element Defines the element the controls should be listened from
  101671. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101672. */
  101673. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101674. /**
  101675. * Detach the current controls from the specified dom element.
  101676. * @param element Defines the element to stop listening the inputs from
  101677. */
  101678. detachControl(element: Nullable<HTMLElement>): void;
  101679. /**
  101680. * Gets the class name of the current intput.
  101681. * @returns the class name
  101682. */
  101683. getClassName(): string;
  101684. /** @hidden */
  101685. _onLostFocus(e: FocusEvent): void;
  101686. /**
  101687. * Get the friendly name associated with the input class.
  101688. * @returns the input friendly name
  101689. */
  101690. getSimpleName(): string;
  101691. /**
  101692. * Update the current camera state depending on the inputs that have been used this frame.
  101693. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  101694. */
  101695. checkInputs(): void;
  101696. }
  101697. }
  101698. declare module BABYLON {
  101699. /**
  101700. * Manage the mouse wheel inputs to control a follow camera.
  101701. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101702. */
  101703. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  101704. /**
  101705. * Defines the camera the input is attached to.
  101706. */
  101707. camera: FollowCamera;
  101708. /**
  101709. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  101710. */
  101711. axisControlRadius: boolean;
  101712. /**
  101713. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  101714. */
  101715. axisControlHeight: boolean;
  101716. /**
  101717. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  101718. */
  101719. axisControlRotation: boolean;
  101720. /**
  101721. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  101722. * relation to mouseWheel events.
  101723. */
  101724. wheelPrecision: number;
  101725. /**
  101726. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  101727. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  101728. */
  101729. wheelDeltaPercentage: number;
  101730. private _wheel;
  101731. private _observer;
  101732. /**
  101733. * Attach the input controls to a specific dom element to get the input from.
  101734. * @param element Defines the element the controls should be listened from
  101735. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101736. */
  101737. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101738. /**
  101739. * Detach the current controls from the specified dom element.
  101740. * @param element Defines the element to stop listening the inputs from
  101741. */
  101742. detachControl(element: Nullable<HTMLElement>): void;
  101743. /**
  101744. * Gets the class name of the current intput.
  101745. * @returns the class name
  101746. */
  101747. getClassName(): string;
  101748. /**
  101749. * Get the friendly name associated with the input class.
  101750. * @returns the input friendly name
  101751. */
  101752. getSimpleName(): string;
  101753. }
  101754. }
  101755. declare module BABYLON {
  101756. /**
  101757. * Manage the pointers inputs to control an follow camera.
  101758. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101759. */
  101760. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  101761. /**
  101762. * Defines the camera the input is attached to.
  101763. */
  101764. camera: FollowCamera;
  101765. /**
  101766. * Gets the class name of the current input.
  101767. * @returns the class name
  101768. */
  101769. getClassName(): string;
  101770. /**
  101771. * Defines the pointer angular sensibility along the X axis or how fast is
  101772. * the camera rotating.
  101773. * A negative number will reverse the axis direction.
  101774. */
  101775. angularSensibilityX: number;
  101776. /**
  101777. * Defines the pointer angular sensibility along the Y axis or how fast is
  101778. * the camera rotating.
  101779. * A negative number will reverse the axis direction.
  101780. */
  101781. angularSensibilityY: number;
  101782. /**
  101783. * Defines the pointer pinch precision or how fast is the camera zooming.
  101784. * A negative number will reverse the axis direction.
  101785. */
  101786. pinchPrecision: number;
  101787. /**
  101788. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  101789. * from 0.
  101790. * It defines the percentage of current camera.radius to use as delta when
  101791. * pinch zoom is used.
  101792. */
  101793. pinchDeltaPercentage: number;
  101794. /**
  101795. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  101796. */
  101797. axisXControlRadius: boolean;
  101798. /**
  101799. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  101800. */
  101801. axisXControlHeight: boolean;
  101802. /**
  101803. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  101804. */
  101805. axisXControlRotation: boolean;
  101806. /**
  101807. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  101808. */
  101809. axisYControlRadius: boolean;
  101810. /**
  101811. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  101812. */
  101813. axisYControlHeight: boolean;
  101814. /**
  101815. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  101816. */
  101817. axisYControlRotation: boolean;
  101818. /**
  101819. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  101820. */
  101821. axisPinchControlRadius: boolean;
  101822. /**
  101823. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  101824. */
  101825. axisPinchControlHeight: boolean;
  101826. /**
  101827. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  101828. */
  101829. axisPinchControlRotation: boolean;
  101830. /**
  101831. * Log error messages if basic misconfiguration has occurred.
  101832. */
  101833. warningEnable: boolean;
  101834. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  101835. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  101836. private _warningCounter;
  101837. private _warning;
  101838. }
  101839. }
  101840. declare module BABYLON {
  101841. /**
  101842. * Default Inputs manager for the FollowCamera.
  101843. * It groups all the default supported inputs for ease of use.
  101844. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  101845. */
  101846. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  101847. /**
  101848. * Instantiates a new FollowCameraInputsManager.
  101849. * @param camera Defines the camera the inputs belong to
  101850. */
  101851. constructor(camera: FollowCamera);
  101852. /**
  101853. * Add keyboard input support to the input manager.
  101854. * @returns the current input manager
  101855. */
  101856. addKeyboard(): FollowCameraInputsManager;
  101857. /**
  101858. * Add mouse wheel input support to the input manager.
  101859. * @returns the current input manager
  101860. */
  101861. addMouseWheel(): FollowCameraInputsManager;
  101862. /**
  101863. * Add pointers input support to the input manager.
  101864. * @returns the current input manager
  101865. */
  101866. addPointers(): FollowCameraInputsManager;
  101867. /**
  101868. * Add orientation input support to the input manager.
  101869. * @returns the current input manager
  101870. */
  101871. addVRDeviceOrientation(): FollowCameraInputsManager;
  101872. }
  101873. }
  101874. declare module BABYLON {
  101875. /**
  101876. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  101877. * an arc rotate version arcFollowCamera are available.
  101878. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  101879. */
  101880. export class FollowCamera extends TargetCamera {
  101881. /**
  101882. * Distance the follow camera should follow an object at
  101883. */
  101884. radius: number;
  101885. /**
  101886. * Minimum allowed distance of the camera to the axis of rotation
  101887. * (The camera can not get closer).
  101888. * This can help limiting how the Camera is able to move in the scene.
  101889. */
  101890. lowerRadiusLimit: Nullable<number>;
  101891. /**
  101892. * Maximum allowed distance of the camera to the axis of rotation
  101893. * (The camera can not get further).
  101894. * This can help limiting how the Camera is able to move in the scene.
  101895. */
  101896. upperRadiusLimit: Nullable<number>;
  101897. /**
  101898. * Define a rotation offset between the camera and the object it follows
  101899. */
  101900. rotationOffset: number;
  101901. /**
  101902. * Minimum allowed angle to camera position relative to target object.
  101903. * This can help limiting how the Camera is able to move in the scene.
  101904. */
  101905. lowerRotationOffsetLimit: Nullable<number>;
  101906. /**
  101907. * Maximum allowed angle to camera position relative to target object.
  101908. * This can help limiting how the Camera is able to move in the scene.
  101909. */
  101910. upperRotationOffsetLimit: Nullable<number>;
  101911. /**
  101912. * Define a height offset between the camera and the object it follows.
  101913. * It can help following an object from the top (like a car chaing a plane)
  101914. */
  101915. heightOffset: number;
  101916. /**
  101917. * Minimum allowed height of camera position relative to target object.
  101918. * This can help limiting how the Camera is able to move in the scene.
  101919. */
  101920. lowerHeightOffsetLimit: Nullable<number>;
  101921. /**
  101922. * Maximum allowed height of camera position relative to target object.
  101923. * This can help limiting how the Camera is able to move in the scene.
  101924. */
  101925. upperHeightOffsetLimit: Nullable<number>;
  101926. /**
  101927. * Define how fast the camera can accelerate to follow it s target.
  101928. */
  101929. cameraAcceleration: number;
  101930. /**
  101931. * Define the speed limit of the camera following an object.
  101932. */
  101933. maxCameraSpeed: number;
  101934. /**
  101935. * Define the target of the camera.
  101936. */
  101937. lockedTarget: Nullable<AbstractMesh>;
  101938. /**
  101939. * Defines the input associated with the camera.
  101940. */
  101941. inputs: FollowCameraInputsManager;
  101942. /**
  101943. * Instantiates the follow camera.
  101944. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  101945. * @param name Define the name of the camera in the scene
  101946. * @param position Define the position of the camera
  101947. * @param scene Define the scene the camera belong to
  101948. * @param lockedTarget Define the target of the camera
  101949. */
  101950. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  101951. private _follow;
  101952. /**
  101953. * Attached controls to the current camera.
  101954. * @param element Defines the element the controls should be listened from
  101955. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  101956. */
  101957. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  101958. /**
  101959. * Detach the current controls from the camera.
  101960. * The camera will stop reacting to inputs.
  101961. * @param element Defines the element to stop listening the inputs from
  101962. */
  101963. detachControl(element: HTMLElement): void;
  101964. /** @hidden */
  101965. _checkInputs(): void;
  101966. private _checkLimits;
  101967. /**
  101968. * Gets the camera class name.
  101969. * @returns the class name
  101970. */
  101971. getClassName(): string;
  101972. }
  101973. /**
  101974. * Arc Rotate version of the follow camera.
  101975. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  101976. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  101977. */
  101978. export class ArcFollowCamera extends TargetCamera {
  101979. /** The longitudinal angle of the camera */
  101980. alpha: number;
  101981. /** The latitudinal angle of the camera */
  101982. beta: number;
  101983. /** The radius of the camera from its target */
  101984. radius: number;
  101985. /** Define the camera target (the messh it should follow) */
  101986. target: Nullable<AbstractMesh>;
  101987. private _cartesianCoordinates;
  101988. /**
  101989. * Instantiates a new ArcFollowCamera
  101990. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  101991. * @param name Define the name of the camera
  101992. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  101993. * @param beta Define the rotation angle of the camera around the elevation axis
  101994. * @param radius Define the radius of the camera from its target point
  101995. * @param target Define the target of the camera
  101996. * @param scene Define the scene the camera belongs to
  101997. */
  101998. constructor(name: string,
  101999. /** The longitudinal angle of the camera */
  102000. alpha: number,
  102001. /** The latitudinal angle of the camera */
  102002. beta: number,
  102003. /** The radius of the camera from its target */
  102004. radius: number,
  102005. /** Define the camera target (the messh it should follow) */
  102006. target: Nullable<AbstractMesh>, scene: Scene);
  102007. private _follow;
  102008. /** @hidden */
  102009. _checkInputs(): void;
  102010. /**
  102011. * Returns the class name of the object.
  102012. * It is mostly used internally for serialization purposes.
  102013. */
  102014. getClassName(): string;
  102015. }
  102016. }
  102017. declare module BABYLON {
  102018. /**
  102019. * Manage the keyboard inputs to control the movement of a follow camera.
  102020. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102021. */
  102022. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  102023. /**
  102024. * Defines the camera the input is attached to.
  102025. */
  102026. camera: FollowCamera;
  102027. /**
  102028. * Defines the list of key codes associated with the up action (increase heightOffset)
  102029. */
  102030. keysHeightOffsetIncr: number[];
  102031. /**
  102032. * Defines the list of key codes associated with the down action (decrease heightOffset)
  102033. */
  102034. keysHeightOffsetDecr: number[];
  102035. /**
  102036. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  102037. */
  102038. keysHeightOffsetModifierAlt: boolean;
  102039. /**
  102040. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  102041. */
  102042. keysHeightOffsetModifierCtrl: boolean;
  102043. /**
  102044. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  102045. */
  102046. keysHeightOffsetModifierShift: boolean;
  102047. /**
  102048. * Defines the list of key codes associated with the left action (increase rotationOffset)
  102049. */
  102050. keysRotationOffsetIncr: number[];
  102051. /**
  102052. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  102053. */
  102054. keysRotationOffsetDecr: number[];
  102055. /**
  102056. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  102057. */
  102058. keysRotationOffsetModifierAlt: boolean;
  102059. /**
  102060. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  102061. */
  102062. keysRotationOffsetModifierCtrl: boolean;
  102063. /**
  102064. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  102065. */
  102066. keysRotationOffsetModifierShift: boolean;
  102067. /**
  102068. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  102069. */
  102070. keysRadiusIncr: number[];
  102071. /**
  102072. * Defines the list of key codes associated with the zoom-out action (increase radius)
  102073. */
  102074. keysRadiusDecr: number[];
  102075. /**
  102076. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  102077. */
  102078. keysRadiusModifierAlt: boolean;
  102079. /**
  102080. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  102081. */
  102082. keysRadiusModifierCtrl: boolean;
  102083. /**
  102084. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  102085. */
  102086. keysRadiusModifierShift: boolean;
  102087. /**
  102088. * Defines the rate of change of heightOffset.
  102089. */
  102090. heightSensibility: number;
  102091. /**
  102092. * Defines the rate of change of rotationOffset.
  102093. */
  102094. rotationSensibility: number;
  102095. /**
  102096. * Defines the rate of change of radius.
  102097. */
  102098. radiusSensibility: number;
  102099. private _keys;
  102100. private _ctrlPressed;
  102101. private _altPressed;
  102102. private _shiftPressed;
  102103. private _onCanvasBlurObserver;
  102104. private _onKeyboardObserver;
  102105. private _engine;
  102106. private _scene;
  102107. /**
  102108. * Attach the input controls to a specific dom element to get the input from.
  102109. * @param element Defines the element the controls should be listened from
  102110. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  102111. */
  102112. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102113. /**
  102114. * Detach the current controls from the specified dom element.
  102115. * @param element Defines the element to stop listening the inputs from
  102116. */
  102117. detachControl(element: Nullable<HTMLElement>): void;
  102118. /**
  102119. * Update the current camera state depending on the inputs that have been used this frame.
  102120. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  102121. */
  102122. checkInputs(): void;
  102123. /**
  102124. * Gets the class name of the current input.
  102125. * @returns the class name
  102126. */
  102127. getClassName(): string;
  102128. /**
  102129. * Get the friendly name associated with the input class.
  102130. * @returns the input friendly name
  102131. */
  102132. getSimpleName(): string;
  102133. /**
  102134. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  102135. * allow modification of the heightOffset value.
  102136. */
  102137. private _modifierHeightOffset;
  102138. /**
  102139. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  102140. * allow modification of the rotationOffset value.
  102141. */
  102142. private _modifierRotationOffset;
  102143. /**
  102144. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  102145. * allow modification of the radius value.
  102146. */
  102147. private _modifierRadius;
  102148. }
  102149. }
  102150. declare module BABYLON {
  102151. interface FreeCameraInputsManager {
  102152. /**
  102153. * @hidden
  102154. */
  102155. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  102156. /**
  102157. * Add orientation input support to the input manager.
  102158. * @returns the current input manager
  102159. */
  102160. addDeviceOrientation(): FreeCameraInputsManager;
  102161. }
  102162. /**
  102163. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  102164. * Screen rotation is taken into account.
  102165. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102166. */
  102167. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  102168. private _camera;
  102169. private _screenOrientationAngle;
  102170. private _constantTranform;
  102171. private _screenQuaternion;
  102172. private _alpha;
  102173. private _beta;
  102174. private _gamma;
  102175. /**
  102176. * Can be used to detect if a device orientation sensor is availible on a device
  102177. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  102178. * @returns a promise that will resolve on orientation change
  102179. */
  102180. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  102181. /**
  102182. * @hidden
  102183. */
  102184. _onDeviceOrientationChangedObservable: Observable<void>;
  102185. /**
  102186. * Instantiates a new input
  102187. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102188. */
  102189. constructor();
  102190. /**
  102191. * Define the camera controlled by the input.
  102192. */
  102193. camera: FreeCamera;
  102194. /**
  102195. * Attach the input controls to a specific dom element to get the input from.
  102196. * @param element Defines the element the controls should be listened from
  102197. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  102198. */
  102199. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102200. private _orientationChanged;
  102201. private _deviceOrientation;
  102202. /**
  102203. * Detach the current controls from the specified dom element.
  102204. * @param element Defines the element to stop listening the inputs from
  102205. */
  102206. detachControl(element: Nullable<HTMLElement>): void;
  102207. /**
  102208. * Update the current camera state depending on the inputs that have been used this frame.
  102209. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  102210. */
  102211. checkInputs(): void;
  102212. /**
  102213. * Gets the class name of the current intput.
  102214. * @returns the class name
  102215. */
  102216. getClassName(): string;
  102217. /**
  102218. * Get the friendly name associated with the input class.
  102219. * @returns the input friendly name
  102220. */
  102221. getSimpleName(): string;
  102222. }
  102223. }
  102224. declare module BABYLON {
  102225. /**
  102226. * Manage the gamepad inputs to control a free camera.
  102227. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102228. */
  102229. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  102230. /**
  102231. * Define the camera the input is attached to.
  102232. */
  102233. camera: FreeCamera;
  102234. /**
  102235. * Define the Gamepad controlling the input
  102236. */
  102237. gamepad: Nullable<Gamepad>;
  102238. /**
  102239. * Defines the gamepad rotation sensiblity.
  102240. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  102241. */
  102242. gamepadAngularSensibility: number;
  102243. /**
  102244. * Defines the gamepad move sensiblity.
  102245. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  102246. */
  102247. gamepadMoveSensibility: number;
  102248. private _onGamepadConnectedObserver;
  102249. private _onGamepadDisconnectedObserver;
  102250. private _cameraTransform;
  102251. private _deltaTransform;
  102252. private _vector3;
  102253. private _vector2;
  102254. /**
  102255. * Attach the input controls to a specific dom element to get the input from.
  102256. * @param element Defines the element the controls should be listened from
  102257. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  102258. */
  102259. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102260. /**
  102261. * Detach the current controls from the specified dom element.
  102262. * @param element Defines the element to stop listening the inputs from
  102263. */
  102264. detachControl(element: Nullable<HTMLElement>): void;
  102265. /**
  102266. * Update the current camera state depending on the inputs that have been used this frame.
  102267. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  102268. */
  102269. checkInputs(): void;
  102270. /**
  102271. * Gets the class name of the current intput.
  102272. * @returns the class name
  102273. */
  102274. getClassName(): string;
  102275. /**
  102276. * Get the friendly name associated with the input class.
  102277. * @returns the input friendly name
  102278. */
  102279. getSimpleName(): string;
  102280. }
  102281. }
  102282. declare module BABYLON {
  102283. /**
  102284. * Defines the potential axis of a Joystick
  102285. */
  102286. export enum JoystickAxis {
  102287. /** X axis */
  102288. X = 0,
  102289. /** Y axis */
  102290. Y = 1,
  102291. /** Z axis */
  102292. Z = 2
  102293. }
  102294. /**
  102295. * Class used to define virtual joystick (used in touch mode)
  102296. */
  102297. export class VirtualJoystick {
  102298. /**
  102299. * Gets or sets a boolean indicating that left and right values must be inverted
  102300. */
  102301. reverseLeftRight: boolean;
  102302. /**
  102303. * Gets or sets a boolean indicating that up and down values must be inverted
  102304. */
  102305. reverseUpDown: boolean;
  102306. /**
  102307. * Gets the offset value for the position (ie. the change of the position value)
  102308. */
  102309. deltaPosition: Vector3;
  102310. /**
  102311. * Gets a boolean indicating if the virtual joystick was pressed
  102312. */
  102313. pressed: boolean;
  102314. /**
  102315. * Canvas the virtual joystick will render onto, default z-index of this is 5
  102316. */
  102317. static Canvas: Nullable<HTMLCanvasElement>;
  102318. private static _globalJoystickIndex;
  102319. private static vjCanvasContext;
  102320. private static vjCanvasWidth;
  102321. private static vjCanvasHeight;
  102322. private static halfWidth;
  102323. private _action;
  102324. private _axisTargetedByLeftAndRight;
  102325. private _axisTargetedByUpAndDown;
  102326. private _joystickSensibility;
  102327. private _inversedSensibility;
  102328. private _joystickPointerID;
  102329. private _joystickColor;
  102330. private _joystickPointerPos;
  102331. private _joystickPreviousPointerPos;
  102332. private _joystickPointerStartPos;
  102333. private _deltaJoystickVector;
  102334. private _leftJoystick;
  102335. private _touches;
  102336. private _onPointerDownHandlerRef;
  102337. private _onPointerMoveHandlerRef;
  102338. private _onPointerUpHandlerRef;
  102339. private _onResize;
  102340. /**
  102341. * Creates a new virtual joystick
  102342. * @param leftJoystick defines that the joystick is for left hand (false by default)
  102343. */
  102344. constructor(leftJoystick?: boolean);
  102345. /**
  102346. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  102347. * @param newJoystickSensibility defines the new sensibility
  102348. */
  102349. setJoystickSensibility(newJoystickSensibility: number): void;
  102350. private _onPointerDown;
  102351. private _onPointerMove;
  102352. private _onPointerUp;
  102353. /**
  102354. * Change the color of the virtual joystick
  102355. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  102356. */
  102357. setJoystickColor(newColor: string): void;
  102358. /**
  102359. * Defines a callback to call when the joystick is touched
  102360. * @param action defines the callback
  102361. */
  102362. setActionOnTouch(action: () => any): void;
  102363. /**
  102364. * Defines which axis you'd like to control for left & right
  102365. * @param axis defines the axis to use
  102366. */
  102367. setAxisForLeftRight(axis: JoystickAxis): void;
  102368. /**
  102369. * Defines which axis you'd like to control for up & down
  102370. * @param axis defines the axis to use
  102371. */
  102372. setAxisForUpDown(axis: JoystickAxis): void;
  102373. private _drawVirtualJoystick;
  102374. /**
  102375. * Release internal HTML canvas
  102376. */
  102377. releaseCanvas(): void;
  102378. }
  102379. }
  102380. declare module BABYLON {
  102381. interface FreeCameraInputsManager {
  102382. /**
  102383. * Add virtual joystick input support to the input manager.
  102384. * @returns the current input manager
  102385. */
  102386. addVirtualJoystick(): FreeCameraInputsManager;
  102387. }
  102388. /**
  102389. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  102390. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  102391. */
  102392. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  102393. /**
  102394. * Defines the camera the input is attached to.
  102395. */
  102396. camera: FreeCamera;
  102397. private _leftjoystick;
  102398. private _rightjoystick;
  102399. /**
  102400. * Gets the left stick of the virtual joystick.
  102401. * @returns The virtual Joystick
  102402. */
  102403. getLeftJoystick(): VirtualJoystick;
  102404. /**
  102405. * Gets the right stick of the virtual joystick.
  102406. * @returns The virtual Joystick
  102407. */
  102408. getRightJoystick(): VirtualJoystick;
  102409. /**
  102410. * Update the current camera state depending on the inputs that have been used this frame.
  102411. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  102412. */
  102413. checkInputs(): void;
  102414. /**
  102415. * Attach the input controls to a specific dom element to get the input from.
  102416. * @param element Defines the element the controls should be listened from
  102417. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  102418. */
  102419. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  102420. /**
  102421. * Detach the current controls from the specified dom element.
  102422. * @param element Defines the element to stop listening the inputs from
  102423. */
  102424. detachControl(element: Nullable<HTMLElement>): void;
  102425. /**
  102426. * Gets the class name of the current intput.
  102427. * @returns the class name
  102428. */
  102429. getClassName(): string;
  102430. /**
  102431. * Get the friendly name associated with the input class.
  102432. * @returns the input friendly name
  102433. */
  102434. getSimpleName(): string;
  102435. }
  102436. }
  102437. declare module BABYLON {
  102438. /**
  102439. * This represents a FPS type of camera controlled by touch.
  102440. * This is like a universal camera minus the Gamepad controls.
  102441. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  102442. */
  102443. export class TouchCamera extends FreeCamera {
  102444. /**
  102445. * Defines the touch sensibility for rotation.
  102446. * The higher the faster.
  102447. */
  102448. touchAngularSensibility: number;
  102449. /**
  102450. * Defines the touch sensibility for move.
  102451. * The higher the faster.
  102452. */
  102453. touchMoveSensibility: number;
  102454. /**
  102455. * Instantiates a new touch camera.
  102456. * This represents a FPS type of camera controlled by touch.
  102457. * This is like a universal camera minus the Gamepad controls.
  102458. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  102459. * @param name Define the name of the camera in the scene
  102460. * @param position Define the start position of the camera in the scene
  102461. * @param scene Define the scene the camera belongs to
  102462. */
  102463. constructor(name: string, position: Vector3, scene: Scene);
  102464. /**
  102465. * Gets the current object class name.
  102466. * @return the class name
  102467. */
  102468. getClassName(): string;
  102469. /** @hidden */
  102470. _setupInputs(): void;
  102471. }
  102472. }
  102473. declare module BABYLON {
  102474. /**
  102475. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  102476. * being tilted forward or back and left or right.
  102477. */
  102478. export class DeviceOrientationCamera extends FreeCamera {
  102479. private _initialQuaternion;
  102480. private _quaternionCache;
  102481. private _tmpDragQuaternion;
  102482. private _disablePointerInputWhenUsingDeviceOrientation;
  102483. /**
  102484. * Creates a new device orientation camera
  102485. * @param name The name of the camera
  102486. * @param position The start position camera
  102487. * @param scene The scene the camera belongs to
  102488. */
  102489. constructor(name: string, position: Vector3, scene: Scene);
  102490. /**
  102491. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  102492. */
  102493. disablePointerInputWhenUsingDeviceOrientation: boolean;
  102494. private _dragFactor;
  102495. /**
  102496. * Enabled turning on the y axis when the orientation sensor is active
  102497. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  102498. */
  102499. enableHorizontalDragging(dragFactor?: number): void;
  102500. /**
  102501. * Gets the current instance class name ("DeviceOrientationCamera").
  102502. * This helps avoiding instanceof at run time.
  102503. * @returns the class name
  102504. */
  102505. getClassName(): string;
  102506. /**
  102507. * @hidden
  102508. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  102509. */
  102510. _checkInputs(): void;
  102511. /**
  102512. * Reset the camera to its default orientation on the specified axis only.
  102513. * @param axis The axis to reset
  102514. */
  102515. resetToCurrentRotation(axis?: Axis): void;
  102516. }
  102517. }
  102518. declare module BABYLON {
  102519. /**
  102520. * Defines supported buttons for XBox360 compatible gamepads
  102521. */
  102522. export enum Xbox360Button {
  102523. /** A */
  102524. A = 0,
  102525. /** B */
  102526. B = 1,
  102527. /** X */
  102528. X = 2,
  102529. /** Y */
  102530. Y = 3,
  102531. /** Start */
  102532. Start = 4,
  102533. /** Back */
  102534. Back = 5,
  102535. /** Left button */
  102536. LB = 6,
  102537. /** Right button */
  102538. RB = 7,
  102539. /** Left stick */
  102540. LeftStick = 8,
  102541. /** Right stick */
  102542. RightStick = 9
  102543. }
  102544. /** Defines values for XBox360 DPad */
  102545. export enum Xbox360Dpad {
  102546. /** Up */
  102547. Up = 0,
  102548. /** Down */
  102549. Down = 1,
  102550. /** Left */
  102551. Left = 2,
  102552. /** Right */
  102553. Right = 3
  102554. }
  102555. /**
  102556. * Defines a XBox360 gamepad
  102557. */
  102558. export class Xbox360Pad extends Gamepad {
  102559. private _leftTrigger;
  102560. private _rightTrigger;
  102561. private _onlefttriggerchanged;
  102562. private _onrighttriggerchanged;
  102563. private _onbuttondown;
  102564. private _onbuttonup;
  102565. private _ondpaddown;
  102566. private _ondpadup;
  102567. /** Observable raised when a button is pressed */
  102568. onButtonDownObservable: Observable<Xbox360Button>;
  102569. /** Observable raised when a button is released */
  102570. onButtonUpObservable: Observable<Xbox360Button>;
  102571. /** Observable raised when a pad is pressed */
  102572. onPadDownObservable: Observable<Xbox360Dpad>;
  102573. /** Observable raised when a pad is released */
  102574. onPadUpObservable: Observable<Xbox360Dpad>;
  102575. private _buttonA;
  102576. private _buttonB;
  102577. private _buttonX;
  102578. private _buttonY;
  102579. private _buttonBack;
  102580. private _buttonStart;
  102581. private _buttonLB;
  102582. private _buttonRB;
  102583. private _buttonLeftStick;
  102584. private _buttonRightStick;
  102585. private _dPadUp;
  102586. private _dPadDown;
  102587. private _dPadLeft;
  102588. private _dPadRight;
  102589. private _isXboxOnePad;
  102590. /**
  102591. * Creates a new XBox360 gamepad object
  102592. * @param id defines the id of this gamepad
  102593. * @param index defines its index
  102594. * @param gamepad defines the internal HTML gamepad object
  102595. * @param xboxOne defines if it is a XBox One gamepad
  102596. */
  102597. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  102598. /**
  102599. * Defines the callback to call when left trigger is pressed
  102600. * @param callback defines the callback to use
  102601. */
  102602. onlefttriggerchanged(callback: (value: number) => void): void;
  102603. /**
  102604. * Defines the callback to call when right trigger is pressed
  102605. * @param callback defines the callback to use
  102606. */
  102607. onrighttriggerchanged(callback: (value: number) => void): void;
  102608. /**
  102609. * Gets the left trigger value
  102610. */
  102611. /**
  102612. * Sets the left trigger value
  102613. */
  102614. leftTrigger: number;
  102615. /**
  102616. * Gets the right trigger value
  102617. */
  102618. /**
  102619. * Sets the right trigger value
  102620. */
  102621. rightTrigger: number;
  102622. /**
  102623. * Defines the callback to call when a button is pressed
  102624. * @param callback defines the callback to use
  102625. */
  102626. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  102627. /**
  102628. * Defines the callback to call when a button is released
  102629. * @param callback defines the callback to use
  102630. */
  102631. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  102632. /**
  102633. * Defines the callback to call when a pad is pressed
  102634. * @param callback defines the callback to use
  102635. */
  102636. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  102637. /**
  102638. * Defines the callback to call when a pad is released
  102639. * @param callback defines the callback to use
  102640. */
  102641. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  102642. private _setButtonValue;
  102643. private _setDPadValue;
  102644. /**
  102645. * Gets the value of the `A` button
  102646. */
  102647. /**
  102648. * Sets the value of the `A` button
  102649. */
  102650. buttonA: number;
  102651. /**
  102652. * Gets the value of the `B` button
  102653. */
  102654. /**
  102655. * Sets the value of the `B` button
  102656. */
  102657. buttonB: number;
  102658. /**
  102659. * Gets the value of the `X` button
  102660. */
  102661. /**
  102662. * Sets the value of the `X` button
  102663. */
  102664. buttonX: number;
  102665. /**
  102666. * Gets the value of the `Y` button
  102667. */
  102668. /**
  102669. * Sets the value of the `Y` button
  102670. */
  102671. buttonY: number;
  102672. /**
  102673. * Gets the value of the `Start` button
  102674. */
  102675. /**
  102676. * Sets the value of the `Start` button
  102677. */
  102678. buttonStart: number;
  102679. /**
  102680. * Gets the value of the `Back` button
  102681. */
  102682. /**
  102683. * Sets the value of the `Back` button
  102684. */
  102685. buttonBack: number;
  102686. /**
  102687. * Gets the value of the `Left` button
  102688. */
  102689. /**
  102690. * Sets the value of the `Left` button
  102691. */
  102692. buttonLB: number;
  102693. /**
  102694. * Gets the value of the `Right` button
  102695. */
  102696. /**
  102697. * Sets the value of the `Right` button
  102698. */
  102699. buttonRB: number;
  102700. /**
  102701. * Gets the value of the Left joystick
  102702. */
  102703. /**
  102704. * Sets the value of the Left joystick
  102705. */
  102706. buttonLeftStick: number;
  102707. /**
  102708. * Gets the value of the Right joystick
  102709. */
  102710. /**
  102711. * Sets the value of the Right joystick
  102712. */
  102713. buttonRightStick: number;
  102714. /**
  102715. * Gets the value of D-pad up
  102716. */
  102717. /**
  102718. * Sets the value of D-pad up
  102719. */
  102720. dPadUp: number;
  102721. /**
  102722. * Gets the value of D-pad down
  102723. */
  102724. /**
  102725. * Sets the value of D-pad down
  102726. */
  102727. dPadDown: number;
  102728. /**
  102729. * Gets the value of D-pad left
  102730. */
  102731. /**
  102732. * Sets the value of D-pad left
  102733. */
  102734. dPadLeft: number;
  102735. /**
  102736. * Gets the value of D-pad right
  102737. */
  102738. /**
  102739. * Sets the value of D-pad right
  102740. */
  102741. dPadRight: number;
  102742. /**
  102743. * Force the gamepad to synchronize with device values
  102744. */
  102745. update(): void;
  102746. /**
  102747. * Disposes the gamepad
  102748. */
  102749. dispose(): void;
  102750. }
  102751. }
  102752. declare module BABYLON {
  102753. /**
  102754. * Defines supported buttons for DualShock compatible gamepads
  102755. */
  102756. export enum DualShockButton {
  102757. /** Cross */
  102758. Cross = 0,
  102759. /** Circle */
  102760. Circle = 1,
  102761. /** Square */
  102762. Square = 2,
  102763. /** Triangle */
  102764. Triangle = 3,
  102765. /** Options */
  102766. Options = 4,
  102767. /** Share */
  102768. Share = 5,
  102769. /** L1 */
  102770. L1 = 6,
  102771. /** R1 */
  102772. R1 = 7,
  102773. /** Left stick */
  102774. LeftStick = 8,
  102775. /** Right stick */
  102776. RightStick = 9
  102777. }
  102778. /** Defines values for DualShock DPad */
  102779. export enum DualShockDpad {
  102780. /** Up */
  102781. Up = 0,
  102782. /** Down */
  102783. Down = 1,
  102784. /** Left */
  102785. Left = 2,
  102786. /** Right */
  102787. Right = 3
  102788. }
  102789. /**
  102790. * Defines a DualShock gamepad
  102791. */
  102792. export class DualShockPad extends Gamepad {
  102793. private _leftTrigger;
  102794. private _rightTrigger;
  102795. private _onlefttriggerchanged;
  102796. private _onrighttriggerchanged;
  102797. private _onbuttondown;
  102798. private _onbuttonup;
  102799. private _ondpaddown;
  102800. private _ondpadup;
  102801. /** Observable raised when a button is pressed */
  102802. onButtonDownObservable: Observable<DualShockButton>;
  102803. /** Observable raised when a button is released */
  102804. onButtonUpObservable: Observable<DualShockButton>;
  102805. /** Observable raised when a pad is pressed */
  102806. onPadDownObservable: Observable<DualShockDpad>;
  102807. /** Observable raised when a pad is released */
  102808. onPadUpObservable: Observable<DualShockDpad>;
  102809. private _buttonCross;
  102810. private _buttonCircle;
  102811. private _buttonSquare;
  102812. private _buttonTriangle;
  102813. private _buttonShare;
  102814. private _buttonOptions;
  102815. private _buttonL1;
  102816. private _buttonR1;
  102817. private _buttonLeftStick;
  102818. private _buttonRightStick;
  102819. private _dPadUp;
  102820. private _dPadDown;
  102821. private _dPadLeft;
  102822. private _dPadRight;
  102823. /**
  102824. * Creates a new DualShock gamepad object
  102825. * @param id defines the id of this gamepad
  102826. * @param index defines its index
  102827. * @param gamepad defines the internal HTML gamepad object
  102828. */
  102829. constructor(id: string, index: number, gamepad: any);
  102830. /**
  102831. * Defines the callback to call when left trigger is pressed
  102832. * @param callback defines the callback to use
  102833. */
  102834. onlefttriggerchanged(callback: (value: number) => void): void;
  102835. /**
  102836. * Defines the callback to call when right trigger is pressed
  102837. * @param callback defines the callback to use
  102838. */
  102839. onrighttriggerchanged(callback: (value: number) => void): void;
  102840. /**
  102841. * Gets the left trigger value
  102842. */
  102843. /**
  102844. * Sets the left trigger value
  102845. */
  102846. leftTrigger: number;
  102847. /**
  102848. * Gets the right trigger value
  102849. */
  102850. /**
  102851. * Sets the right trigger value
  102852. */
  102853. rightTrigger: number;
  102854. /**
  102855. * Defines the callback to call when a button is pressed
  102856. * @param callback defines the callback to use
  102857. */
  102858. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  102859. /**
  102860. * Defines the callback to call when a button is released
  102861. * @param callback defines the callback to use
  102862. */
  102863. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  102864. /**
  102865. * Defines the callback to call when a pad is pressed
  102866. * @param callback defines the callback to use
  102867. */
  102868. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  102869. /**
  102870. * Defines the callback to call when a pad is released
  102871. * @param callback defines the callback to use
  102872. */
  102873. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  102874. private _setButtonValue;
  102875. private _setDPadValue;
  102876. /**
  102877. * Gets the value of the `Cross` button
  102878. */
  102879. /**
  102880. * Sets the value of the `Cross` button
  102881. */
  102882. buttonCross: number;
  102883. /**
  102884. * Gets the value of the `Circle` button
  102885. */
  102886. /**
  102887. * Sets the value of the `Circle` button
  102888. */
  102889. buttonCircle: number;
  102890. /**
  102891. * Gets the value of the `Square` button
  102892. */
  102893. /**
  102894. * Sets the value of the `Square` button
  102895. */
  102896. buttonSquare: number;
  102897. /**
  102898. * Gets the value of the `Triangle` button
  102899. */
  102900. /**
  102901. * Sets the value of the `Triangle` button
  102902. */
  102903. buttonTriangle: number;
  102904. /**
  102905. * Gets the value of the `Options` button
  102906. */
  102907. /**
  102908. * Sets the value of the `Options` button
  102909. */
  102910. buttonOptions: number;
  102911. /**
  102912. * Gets the value of the `Share` button
  102913. */
  102914. /**
  102915. * Sets the value of the `Share` button
  102916. */
  102917. buttonShare: number;
  102918. /**
  102919. * Gets the value of the `L1` button
  102920. */
  102921. /**
  102922. * Sets the value of the `L1` button
  102923. */
  102924. buttonL1: number;
  102925. /**
  102926. * Gets the value of the `R1` button
  102927. */
  102928. /**
  102929. * Sets the value of the `R1` button
  102930. */
  102931. buttonR1: number;
  102932. /**
  102933. * Gets the value of the Left joystick
  102934. */
  102935. /**
  102936. * Sets the value of the Left joystick
  102937. */
  102938. buttonLeftStick: number;
  102939. /**
  102940. * Gets the value of the Right joystick
  102941. */
  102942. /**
  102943. * Sets the value of the Right joystick
  102944. */
  102945. buttonRightStick: number;
  102946. /**
  102947. * Gets the value of D-pad up
  102948. */
  102949. /**
  102950. * Sets the value of D-pad up
  102951. */
  102952. dPadUp: number;
  102953. /**
  102954. * Gets the value of D-pad down
  102955. */
  102956. /**
  102957. * Sets the value of D-pad down
  102958. */
  102959. dPadDown: number;
  102960. /**
  102961. * Gets the value of D-pad left
  102962. */
  102963. /**
  102964. * Sets the value of D-pad left
  102965. */
  102966. dPadLeft: number;
  102967. /**
  102968. * Gets the value of D-pad right
  102969. */
  102970. /**
  102971. * Sets the value of D-pad right
  102972. */
  102973. dPadRight: number;
  102974. /**
  102975. * Force the gamepad to synchronize with device values
  102976. */
  102977. update(): void;
  102978. /**
  102979. * Disposes the gamepad
  102980. */
  102981. dispose(): void;
  102982. }
  102983. }
  102984. declare module BABYLON {
  102985. /**
  102986. * Manager for handling gamepads
  102987. */
  102988. export class GamepadManager {
  102989. private _scene?;
  102990. private _babylonGamepads;
  102991. private _oneGamepadConnected;
  102992. /** @hidden */
  102993. _isMonitoring: boolean;
  102994. private _gamepadEventSupported;
  102995. private _gamepadSupport;
  102996. /**
  102997. * observable to be triggered when the gamepad controller has been connected
  102998. */
  102999. onGamepadConnectedObservable: Observable<Gamepad>;
  103000. /**
  103001. * observable to be triggered when the gamepad controller has been disconnected
  103002. */
  103003. onGamepadDisconnectedObservable: Observable<Gamepad>;
  103004. private _onGamepadConnectedEvent;
  103005. private _onGamepadDisconnectedEvent;
  103006. /**
  103007. * Initializes the gamepad manager
  103008. * @param _scene BabylonJS scene
  103009. */
  103010. constructor(_scene?: Scene | undefined);
  103011. /**
  103012. * The gamepads in the game pad manager
  103013. */
  103014. readonly gamepads: Gamepad[];
  103015. /**
  103016. * Get the gamepad controllers based on type
  103017. * @param type The type of gamepad controller
  103018. * @returns Nullable gamepad
  103019. */
  103020. getGamepadByType(type?: number): Nullable<Gamepad>;
  103021. /**
  103022. * Disposes the gamepad manager
  103023. */
  103024. dispose(): void;
  103025. private _addNewGamepad;
  103026. private _startMonitoringGamepads;
  103027. private _stopMonitoringGamepads;
  103028. /** @hidden */
  103029. _checkGamepadsStatus(): void;
  103030. private _updateGamepadObjects;
  103031. }
  103032. }
  103033. declare module BABYLON {
  103034. interface Scene {
  103035. /** @hidden */
  103036. _gamepadManager: Nullable<GamepadManager>;
  103037. /**
  103038. * Gets the gamepad manager associated with the scene
  103039. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  103040. */
  103041. gamepadManager: GamepadManager;
  103042. }
  103043. /**
  103044. * Interface representing a free camera inputs manager
  103045. */
  103046. interface FreeCameraInputsManager {
  103047. /**
  103048. * Adds gamepad input support to the FreeCameraInputsManager.
  103049. * @returns the FreeCameraInputsManager
  103050. */
  103051. addGamepad(): FreeCameraInputsManager;
  103052. }
  103053. /**
  103054. * Interface representing an arc rotate camera inputs manager
  103055. */
  103056. interface ArcRotateCameraInputsManager {
  103057. /**
  103058. * Adds gamepad input support to the ArcRotateCamera InputManager.
  103059. * @returns the camera inputs manager
  103060. */
  103061. addGamepad(): ArcRotateCameraInputsManager;
  103062. }
  103063. /**
  103064. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  103065. */
  103066. export class GamepadSystemSceneComponent implements ISceneComponent {
  103067. /**
  103068. * The component name helpfull to identify the component in the list of scene components.
  103069. */
  103070. readonly name: string;
  103071. /**
  103072. * The scene the component belongs to.
  103073. */
  103074. scene: Scene;
  103075. /**
  103076. * Creates a new instance of the component for the given scene
  103077. * @param scene Defines the scene to register the component in
  103078. */
  103079. constructor(scene: Scene);
  103080. /**
  103081. * Registers the component in a given scene
  103082. */
  103083. register(): void;
  103084. /**
  103085. * Rebuilds the elements related to this component in case of
  103086. * context lost for instance.
  103087. */
  103088. rebuild(): void;
  103089. /**
  103090. * Disposes the component and the associated ressources
  103091. */
  103092. dispose(): void;
  103093. private _beforeCameraUpdate;
  103094. }
  103095. }
  103096. declare module BABYLON {
  103097. /**
  103098. * 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,
  103099. * which still works and will still be found in many Playgrounds.
  103100. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  103101. */
  103102. export class UniversalCamera extends TouchCamera {
  103103. /**
  103104. * Defines the gamepad rotation sensiblity.
  103105. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  103106. */
  103107. gamepadAngularSensibility: number;
  103108. /**
  103109. * Defines the gamepad move sensiblity.
  103110. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  103111. */
  103112. gamepadMoveSensibility: number;
  103113. /**
  103114. * 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,
  103115. * which still works and will still be found in many Playgrounds.
  103116. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  103117. * @param name Define the name of the camera in the scene
  103118. * @param position Define the start position of the camera in the scene
  103119. * @param scene Define the scene the camera belongs to
  103120. */
  103121. constructor(name: string, position: Vector3, scene: Scene);
  103122. /**
  103123. * Gets the current object class name.
  103124. * @return the class name
  103125. */
  103126. getClassName(): string;
  103127. }
  103128. }
  103129. declare module BABYLON {
  103130. /**
  103131. * This represents a FPS type of camera. This is only here for back compat purpose.
  103132. * Please use the UniversalCamera instead as both are identical.
  103133. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  103134. */
  103135. export class GamepadCamera extends UniversalCamera {
  103136. /**
  103137. * Instantiates a new Gamepad Camera
  103138. * This represents a FPS type of camera. This is only here for back compat purpose.
  103139. * Please use the UniversalCamera instead as both are identical.
  103140. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  103141. * @param name Define the name of the camera in the scene
  103142. * @param position Define the start position of the camera in the scene
  103143. * @param scene Define the scene the camera belongs to
  103144. */
  103145. constructor(name: string, position: Vector3, scene: Scene);
  103146. /**
  103147. * Gets the current object class name.
  103148. * @return the class name
  103149. */
  103150. getClassName(): string;
  103151. }
  103152. }
  103153. declare module BABYLON {
  103154. /** @hidden */
  103155. export var passPixelShader: {
  103156. name: string;
  103157. shader: string;
  103158. };
  103159. }
  103160. declare module BABYLON {
  103161. /** @hidden */
  103162. export var passCubePixelShader: {
  103163. name: string;
  103164. shader: string;
  103165. };
  103166. }
  103167. declare module BABYLON {
  103168. /**
  103169. * PassPostProcess which produces an output the same as it's input
  103170. */
  103171. export class PassPostProcess extends PostProcess {
  103172. /**
  103173. * Creates the PassPostProcess
  103174. * @param name The name of the effect.
  103175. * @param options The required width/height ratio to downsize to before computing the render pass.
  103176. * @param camera The camera to apply the render pass to.
  103177. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103178. * @param engine The engine which the post process will be applied. (default: current engine)
  103179. * @param reusable If the post process can be reused on the same frame. (default: false)
  103180. * @param textureType The type of texture to be used when performing the post processing.
  103181. * @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)
  103182. */
  103183. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  103184. }
  103185. /**
  103186. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  103187. */
  103188. export class PassCubePostProcess extends PostProcess {
  103189. private _face;
  103190. /**
  103191. * Gets or sets the cube face to display.
  103192. * * 0 is +X
  103193. * * 1 is -X
  103194. * * 2 is +Y
  103195. * * 3 is -Y
  103196. * * 4 is +Z
  103197. * * 5 is -Z
  103198. */
  103199. face: number;
  103200. /**
  103201. * Creates the PassCubePostProcess
  103202. * @param name The name of the effect.
  103203. * @param options The required width/height ratio to downsize to before computing the render pass.
  103204. * @param camera The camera to apply the render pass to.
  103205. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103206. * @param engine The engine which the post process will be applied. (default: current engine)
  103207. * @param reusable If the post process can be reused on the same frame. (default: false)
  103208. * @param textureType The type of texture to be used when performing the post processing.
  103209. * @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)
  103210. */
  103211. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  103212. }
  103213. }
  103214. declare module BABYLON {
  103215. /** @hidden */
  103216. export var anaglyphPixelShader: {
  103217. name: string;
  103218. shader: string;
  103219. };
  103220. }
  103221. declare module BABYLON {
  103222. /**
  103223. * Postprocess used to generate anaglyphic rendering
  103224. */
  103225. export class AnaglyphPostProcess extends PostProcess {
  103226. private _passedProcess;
  103227. /**
  103228. * Creates a new AnaglyphPostProcess
  103229. * @param name defines postprocess name
  103230. * @param options defines creation options or target ratio scale
  103231. * @param rigCameras defines cameras using this postprocess
  103232. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  103233. * @param engine defines hosting engine
  103234. * @param reusable defines if the postprocess will be reused multiple times per frame
  103235. */
  103236. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  103237. }
  103238. }
  103239. declare module BABYLON {
  103240. /**
  103241. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  103242. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  103243. */
  103244. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  103245. /**
  103246. * Creates a new AnaglyphArcRotateCamera
  103247. * @param name defines camera name
  103248. * @param alpha defines alpha angle (in radians)
  103249. * @param beta defines beta angle (in radians)
  103250. * @param radius defines radius
  103251. * @param target defines camera target
  103252. * @param interaxialDistance defines distance between each color axis
  103253. * @param scene defines the hosting scene
  103254. */
  103255. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  103256. /**
  103257. * Gets camera class name
  103258. * @returns AnaglyphArcRotateCamera
  103259. */
  103260. getClassName(): string;
  103261. }
  103262. }
  103263. declare module BABYLON {
  103264. /**
  103265. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  103266. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  103267. */
  103268. export class AnaglyphFreeCamera extends FreeCamera {
  103269. /**
  103270. * Creates a new AnaglyphFreeCamera
  103271. * @param name defines camera name
  103272. * @param position defines initial position
  103273. * @param interaxialDistance defines distance between each color axis
  103274. * @param scene defines the hosting scene
  103275. */
  103276. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  103277. /**
  103278. * Gets camera class name
  103279. * @returns AnaglyphFreeCamera
  103280. */
  103281. getClassName(): string;
  103282. }
  103283. }
  103284. declare module BABYLON {
  103285. /**
  103286. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  103287. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  103288. */
  103289. export class AnaglyphGamepadCamera extends GamepadCamera {
  103290. /**
  103291. * Creates a new AnaglyphGamepadCamera
  103292. * @param name defines camera name
  103293. * @param position defines initial position
  103294. * @param interaxialDistance defines distance between each color axis
  103295. * @param scene defines the hosting scene
  103296. */
  103297. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  103298. /**
  103299. * Gets camera class name
  103300. * @returns AnaglyphGamepadCamera
  103301. */
  103302. getClassName(): string;
  103303. }
  103304. }
  103305. declare module BABYLON {
  103306. /**
  103307. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  103308. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  103309. */
  103310. export class AnaglyphUniversalCamera extends UniversalCamera {
  103311. /**
  103312. * Creates a new AnaglyphUniversalCamera
  103313. * @param name defines camera name
  103314. * @param position defines initial position
  103315. * @param interaxialDistance defines distance between each color axis
  103316. * @param scene defines the hosting scene
  103317. */
  103318. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  103319. /**
  103320. * Gets camera class name
  103321. * @returns AnaglyphUniversalCamera
  103322. */
  103323. getClassName(): string;
  103324. }
  103325. }
  103326. declare module BABYLON {
  103327. /** @hidden */
  103328. export var stereoscopicInterlacePixelShader: {
  103329. name: string;
  103330. shader: string;
  103331. };
  103332. }
  103333. declare module BABYLON {
  103334. /**
  103335. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  103336. */
  103337. export class StereoscopicInterlacePostProcess extends PostProcess {
  103338. private _stepSize;
  103339. private _passedProcess;
  103340. /**
  103341. * Initializes a StereoscopicInterlacePostProcess
  103342. * @param name The name of the effect.
  103343. * @param rigCameras The rig cameras to be appled to the post process
  103344. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  103345. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103346. * @param engine The engine which the post process will be applied. (default: current engine)
  103347. * @param reusable If the post process can be reused on the same frame. (default: false)
  103348. */
  103349. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  103350. }
  103351. }
  103352. declare module BABYLON {
  103353. /**
  103354. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  103355. * @see http://doc.babylonjs.com/features/cameras
  103356. */
  103357. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  103358. /**
  103359. * Creates a new StereoscopicArcRotateCamera
  103360. * @param name defines camera name
  103361. * @param alpha defines alpha angle (in radians)
  103362. * @param beta defines beta angle (in radians)
  103363. * @param radius defines radius
  103364. * @param target defines camera target
  103365. * @param interaxialDistance defines distance between each color axis
  103366. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  103367. * @param scene defines the hosting scene
  103368. */
  103369. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  103370. /**
  103371. * Gets camera class name
  103372. * @returns StereoscopicArcRotateCamera
  103373. */
  103374. getClassName(): string;
  103375. }
  103376. }
  103377. declare module BABYLON {
  103378. /**
  103379. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  103380. * @see http://doc.babylonjs.com/features/cameras
  103381. */
  103382. export class StereoscopicFreeCamera extends FreeCamera {
  103383. /**
  103384. * Creates a new StereoscopicFreeCamera
  103385. * @param name defines camera name
  103386. * @param position defines initial position
  103387. * @param interaxialDistance defines distance between each color axis
  103388. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  103389. * @param scene defines the hosting scene
  103390. */
  103391. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  103392. /**
  103393. * Gets camera class name
  103394. * @returns StereoscopicFreeCamera
  103395. */
  103396. getClassName(): string;
  103397. }
  103398. }
  103399. declare module BABYLON {
  103400. /**
  103401. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  103402. * @see http://doc.babylonjs.com/features/cameras
  103403. */
  103404. export class StereoscopicGamepadCamera extends GamepadCamera {
  103405. /**
  103406. * Creates a new StereoscopicGamepadCamera
  103407. * @param name defines camera name
  103408. * @param position defines initial position
  103409. * @param interaxialDistance defines distance between each color axis
  103410. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  103411. * @param scene defines the hosting scene
  103412. */
  103413. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  103414. /**
  103415. * Gets camera class name
  103416. * @returns StereoscopicGamepadCamera
  103417. */
  103418. getClassName(): string;
  103419. }
  103420. }
  103421. declare module BABYLON {
  103422. /**
  103423. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  103424. * @see http://doc.babylonjs.com/features/cameras
  103425. */
  103426. export class StereoscopicUniversalCamera extends UniversalCamera {
  103427. /**
  103428. * Creates a new StereoscopicUniversalCamera
  103429. * @param name defines camera name
  103430. * @param position defines initial position
  103431. * @param interaxialDistance defines distance between each color axis
  103432. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  103433. * @param scene defines the hosting scene
  103434. */
  103435. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  103436. /**
  103437. * Gets camera class name
  103438. * @returns StereoscopicUniversalCamera
  103439. */
  103440. getClassName(): string;
  103441. }
  103442. }
  103443. declare module BABYLON {
  103444. /**
  103445. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  103446. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  103447. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  103448. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  103449. */
  103450. export class VirtualJoysticksCamera extends FreeCamera {
  103451. /**
  103452. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  103453. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  103454. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  103455. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  103456. * @param name Define the name of the camera in the scene
  103457. * @param position Define the start position of the camera in the scene
  103458. * @param scene Define the scene the camera belongs to
  103459. */
  103460. constructor(name: string, position: Vector3, scene: Scene);
  103461. /**
  103462. * Gets the current object class name.
  103463. * @return the class name
  103464. */
  103465. getClassName(): string;
  103466. }
  103467. }
  103468. declare module BABYLON {
  103469. /**
  103470. * This represents all the required metrics to create a VR camera.
  103471. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  103472. */
  103473. export class VRCameraMetrics {
  103474. /**
  103475. * Define the horizontal resolution off the screen.
  103476. */
  103477. hResolution: number;
  103478. /**
  103479. * Define the vertical resolution off the screen.
  103480. */
  103481. vResolution: number;
  103482. /**
  103483. * Define the horizontal screen size.
  103484. */
  103485. hScreenSize: number;
  103486. /**
  103487. * Define the vertical screen size.
  103488. */
  103489. vScreenSize: number;
  103490. /**
  103491. * Define the vertical screen center position.
  103492. */
  103493. vScreenCenter: number;
  103494. /**
  103495. * Define the distance of the eyes to the screen.
  103496. */
  103497. eyeToScreenDistance: number;
  103498. /**
  103499. * Define the distance between both lenses
  103500. */
  103501. lensSeparationDistance: number;
  103502. /**
  103503. * Define the distance between both viewer's eyes.
  103504. */
  103505. interpupillaryDistance: number;
  103506. /**
  103507. * Define the distortion factor of the VR postprocess.
  103508. * Please, touch with care.
  103509. */
  103510. distortionK: number[];
  103511. /**
  103512. * Define the chromatic aberration correction factors for the VR post process.
  103513. */
  103514. chromaAbCorrection: number[];
  103515. /**
  103516. * Define the scale factor of the post process.
  103517. * The smaller the better but the slower.
  103518. */
  103519. postProcessScaleFactor: number;
  103520. /**
  103521. * Define an offset for the lens center.
  103522. */
  103523. lensCenterOffset: number;
  103524. /**
  103525. * Define if the current vr camera should compensate the distortion of the lense or not.
  103526. */
  103527. compensateDistortion: boolean;
  103528. /**
  103529. * Defines if multiview should be enabled when rendering (Default: false)
  103530. */
  103531. multiviewEnabled: boolean;
  103532. /**
  103533. * Gets the rendering aspect ratio based on the provided resolutions.
  103534. */
  103535. readonly aspectRatio: number;
  103536. /**
  103537. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  103538. */
  103539. readonly aspectRatioFov: number;
  103540. /**
  103541. * @hidden
  103542. */
  103543. readonly leftHMatrix: Matrix;
  103544. /**
  103545. * @hidden
  103546. */
  103547. readonly rightHMatrix: Matrix;
  103548. /**
  103549. * @hidden
  103550. */
  103551. readonly leftPreViewMatrix: Matrix;
  103552. /**
  103553. * @hidden
  103554. */
  103555. readonly rightPreViewMatrix: Matrix;
  103556. /**
  103557. * Get the default VRMetrics based on the most generic setup.
  103558. * @returns the default vr metrics
  103559. */
  103560. static GetDefault(): VRCameraMetrics;
  103561. }
  103562. }
  103563. declare module BABYLON {
  103564. /** @hidden */
  103565. export var vrDistortionCorrectionPixelShader: {
  103566. name: string;
  103567. shader: string;
  103568. };
  103569. }
  103570. declare module BABYLON {
  103571. /**
  103572. * VRDistortionCorrectionPostProcess used for mobile VR
  103573. */
  103574. export class VRDistortionCorrectionPostProcess extends PostProcess {
  103575. private _isRightEye;
  103576. private _distortionFactors;
  103577. private _postProcessScaleFactor;
  103578. private _lensCenterOffset;
  103579. private _scaleIn;
  103580. private _scaleFactor;
  103581. private _lensCenter;
  103582. /**
  103583. * Initializes the VRDistortionCorrectionPostProcess
  103584. * @param name The name of the effect.
  103585. * @param camera The camera to apply the render pass to.
  103586. * @param isRightEye If this is for the right eye distortion
  103587. * @param vrMetrics All the required metrics for the VR camera
  103588. */
  103589. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  103590. }
  103591. }
  103592. declare module BABYLON {
  103593. /**
  103594. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  103595. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  103596. */
  103597. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  103598. /**
  103599. * Creates a new VRDeviceOrientationArcRotateCamera
  103600. * @param name defines camera name
  103601. * @param alpha defines the camera rotation along the logitudinal axis
  103602. * @param beta defines the camera rotation along the latitudinal axis
  103603. * @param radius defines the camera distance from its target
  103604. * @param target defines the camera target
  103605. * @param scene defines the scene the camera belongs to
  103606. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  103607. * @param vrCameraMetrics defines the vr metrics associated to the camera
  103608. */
  103609. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  103610. /**
  103611. * Gets camera class name
  103612. * @returns VRDeviceOrientationArcRotateCamera
  103613. */
  103614. getClassName(): string;
  103615. }
  103616. }
  103617. declare module BABYLON {
  103618. /**
  103619. * Camera used to simulate VR rendering (based on FreeCamera)
  103620. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  103621. */
  103622. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  103623. /**
  103624. * Creates a new VRDeviceOrientationFreeCamera
  103625. * @param name defines camera name
  103626. * @param position defines the start position of the camera
  103627. * @param scene defines the scene the camera belongs to
  103628. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  103629. * @param vrCameraMetrics defines the vr metrics associated to the camera
  103630. */
  103631. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  103632. /**
  103633. * Gets camera class name
  103634. * @returns VRDeviceOrientationFreeCamera
  103635. */
  103636. getClassName(): string;
  103637. }
  103638. }
  103639. declare module BABYLON {
  103640. /**
  103641. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  103642. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  103643. */
  103644. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  103645. /**
  103646. * Creates a new VRDeviceOrientationGamepadCamera
  103647. * @param name defines camera name
  103648. * @param position defines the start position of the camera
  103649. * @param scene defines the scene the camera belongs to
  103650. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  103651. * @param vrCameraMetrics defines the vr metrics associated to the camera
  103652. */
  103653. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  103654. /**
  103655. * Gets camera class name
  103656. * @returns VRDeviceOrientationGamepadCamera
  103657. */
  103658. getClassName(): string;
  103659. }
  103660. }
  103661. declare module BABYLON {
  103662. /**
  103663. * Base class of materials working in push mode in babylon JS
  103664. * @hidden
  103665. */
  103666. export class PushMaterial extends Material {
  103667. protected _activeEffect: Effect;
  103668. protected _normalMatrix: Matrix;
  103669. /**
  103670. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  103671. * This means that the material can keep using a previous shader while a new one is being compiled.
  103672. * This is mostly used when shader parallel compilation is supported (true by default)
  103673. */
  103674. allowShaderHotSwapping: boolean;
  103675. constructor(name: string, scene: Scene);
  103676. getEffect(): Effect;
  103677. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  103678. /**
  103679. * Binds the given world matrix to the active effect
  103680. *
  103681. * @param world the matrix to bind
  103682. */
  103683. bindOnlyWorldMatrix(world: Matrix): void;
  103684. /**
  103685. * Binds the given normal matrix to the active effect
  103686. *
  103687. * @param normalMatrix the matrix to bind
  103688. */
  103689. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  103690. bind(world: Matrix, mesh?: Mesh): void;
  103691. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  103692. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  103693. }
  103694. }
  103695. declare module BABYLON {
  103696. /**
  103697. * This groups all the flags used to control the materials channel.
  103698. */
  103699. export class MaterialFlags {
  103700. private static _DiffuseTextureEnabled;
  103701. /**
  103702. * Are diffuse textures enabled in the application.
  103703. */
  103704. static DiffuseTextureEnabled: boolean;
  103705. private static _AmbientTextureEnabled;
  103706. /**
  103707. * Are ambient textures enabled in the application.
  103708. */
  103709. static AmbientTextureEnabled: boolean;
  103710. private static _OpacityTextureEnabled;
  103711. /**
  103712. * Are opacity textures enabled in the application.
  103713. */
  103714. static OpacityTextureEnabled: boolean;
  103715. private static _ReflectionTextureEnabled;
  103716. /**
  103717. * Are reflection textures enabled in the application.
  103718. */
  103719. static ReflectionTextureEnabled: boolean;
  103720. private static _EmissiveTextureEnabled;
  103721. /**
  103722. * Are emissive textures enabled in the application.
  103723. */
  103724. static EmissiveTextureEnabled: boolean;
  103725. private static _SpecularTextureEnabled;
  103726. /**
  103727. * Are specular textures enabled in the application.
  103728. */
  103729. static SpecularTextureEnabled: boolean;
  103730. private static _BumpTextureEnabled;
  103731. /**
  103732. * Are bump textures enabled in the application.
  103733. */
  103734. static BumpTextureEnabled: boolean;
  103735. private static _LightmapTextureEnabled;
  103736. /**
  103737. * Are lightmap textures enabled in the application.
  103738. */
  103739. static LightmapTextureEnabled: boolean;
  103740. private static _RefractionTextureEnabled;
  103741. /**
  103742. * Are refraction textures enabled in the application.
  103743. */
  103744. static RefractionTextureEnabled: boolean;
  103745. private static _ColorGradingTextureEnabled;
  103746. /**
  103747. * Are color grading textures enabled in the application.
  103748. */
  103749. static ColorGradingTextureEnabled: boolean;
  103750. private static _FresnelEnabled;
  103751. /**
  103752. * Are fresnels enabled in the application.
  103753. */
  103754. static FresnelEnabled: boolean;
  103755. private static _ClearCoatTextureEnabled;
  103756. /**
  103757. * Are clear coat textures enabled in the application.
  103758. */
  103759. static ClearCoatTextureEnabled: boolean;
  103760. private static _ClearCoatBumpTextureEnabled;
  103761. /**
  103762. * Are clear coat bump textures enabled in the application.
  103763. */
  103764. static ClearCoatBumpTextureEnabled: boolean;
  103765. private static _ClearCoatTintTextureEnabled;
  103766. /**
  103767. * Are clear coat tint textures enabled in the application.
  103768. */
  103769. static ClearCoatTintTextureEnabled: boolean;
  103770. private static _SheenTextureEnabled;
  103771. /**
  103772. * Are sheen textures enabled in the application.
  103773. */
  103774. static SheenTextureEnabled: boolean;
  103775. private static _AnisotropicTextureEnabled;
  103776. /**
  103777. * Are anisotropic textures enabled in the application.
  103778. */
  103779. static AnisotropicTextureEnabled: boolean;
  103780. private static _ThicknessTextureEnabled;
  103781. /**
  103782. * Are thickness textures enabled in the application.
  103783. */
  103784. static ThicknessTextureEnabled: boolean;
  103785. }
  103786. }
  103787. declare module BABYLON {
  103788. /** @hidden */
  103789. export var defaultFragmentDeclaration: {
  103790. name: string;
  103791. shader: string;
  103792. };
  103793. }
  103794. declare module BABYLON {
  103795. /** @hidden */
  103796. export var defaultUboDeclaration: {
  103797. name: string;
  103798. shader: string;
  103799. };
  103800. }
  103801. declare module BABYLON {
  103802. /** @hidden */
  103803. export var lightFragmentDeclaration: {
  103804. name: string;
  103805. shader: string;
  103806. };
  103807. }
  103808. declare module BABYLON {
  103809. /** @hidden */
  103810. export var lightUboDeclaration: {
  103811. name: string;
  103812. shader: string;
  103813. };
  103814. }
  103815. declare module BABYLON {
  103816. /** @hidden */
  103817. export var lightsFragmentFunctions: {
  103818. name: string;
  103819. shader: string;
  103820. };
  103821. }
  103822. declare module BABYLON {
  103823. /** @hidden */
  103824. export var shadowsFragmentFunctions: {
  103825. name: string;
  103826. shader: string;
  103827. };
  103828. }
  103829. declare module BABYLON {
  103830. /** @hidden */
  103831. export var fresnelFunction: {
  103832. name: string;
  103833. shader: string;
  103834. };
  103835. }
  103836. declare module BABYLON {
  103837. /** @hidden */
  103838. export var reflectionFunction: {
  103839. name: string;
  103840. shader: string;
  103841. };
  103842. }
  103843. declare module BABYLON {
  103844. /** @hidden */
  103845. export var bumpFragmentFunctions: {
  103846. name: string;
  103847. shader: string;
  103848. };
  103849. }
  103850. declare module BABYLON {
  103851. /** @hidden */
  103852. export var logDepthDeclaration: {
  103853. name: string;
  103854. shader: string;
  103855. };
  103856. }
  103857. declare module BABYLON {
  103858. /** @hidden */
  103859. export var bumpFragment: {
  103860. name: string;
  103861. shader: string;
  103862. };
  103863. }
  103864. declare module BABYLON {
  103865. /** @hidden */
  103866. export var depthPrePass: {
  103867. name: string;
  103868. shader: string;
  103869. };
  103870. }
  103871. declare module BABYLON {
  103872. /** @hidden */
  103873. export var lightFragment: {
  103874. name: string;
  103875. shader: string;
  103876. };
  103877. }
  103878. declare module BABYLON {
  103879. /** @hidden */
  103880. export var logDepthFragment: {
  103881. name: string;
  103882. shader: string;
  103883. };
  103884. }
  103885. declare module BABYLON {
  103886. /** @hidden */
  103887. export var defaultPixelShader: {
  103888. name: string;
  103889. shader: string;
  103890. };
  103891. }
  103892. declare module BABYLON {
  103893. /** @hidden */
  103894. export var defaultVertexDeclaration: {
  103895. name: string;
  103896. shader: string;
  103897. };
  103898. }
  103899. declare module BABYLON {
  103900. /** @hidden */
  103901. export var bumpVertexDeclaration: {
  103902. name: string;
  103903. shader: string;
  103904. };
  103905. }
  103906. declare module BABYLON {
  103907. /** @hidden */
  103908. export var bumpVertex: {
  103909. name: string;
  103910. shader: string;
  103911. };
  103912. }
  103913. declare module BABYLON {
  103914. /** @hidden */
  103915. export var fogVertex: {
  103916. name: string;
  103917. shader: string;
  103918. };
  103919. }
  103920. declare module BABYLON {
  103921. /** @hidden */
  103922. export var shadowsVertex: {
  103923. name: string;
  103924. shader: string;
  103925. };
  103926. }
  103927. declare module BABYLON {
  103928. /** @hidden */
  103929. export var pointCloudVertex: {
  103930. name: string;
  103931. shader: string;
  103932. };
  103933. }
  103934. declare module BABYLON {
  103935. /** @hidden */
  103936. export var logDepthVertex: {
  103937. name: string;
  103938. shader: string;
  103939. };
  103940. }
  103941. declare module BABYLON {
  103942. /** @hidden */
  103943. export var defaultVertexShader: {
  103944. name: string;
  103945. shader: string;
  103946. };
  103947. }
  103948. declare module BABYLON {
  103949. /** @hidden */
  103950. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  103951. MAINUV1: boolean;
  103952. MAINUV2: boolean;
  103953. DIFFUSE: boolean;
  103954. DIFFUSEDIRECTUV: number;
  103955. AMBIENT: boolean;
  103956. AMBIENTDIRECTUV: number;
  103957. OPACITY: boolean;
  103958. OPACITYDIRECTUV: number;
  103959. OPACITYRGB: boolean;
  103960. REFLECTION: boolean;
  103961. EMISSIVE: boolean;
  103962. EMISSIVEDIRECTUV: number;
  103963. SPECULAR: boolean;
  103964. SPECULARDIRECTUV: number;
  103965. BUMP: boolean;
  103966. BUMPDIRECTUV: number;
  103967. PARALLAX: boolean;
  103968. PARALLAXOCCLUSION: boolean;
  103969. SPECULAROVERALPHA: boolean;
  103970. CLIPPLANE: boolean;
  103971. CLIPPLANE2: boolean;
  103972. CLIPPLANE3: boolean;
  103973. CLIPPLANE4: boolean;
  103974. ALPHATEST: boolean;
  103975. DEPTHPREPASS: boolean;
  103976. ALPHAFROMDIFFUSE: boolean;
  103977. POINTSIZE: boolean;
  103978. FOG: boolean;
  103979. SPECULARTERM: boolean;
  103980. DIFFUSEFRESNEL: boolean;
  103981. OPACITYFRESNEL: boolean;
  103982. REFLECTIONFRESNEL: boolean;
  103983. REFRACTIONFRESNEL: boolean;
  103984. EMISSIVEFRESNEL: boolean;
  103985. FRESNEL: boolean;
  103986. NORMAL: boolean;
  103987. UV1: boolean;
  103988. UV2: boolean;
  103989. VERTEXCOLOR: boolean;
  103990. VERTEXALPHA: boolean;
  103991. NUM_BONE_INFLUENCERS: number;
  103992. BonesPerMesh: number;
  103993. BONETEXTURE: boolean;
  103994. INSTANCES: boolean;
  103995. GLOSSINESS: boolean;
  103996. ROUGHNESS: boolean;
  103997. EMISSIVEASILLUMINATION: boolean;
  103998. LINKEMISSIVEWITHDIFFUSE: boolean;
  103999. REFLECTIONFRESNELFROMSPECULAR: boolean;
  104000. LIGHTMAP: boolean;
  104001. LIGHTMAPDIRECTUV: number;
  104002. OBJECTSPACE_NORMALMAP: boolean;
  104003. USELIGHTMAPASSHADOWMAP: boolean;
  104004. REFLECTIONMAP_3D: boolean;
  104005. REFLECTIONMAP_SPHERICAL: boolean;
  104006. REFLECTIONMAP_PLANAR: boolean;
  104007. REFLECTIONMAP_CUBIC: boolean;
  104008. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  104009. REFLECTIONMAP_PROJECTION: boolean;
  104010. REFLECTIONMAP_SKYBOX: boolean;
  104011. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  104012. REFLECTIONMAP_EXPLICIT: boolean;
  104013. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  104014. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  104015. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  104016. INVERTCUBICMAP: boolean;
  104017. LOGARITHMICDEPTH: boolean;
  104018. REFRACTION: boolean;
  104019. REFRACTIONMAP_3D: boolean;
  104020. REFLECTIONOVERALPHA: boolean;
  104021. TWOSIDEDLIGHTING: boolean;
  104022. SHADOWFLOAT: boolean;
  104023. MORPHTARGETS: boolean;
  104024. MORPHTARGETS_NORMAL: boolean;
  104025. MORPHTARGETS_TANGENT: boolean;
  104026. MORPHTARGETS_UV: boolean;
  104027. NUM_MORPH_INFLUENCERS: number;
  104028. NONUNIFORMSCALING: boolean;
  104029. PREMULTIPLYALPHA: boolean;
  104030. IMAGEPROCESSING: boolean;
  104031. VIGNETTE: boolean;
  104032. VIGNETTEBLENDMODEMULTIPLY: boolean;
  104033. VIGNETTEBLENDMODEOPAQUE: boolean;
  104034. TONEMAPPING: boolean;
  104035. TONEMAPPING_ACES: boolean;
  104036. CONTRAST: boolean;
  104037. COLORCURVES: boolean;
  104038. COLORGRADING: boolean;
  104039. COLORGRADING3D: boolean;
  104040. SAMPLER3DGREENDEPTH: boolean;
  104041. SAMPLER3DBGRMAP: boolean;
  104042. IMAGEPROCESSINGPOSTPROCESS: boolean;
  104043. MULTIVIEW: boolean;
  104044. /**
  104045. * If the reflection texture on this material is in linear color space
  104046. * @hidden
  104047. */
  104048. IS_REFLECTION_LINEAR: boolean;
  104049. /**
  104050. * If the refraction texture on this material is in linear color space
  104051. * @hidden
  104052. */
  104053. IS_REFRACTION_LINEAR: boolean;
  104054. EXPOSURE: boolean;
  104055. constructor();
  104056. setReflectionMode(modeToEnable: string): void;
  104057. }
  104058. /**
  104059. * This is the default material used in Babylon. It is the best trade off between quality
  104060. * and performances.
  104061. * @see http://doc.babylonjs.com/babylon101/materials
  104062. */
  104063. export class StandardMaterial extends PushMaterial {
  104064. private _diffuseTexture;
  104065. /**
  104066. * The basic texture of the material as viewed under a light.
  104067. */
  104068. diffuseTexture: Nullable<BaseTexture>;
  104069. private _ambientTexture;
  104070. /**
  104071. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  104072. */
  104073. ambientTexture: Nullable<BaseTexture>;
  104074. private _opacityTexture;
  104075. /**
  104076. * Define the transparency of the material from a texture.
  104077. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  104078. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  104079. */
  104080. opacityTexture: Nullable<BaseTexture>;
  104081. private _reflectionTexture;
  104082. /**
  104083. * Define the texture used to display the reflection.
  104084. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104085. */
  104086. reflectionTexture: Nullable<BaseTexture>;
  104087. private _emissiveTexture;
  104088. /**
  104089. * Define texture of the material as if self lit.
  104090. * This will be mixed in the final result even in the absence of light.
  104091. */
  104092. emissiveTexture: Nullable<BaseTexture>;
  104093. private _specularTexture;
  104094. /**
  104095. * Define how the color and intensity of the highlight given by the light in the material.
  104096. */
  104097. specularTexture: Nullable<BaseTexture>;
  104098. private _bumpTexture;
  104099. /**
  104100. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  104101. * 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.
  104102. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  104103. */
  104104. bumpTexture: Nullable<BaseTexture>;
  104105. private _lightmapTexture;
  104106. /**
  104107. * Complex lighting can be computationally expensive to compute at runtime.
  104108. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  104109. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  104110. */
  104111. lightmapTexture: Nullable<BaseTexture>;
  104112. private _refractionTexture;
  104113. /**
  104114. * Define the texture used to display the refraction.
  104115. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104116. */
  104117. refractionTexture: Nullable<BaseTexture>;
  104118. /**
  104119. * The color of the material lit by the environmental background lighting.
  104120. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  104121. */
  104122. ambientColor: Color3;
  104123. /**
  104124. * The basic color of the material as viewed under a light.
  104125. */
  104126. diffuseColor: Color3;
  104127. /**
  104128. * Define how the color and intensity of the highlight given by the light in the material.
  104129. */
  104130. specularColor: Color3;
  104131. /**
  104132. * Define the color of the material as if self lit.
  104133. * This will be mixed in the final result even in the absence of light.
  104134. */
  104135. emissiveColor: Color3;
  104136. /**
  104137. * Defines how sharp are the highlights in the material.
  104138. * The bigger the value the sharper giving a more glossy feeling to the result.
  104139. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  104140. */
  104141. specularPower: number;
  104142. private _useAlphaFromDiffuseTexture;
  104143. /**
  104144. * Does the transparency come from the diffuse texture alpha channel.
  104145. */
  104146. useAlphaFromDiffuseTexture: boolean;
  104147. private _useEmissiveAsIllumination;
  104148. /**
  104149. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  104150. */
  104151. useEmissiveAsIllumination: boolean;
  104152. private _linkEmissiveWithDiffuse;
  104153. /**
  104154. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  104155. * the emissive level when the final color is close to one.
  104156. */
  104157. linkEmissiveWithDiffuse: boolean;
  104158. private _useSpecularOverAlpha;
  104159. /**
  104160. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  104161. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  104162. */
  104163. useSpecularOverAlpha: boolean;
  104164. private _useReflectionOverAlpha;
  104165. /**
  104166. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  104167. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  104168. */
  104169. useReflectionOverAlpha: boolean;
  104170. private _disableLighting;
  104171. /**
  104172. * Does lights from the scene impacts this material.
  104173. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  104174. */
  104175. disableLighting: boolean;
  104176. private _useObjectSpaceNormalMap;
  104177. /**
  104178. * Allows using an object space normal map (instead of tangent space).
  104179. */
  104180. useObjectSpaceNormalMap: boolean;
  104181. private _useParallax;
  104182. /**
  104183. * Is parallax enabled or not.
  104184. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  104185. */
  104186. useParallax: boolean;
  104187. private _useParallaxOcclusion;
  104188. /**
  104189. * Is parallax occlusion enabled or not.
  104190. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  104191. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  104192. */
  104193. useParallaxOcclusion: boolean;
  104194. /**
  104195. * 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.
  104196. */
  104197. parallaxScaleBias: number;
  104198. private _roughness;
  104199. /**
  104200. * Helps to define how blurry the reflections should appears in the material.
  104201. */
  104202. roughness: number;
  104203. /**
  104204. * In case of refraction, define the value of the index of refraction.
  104205. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104206. */
  104207. indexOfRefraction: number;
  104208. /**
  104209. * Invert the refraction texture alongside the y axis.
  104210. * It can be useful with procedural textures or probe for instance.
  104211. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  104212. */
  104213. invertRefractionY: boolean;
  104214. /**
  104215. * Defines the alpha limits in alpha test mode.
  104216. */
  104217. alphaCutOff: number;
  104218. private _useLightmapAsShadowmap;
  104219. /**
  104220. * In case of light mapping, define whether the map contains light or shadow informations.
  104221. */
  104222. useLightmapAsShadowmap: boolean;
  104223. private _diffuseFresnelParameters;
  104224. /**
  104225. * Define the diffuse fresnel parameters of the material.
  104226. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104227. */
  104228. diffuseFresnelParameters: FresnelParameters;
  104229. private _opacityFresnelParameters;
  104230. /**
  104231. * Define the opacity fresnel parameters of the material.
  104232. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104233. */
  104234. opacityFresnelParameters: FresnelParameters;
  104235. private _reflectionFresnelParameters;
  104236. /**
  104237. * Define the reflection fresnel parameters of the material.
  104238. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104239. */
  104240. reflectionFresnelParameters: FresnelParameters;
  104241. private _refractionFresnelParameters;
  104242. /**
  104243. * Define the refraction fresnel parameters of the material.
  104244. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104245. */
  104246. refractionFresnelParameters: FresnelParameters;
  104247. private _emissiveFresnelParameters;
  104248. /**
  104249. * Define the emissive fresnel parameters of the material.
  104250. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104251. */
  104252. emissiveFresnelParameters: FresnelParameters;
  104253. private _useReflectionFresnelFromSpecular;
  104254. /**
  104255. * If true automatically deducts the fresnels values from the material specularity.
  104256. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  104257. */
  104258. useReflectionFresnelFromSpecular: boolean;
  104259. private _useGlossinessFromSpecularMapAlpha;
  104260. /**
  104261. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  104262. */
  104263. useGlossinessFromSpecularMapAlpha: boolean;
  104264. private _maxSimultaneousLights;
  104265. /**
  104266. * Defines the maximum number of lights that can be used in the material
  104267. */
  104268. maxSimultaneousLights: number;
  104269. private _invertNormalMapX;
  104270. /**
  104271. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  104272. */
  104273. invertNormalMapX: boolean;
  104274. private _invertNormalMapY;
  104275. /**
  104276. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  104277. */
  104278. invertNormalMapY: boolean;
  104279. private _twoSidedLighting;
  104280. /**
  104281. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  104282. */
  104283. twoSidedLighting: boolean;
  104284. /**
  104285. * Default configuration related to image processing available in the standard Material.
  104286. */
  104287. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  104288. /**
  104289. * Gets the image processing configuration used either in this material.
  104290. */
  104291. /**
  104292. * Sets the Default image processing configuration used either in the this material.
  104293. *
  104294. * If sets to null, the scene one is in use.
  104295. */
  104296. imageProcessingConfiguration: ImageProcessingConfiguration;
  104297. /**
  104298. * Keep track of the image processing observer to allow dispose and replace.
  104299. */
  104300. private _imageProcessingObserver;
  104301. /**
  104302. * Attaches a new image processing configuration to the Standard Material.
  104303. * @param configuration
  104304. */
  104305. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  104306. /**
  104307. * Gets wether the color curves effect is enabled.
  104308. */
  104309. /**
  104310. * Sets wether the color curves effect is enabled.
  104311. */
  104312. cameraColorCurvesEnabled: boolean;
  104313. /**
  104314. * Gets wether the color grading effect is enabled.
  104315. */
  104316. /**
  104317. * Gets wether the color grading effect is enabled.
  104318. */
  104319. cameraColorGradingEnabled: boolean;
  104320. /**
  104321. * Gets wether tonemapping is enabled or not.
  104322. */
  104323. /**
  104324. * Sets wether tonemapping is enabled or not
  104325. */
  104326. cameraToneMappingEnabled: boolean;
  104327. /**
  104328. * The camera exposure used on this material.
  104329. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  104330. * This corresponds to a photographic exposure.
  104331. */
  104332. /**
  104333. * The camera exposure used on this material.
  104334. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  104335. * This corresponds to a photographic exposure.
  104336. */
  104337. cameraExposure: number;
  104338. /**
  104339. * Gets The camera contrast used on this material.
  104340. */
  104341. /**
  104342. * Sets The camera contrast used on this material.
  104343. */
  104344. cameraContrast: number;
  104345. /**
  104346. * Gets the Color Grading 2D Lookup Texture.
  104347. */
  104348. /**
  104349. * Sets the Color Grading 2D Lookup Texture.
  104350. */
  104351. cameraColorGradingTexture: Nullable<BaseTexture>;
  104352. /**
  104353. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  104354. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  104355. * 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;
  104356. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  104357. */
  104358. /**
  104359. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  104360. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  104361. * 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;
  104362. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  104363. */
  104364. cameraColorCurves: Nullable<ColorCurves>;
  104365. /**
  104366. * Custom callback helping to override the default shader used in the material.
  104367. */
  104368. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  104369. protected _renderTargets: SmartArray<RenderTargetTexture>;
  104370. protected _worldViewProjectionMatrix: Matrix;
  104371. protected _globalAmbientColor: Color3;
  104372. protected _useLogarithmicDepth: boolean;
  104373. /**
  104374. * Instantiates a new standard material.
  104375. * This is the default material used in Babylon. It is the best trade off between quality
  104376. * and performances.
  104377. * @see http://doc.babylonjs.com/babylon101/materials
  104378. * @param name Define the name of the material in the scene
  104379. * @param scene Define the scene the material belong to
  104380. */
  104381. constructor(name: string, scene: Scene);
  104382. /**
  104383. * Gets a boolean indicating that current material needs to register RTT
  104384. */
  104385. readonly hasRenderTargetTextures: boolean;
  104386. /**
  104387. * Gets the current class name of the material e.g. "StandardMaterial"
  104388. * Mainly use in serialization.
  104389. * @returns the class name
  104390. */
  104391. getClassName(): string;
  104392. /**
  104393. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  104394. * You can try switching to logarithmic depth.
  104395. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  104396. */
  104397. useLogarithmicDepth: boolean;
  104398. /**
  104399. * Specifies if the material will require alpha blending
  104400. * @returns a boolean specifying if alpha blending is needed
  104401. */
  104402. needAlphaBlending(): boolean;
  104403. /**
  104404. * Specifies if this material should be rendered in alpha test mode
  104405. * @returns a boolean specifying if an alpha test is needed.
  104406. */
  104407. needAlphaTesting(): boolean;
  104408. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  104409. /**
  104410. * Get the texture used for alpha test purpose.
  104411. * @returns the diffuse texture in case of the standard material.
  104412. */
  104413. getAlphaTestTexture(): Nullable<BaseTexture>;
  104414. /**
  104415. * Get if the submesh is ready to be used and all its information available.
  104416. * Child classes can use it to update shaders
  104417. * @param mesh defines the mesh to check
  104418. * @param subMesh defines which submesh to check
  104419. * @param useInstances specifies that instances should be used
  104420. * @returns a boolean indicating that the submesh is ready or not
  104421. */
  104422. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104423. /**
  104424. * Builds the material UBO layouts.
  104425. * Used internally during the effect preparation.
  104426. */
  104427. buildUniformLayout(): void;
  104428. /**
  104429. * Unbinds the material from the mesh
  104430. */
  104431. unbind(): void;
  104432. /**
  104433. * Binds the submesh to this material by preparing the effect and shader to draw
  104434. * @param world defines the world transformation matrix
  104435. * @param mesh defines the mesh containing the submesh
  104436. * @param subMesh defines the submesh to bind the material to
  104437. */
  104438. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104439. /**
  104440. * Get the list of animatables in the material.
  104441. * @returns the list of animatables object used in the material
  104442. */
  104443. getAnimatables(): IAnimatable[];
  104444. /**
  104445. * Gets the active textures from the material
  104446. * @returns an array of textures
  104447. */
  104448. getActiveTextures(): BaseTexture[];
  104449. /**
  104450. * Specifies if the material uses a texture
  104451. * @param texture defines the texture to check against the material
  104452. * @returns a boolean specifying if the material uses the texture
  104453. */
  104454. hasTexture(texture: BaseTexture): boolean;
  104455. /**
  104456. * Disposes the material
  104457. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104458. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104459. */
  104460. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  104461. /**
  104462. * Makes a duplicate of the material, and gives it a new name
  104463. * @param name defines the new name for the duplicated material
  104464. * @returns the cloned material
  104465. */
  104466. clone(name: string): StandardMaterial;
  104467. /**
  104468. * Serializes this material in a JSON representation
  104469. * @returns the serialized material object
  104470. */
  104471. serialize(): any;
  104472. /**
  104473. * Creates a standard material from parsed material data
  104474. * @param source defines the JSON representation of the material
  104475. * @param scene defines the hosting scene
  104476. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  104477. * @returns a new standard material
  104478. */
  104479. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  104480. /**
  104481. * Are diffuse textures enabled in the application.
  104482. */
  104483. static DiffuseTextureEnabled: boolean;
  104484. /**
  104485. * Are ambient textures enabled in the application.
  104486. */
  104487. static AmbientTextureEnabled: boolean;
  104488. /**
  104489. * Are opacity textures enabled in the application.
  104490. */
  104491. static OpacityTextureEnabled: boolean;
  104492. /**
  104493. * Are reflection textures enabled in the application.
  104494. */
  104495. static ReflectionTextureEnabled: boolean;
  104496. /**
  104497. * Are emissive textures enabled in the application.
  104498. */
  104499. static EmissiveTextureEnabled: boolean;
  104500. /**
  104501. * Are specular textures enabled in the application.
  104502. */
  104503. static SpecularTextureEnabled: boolean;
  104504. /**
  104505. * Are bump textures enabled in the application.
  104506. */
  104507. static BumpTextureEnabled: boolean;
  104508. /**
  104509. * Are lightmap textures enabled in the application.
  104510. */
  104511. static LightmapTextureEnabled: boolean;
  104512. /**
  104513. * Are refraction textures enabled in the application.
  104514. */
  104515. static RefractionTextureEnabled: boolean;
  104516. /**
  104517. * Are color grading textures enabled in the application.
  104518. */
  104519. static ColorGradingTextureEnabled: boolean;
  104520. /**
  104521. * Are fresnels enabled in the application.
  104522. */
  104523. static FresnelEnabled: boolean;
  104524. }
  104525. }
  104526. declare module BABYLON {
  104527. /**
  104528. * A class extending Texture allowing drawing on a texture
  104529. * @see http://doc.babylonjs.com/how_to/dynamictexture
  104530. */
  104531. export class DynamicTexture extends Texture {
  104532. private _generateMipMaps;
  104533. private _canvas;
  104534. private _context;
  104535. private _engine;
  104536. /**
  104537. * Creates a DynamicTexture
  104538. * @param name defines the name of the texture
  104539. * @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
  104540. * @param scene defines the scene where you want the texture
  104541. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  104542. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  104543. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  104544. */
  104545. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  104546. /**
  104547. * Get the current class name of the texture useful for serialization or dynamic coding.
  104548. * @returns "DynamicTexture"
  104549. */
  104550. getClassName(): string;
  104551. /**
  104552. * Gets the current state of canRescale
  104553. */
  104554. readonly canRescale: boolean;
  104555. private _recreate;
  104556. /**
  104557. * Scales the texture
  104558. * @param ratio the scale factor to apply to both width and height
  104559. */
  104560. scale(ratio: number): void;
  104561. /**
  104562. * Resizes the texture
  104563. * @param width the new width
  104564. * @param height the new height
  104565. */
  104566. scaleTo(width: number, height: number): void;
  104567. /**
  104568. * Gets the context of the canvas used by the texture
  104569. * @returns the canvas context of the dynamic texture
  104570. */
  104571. getContext(): CanvasRenderingContext2D;
  104572. /**
  104573. * Clears the texture
  104574. */
  104575. clear(): void;
  104576. /**
  104577. * Updates the texture
  104578. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  104579. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  104580. */
  104581. update(invertY?: boolean, premulAlpha?: boolean): void;
  104582. /**
  104583. * Draws text onto the texture
  104584. * @param text defines the text to be drawn
  104585. * @param x defines the placement of the text from the left
  104586. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  104587. * @param font defines the font to be used with font-style, font-size, font-name
  104588. * @param color defines the color used for the text
  104589. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  104590. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  104591. * @param update defines whether texture is immediately update (default is true)
  104592. */
  104593. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  104594. /**
  104595. * Clones the texture
  104596. * @returns the clone of the texture.
  104597. */
  104598. clone(): DynamicTexture;
  104599. /**
  104600. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  104601. * @returns a serialized dynamic texture object
  104602. */
  104603. serialize(): any;
  104604. /** @hidden */
  104605. _rebuild(): void;
  104606. }
  104607. }
  104608. declare module BABYLON {
  104609. /** @hidden */
  104610. export var imageProcessingPixelShader: {
  104611. name: string;
  104612. shader: string;
  104613. };
  104614. }
  104615. declare module BABYLON {
  104616. /**
  104617. * ImageProcessingPostProcess
  104618. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  104619. */
  104620. export class ImageProcessingPostProcess extends PostProcess {
  104621. /**
  104622. * Default configuration related to image processing available in the PBR Material.
  104623. */
  104624. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  104625. /**
  104626. * Gets the image processing configuration used either in this material.
  104627. */
  104628. /**
  104629. * Sets the Default image processing configuration used either in the this material.
  104630. *
  104631. * If sets to null, the scene one is in use.
  104632. */
  104633. imageProcessingConfiguration: ImageProcessingConfiguration;
  104634. /**
  104635. * Keep track of the image processing observer to allow dispose and replace.
  104636. */
  104637. private _imageProcessingObserver;
  104638. /**
  104639. * Attaches a new image processing configuration to the PBR Material.
  104640. * @param configuration
  104641. */
  104642. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  104643. /**
  104644. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  104645. */
  104646. /**
  104647. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  104648. */
  104649. colorCurves: Nullable<ColorCurves>;
  104650. /**
  104651. * Gets wether the color curves effect is enabled.
  104652. */
  104653. /**
  104654. * Sets wether the color curves effect is enabled.
  104655. */
  104656. colorCurvesEnabled: boolean;
  104657. /**
  104658. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  104659. */
  104660. /**
  104661. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  104662. */
  104663. colorGradingTexture: Nullable<BaseTexture>;
  104664. /**
  104665. * Gets wether the color grading effect is enabled.
  104666. */
  104667. /**
  104668. * Gets wether the color grading effect is enabled.
  104669. */
  104670. colorGradingEnabled: boolean;
  104671. /**
  104672. * Gets exposure used in the effect.
  104673. */
  104674. /**
  104675. * Sets exposure used in the effect.
  104676. */
  104677. exposure: number;
  104678. /**
  104679. * Gets wether tonemapping is enabled or not.
  104680. */
  104681. /**
  104682. * Sets wether tonemapping is enabled or not
  104683. */
  104684. toneMappingEnabled: boolean;
  104685. /**
  104686. * Gets the type of tone mapping effect.
  104687. */
  104688. /**
  104689. * Sets the type of tone mapping effect.
  104690. */
  104691. toneMappingType: number;
  104692. /**
  104693. * Gets contrast used in the effect.
  104694. */
  104695. /**
  104696. * Sets contrast used in the effect.
  104697. */
  104698. contrast: number;
  104699. /**
  104700. * Gets Vignette stretch size.
  104701. */
  104702. /**
  104703. * Sets Vignette stretch size.
  104704. */
  104705. vignetteStretch: number;
  104706. /**
  104707. * Gets Vignette centre X Offset.
  104708. */
  104709. /**
  104710. * Sets Vignette centre X Offset.
  104711. */
  104712. vignetteCentreX: number;
  104713. /**
  104714. * Gets Vignette centre Y Offset.
  104715. */
  104716. /**
  104717. * Sets Vignette centre Y Offset.
  104718. */
  104719. vignetteCentreY: number;
  104720. /**
  104721. * Gets Vignette weight or intensity of the vignette effect.
  104722. */
  104723. /**
  104724. * Sets Vignette weight or intensity of the vignette effect.
  104725. */
  104726. vignetteWeight: number;
  104727. /**
  104728. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  104729. * if vignetteEnabled is set to true.
  104730. */
  104731. /**
  104732. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  104733. * if vignetteEnabled is set to true.
  104734. */
  104735. vignetteColor: Color4;
  104736. /**
  104737. * Gets Camera field of view used by the Vignette effect.
  104738. */
  104739. /**
  104740. * Sets Camera field of view used by the Vignette effect.
  104741. */
  104742. vignetteCameraFov: number;
  104743. /**
  104744. * Gets the vignette blend mode allowing different kind of effect.
  104745. */
  104746. /**
  104747. * Sets the vignette blend mode allowing different kind of effect.
  104748. */
  104749. vignetteBlendMode: number;
  104750. /**
  104751. * Gets wether the vignette effect is enabled.
  104752. */
  104753. /**
  104754. * Sets wether the vignette effect is enabled.
  104755. */
  104756. vignetteEnabled: boolean;
  104757. private _fromLinearSpace;
  104758. /**
  104759. * Gets wether the input of the processing is in Gamma or Linear Space.
  104760. */
  104761. /**
  104762. * Sets wether the input of the processing is in Gamma or Linear Space.
  104763. */
  104764. fromLinearSpace: boolean;
  104765. /**
  104766. * Defines cache preventing GC.
  104767. */
  104768. private _defines;
  104769. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  104770. /**
  104771. * "ImageProcessingPostProcess"
  104772. * @returns "ImageProcessingPostProcess"
  104773. */
  104774. getClassName(): string;
  104775. protected _updateParameters(): void;
  104776. dispose(camera?: Camera): void;
  104777. }
  104778. }
  104779. declare module BABYLON {
  104780. /**
  104781. * Class containing static functions to help procedurally build meshes
  104782. */
  104783. export class GroundBuilder {
  104784. /**
  104785. * Creates a ground mesh
  104786. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  104787. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  104788. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  104789. * @param name defines the name of the mesh
  104790. * @param options defines the options used to create the mesh
  104791. * @param scene defines the hosting scene
  104792. * @returns the ground mesh
  104793. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  104794. */
  104795. static CreateGround(name: string, options: {
  104796. width?: number;
  104797. height?: number;
  104798. subdivisions?: number;
  104799. subdivisionsX?: number;
  104800. subdivisionsY?: number;
  104801. updatable?: boolean;
  104802. }, scene: any): Mesh;
  104803. /**
  104804. * Creates a tiled ground mesh
  104805. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  104806. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  104807. * * 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
  104808. * * 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
  104809. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  104810. * @param name defines the name of the mesh
  104811. * @param options defines the options used to create the mesh
  104812. * @param scene defines the hosting scene
  104813. * @returns the tiled ground mesh
  104814. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  104815. */
  104816. static CreateTiledGround(name: string, options: {
  104817. xmin: number;
  104818. zmin: number;
  104819. xmax: number;
  104820. zmax: number;
  104821. subdivisions?: {
  104822. w: number;
  104823. h: number;
  104824. };
  104825. precision?: {
  104826. w: number;
  104827. h: number;
  104828. };
  104829. updatable?: boolean;
  104830. }, scene?: Nullable<Scene>): Mesh;
  104831. /**
  104832. * Creates a ground mesh from a height map
  104833. * * The parameter `url` sets the URL of the height map image resource.
  104834. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  104835. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  104836. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  104837. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  104838. * * 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.
  104839. * * 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).
  104840. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  104841. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  104842. * @param name defines the name of the mesh
  104843. * @param url defines the url to the height map
  104844. * @param options defines the options used to create the mesh
  104845. * @param scene defines the hosting scene
  104846. * @returns the ground mesh
  104847. * @see https://doc.babylonjs.com/babylon101/height_map
  104848. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  104849. */
  104850. static CreateGroundFromHeightMap(name: string, url: string, options: {
  104851. width?: number;
  104852. height?: number;
  104853. subdivisions?: number;
  104854. minHeight?: number;
  104855. maxHeight?: number;
  104856. colorFilter?: Color3;
  104857. alphaFilter?: number;
  104858. updatable?: boolean;
  104859. onReady?: (mesh: GroundMesh) => void;
  104860. }, scene?: Nullable<Scene>): GroundMesh;
  104861. }
  104862. }
  104863. declare module BABYLON {
  104864. /**
  104865. * Class containing static functions to help procedurally build meshes
  104866. */
  104867. export class TorusBuilder {
  104868. /**
  104869. * Creates a torus mesh
  104870. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  104871. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  104872. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  104873. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  104874. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  104875. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  104876. * @param name defines the name of the mesh
  104877. * @param options defines the options used to create the mesh
  104878. * @param scene defines the hosting scene
  104879. * @returns the torus mesh
  104880. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  104881. */
  104882. static CreateTorus(name: string, options: {
  104883. diameter?: number;
  104884. thickness?: number;
  104885. tessellation?: number;
  104886. updatable?: boolean;
  104887. sideOrientation?: number;
  104888. frontUVs?: Vector4;
  104889. backUVs?: Vector4;
  104890. }, scene: any): Mesh;
  104891. }
  104892. }
  104893. declare module BABYLON {
  104894. /**
  104895. * Class containing static functions to help procedurally build meshes
  104896. */
  104897. export class CylinderBuilder {
  104898. /**
  104899. * Creates a cylinder or a cone mesh
  104900. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  104901. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  104902. * * 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.
  104903. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  104904. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  104905. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  104906. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  104907. * * 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).
  104908. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  104909. * * 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).
  104910. * * 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
  104911. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  104912. * * 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
  104913. * * 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.
  104914. * * If `enclose` is false, a ring surface is one element.
  104915. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  104916. * * 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
  104917. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  104918. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  104919. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  104920. * @param name defines the name of the mesh
  104921. * @param options defines the options used to create the mesh
  104922. * @param scene defines the hosting scene
  104923. * @returns the cylinder mesh
  104924. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  104925. */
  104926. static CreateCylinder(name: string, options: {
  104927. height?: number;
  104928. diameterTop?: number;
  104929. diameterBottom?: number;
  104930. diameter?: number;
  104931. tessellation?: number;
  104932. subdivisions?: number;
  104933. arc?: number;
  104934. faceColors?: Color4[];
  104935. faceUV?: Vector4[];
  104936. updatable?: boolean;
  104937. hasRings?: boolean;
  104938. enclose?: boolean;
  104939. cap?: number;
  104940. sideOrientation?: number;
  104941. frontUVs?: Vector4;
  104942. backUVs?: Vector4;
  104943. }, scene: any): Mesh;
  104944. }
  104945. }
  104946. declare module BABYLON {
  104947. /**
  104948. * Options to modify the vr teleportation behavior.
  104949. */
  104950. export interface VRTeleportationOptions {
  104951. /**
  104952. * The name of the mesh which should be used as the teleportation floor. (default: null)
  104953. */
  104954. floorMeshName?: string;
  104955. /**
  104956. * A list of meshes to be used as the teleportation floor. (default: empty)
  104957. */
  104958. floorMeshes?: Mesh[];
  104959. }
  104960. /**
  104961. * Options to modify the vr experience helper's behavior.
  104962. */
  104963. export interface VRExperienceHelperOptions extends WebVROptions {
  104964. /**
  104965. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  104966. */
  104967. createDeviceOrientationCamera?: boolean;
  104968. /**
  104969. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  104970. */
  104971. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  104972. /**
  104973. * Uses the main button on the controller to toggle the laser casted. (default: true)
  104974. */
  104975. laserToggle?: boolean;
  104976. /**
  104977. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  104978. */
  104979. floorMeshes?: Mesh[];
  104980. /**
  104981. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  104982. */
  104983. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  104984. }
  104985. /**
  104986. * Event containing information after VR has been entered
  104987. */
  104988. export class OnAfterEnteringVRObservableEvent {
  104989. /**
  104990. * If entering vr was successful
  104991. */
  104992. success: boolean;
  104993. }
  104994. /**
  104995. * Helps to quickly add VR support to an existing scene.
  104996. * See http://doc.babylonjs.com/how_to/webvr_helper
  104997. */
  104998. export class VRExperienceHelper {
  104999. /** Options to modify the vr experience helper's behavior. */
  105000. webVROptions: VRExperienceHelperOptions;
  105001. private _scene;
  105002. private _position;
  105003. private _btnVR;
  105004. private _btnVRDisplayed;
  105005. private _webVRsupported;
  105006. private _webVRready;
  105007. private _webVRrequesting;
  105008. private _webVRpresenting;
  105009. private _hasEnteredVR;
  105010. private _fullscreenVRpresenting;
  105011. private _canvas;
  105012. private _webVRCamera;
  105013. private _vrDeviceOrientationCamera;
  105014. private _deviceOrientationCamera;
  105015. private _existingCamera;
  105016. private _onKeyDown;
  105017. private _onVrDisplayPresentChange;
  105018. private _onVRDisplayChanged;
  105019. private _onVRRequestPresentStart;
  105020. private _onVRRequestPresentComplete;
  105021. /**
  105022. * 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)
  105023. */
  105024. enableGazeEvenWhenNoPointerLock: boolean;
  105025. /**
  105026. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  105027. */
  105028. exitVROnDoubleTap: boolean;
  105029. /**
  105030. * Observable raised right before entering VR.
  105031. */
  105032. onEnteringVRObservable: Observable<VRExperienceHelper>;
  105033. /**
  105034. * Observable raised when entering VR has completed.
  105035. */
  105036. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  105037. /**
  105038. * Observable raised when exiting VR.
  105039. */
  105040. onExitingVRObservable: Observable<VRExperienceHelper>;
  105041. /**
  105042. * Observable raised when controller mesh is loaded.
  105043. */
  105044. onControllerMeshLoadedObservable: Observable<WebVRController>;
  105045. /** Return this.onEnteringVRObservable
  105046. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  105047. */
  105048. readonly onEnteringVR: Observable<VRExperienceHelper>;
  105049. /** Return this.onExitingVRObservable
  105050. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  105051. */
  105052. readonly onExitingVR: Observable<VRExperienceHelper>;
  105053. /** Return this.onControllerMeshLoadedObservable
  105054. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  105055. */
  105056. readonly onControllerMeshLoaded: Observable<WebVRController>;
  105057. private _rayLength;
  105058. private _useCustomVRButton;
  105059. private _teleportationRequested;
  105060. private _teleportActive;
  105061. private _floorMeshName;
  105062. private _floorMeshesCollection;
  105063. private _rotationAllowed;
  105064. private _teleportBackwardsVector;
  105065. private _teleportationTarget;
  105066. private _isDefaultTeleportationTarget;
  105067. private _postProcessMove;
  105068. private _teleportationFillColor;
  105069. private _teleportationBorderColor;
  105070. private _rotationAngle;
  105071. private _haloCenter;
  105072. private _cameraGazer;
  105073. private _padSensibilityUp;
  105074. private _padSensibilityDown;
  105075. private _leftController;
  105076. private _rightController;
  105077. /**
  105078. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  105079. */
  105080. onNewMeshSelected: Observable<AbstractMesh>;
  105081. /**
  105082. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  105083. */
  105084. onNewMeshPicked: Observable<PickingInfo>;
  105085. private _circleEase;
  105086. /**
  105087. * Observable raised before camera teleportation
  105088. */
  105089. onBeforeCameraTeleport: Observable<Vector3>;
  105090. /**
  105091. * Observable raised after camera teleportation
  105092. */
  105093. onAfterCameraTeleport: Observable<Vector3>;
  105094. /**
  105095. * Observable raised when current selected mesh gets unselected
  105096. */
  105097. onSelectedMeshUnselected: Observable<AbstractMesh>;
  105098. private _raySelectionPredicate;
  105099. /**
  105100. * To be optionaly changed by user to define custom ray selection
  105101. */
  105102. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  105103. /**
  105104. * To be optionaly changed by user to define custom selection logic (after ray selection)
  105105. */
  105106. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  105107. /**
  105108. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  105109. */
  105110. teleportationEnabled: boolean;
  105111. private _defaultHeight;
  105112. private _teleportationInitialized;
  105113. private _interactionsEnabled;
  105114. private _interactionsRequested;
  105115. private _displayGaze;
  105116. private _displayLaserPointer;
  105117. /**
  105118. * The mesh used to display where the user is going to teleport.
  105119. */
  105120. /**
  105121. * Sets the mesh to be used to display where the user is going to teleport.
  105122. */
  105123. teleportationTarget: Mesh;
  105124. /**
  105125. * 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
  105126. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  105127. * See http://doc.babylonjs.com/resources/baking_transformations
  105128. */
  105129. gazeTrackerMesh: Mesh;
  105130. /**
  105131. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  105132. */
  105133. updateGazeTrackerScale: boolean;
  105134. /**
  105135. * If the gaze trackers color should be updated when selecting meshes
  105136. */
  105137. updateGazeTrackerColor: boolean;
  105138. /**
  105139. * The gaze tracking mesh corresponding to the left controller
  105140. */
  105141. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  105142. /**
  105143. * The gaze tracking mesh corresponding to the right controller
  105144. */
  105145. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  105146. /**
  105147. * If the ray of the gaze should be displayed.
  105148. */
  105149. /**
  105150. * Sets if the ray of the gaze should be displayed.
  105151. */
  105152. displayGaze: boolean;
  105153. /**
  105154. * If the ray of the LaserPointer should be displayed.
  105155. */
  105156. /**
  105157. * Sets if the ray of the LaserPointer should be displayed.
  105158. */
  105159. displayLaserPointer: boolean;
  105160. /**
  105161. * The deviceOrientationCamera used as the camera when not in VR.
  105162. */
  105163. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  105164. /**
  105165. * Based on the current WebVR support, returns the current VR camera used.
  105166. */
  105167. readonly currentVRCamera: Nullable<Camera>;
  105168. /**
  105169. * The webVRCamera which is used when in VR.
  105170. */
  105171. readonly webVRCamera: WebVRFreeCamera;
  105172. /**
  105173. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  105174. */
  105175. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  105176. /**
  105177. * The html button that is used to trigger entering into VR.
  105178. */
  105179. readonly vrButton: Nullable<HTMLButtonElement>;
  105180. private readonly _teleportationRequestInitiated;
  105181. /**
  105182. * Defines wether or not Pointer lock should be requested when switching to
  105183. * full screen.
  105184. */
  105185. requestPointerLockOnFullScreen: boolean;
  105186. /**
  105187. * Instantiates a VRExperienceHelper.
  105188. * Helps to quickly add VR support to an existing scene.
  105189. * @param scene The scene the VRExperienceHelper belongs to.
  105190. * @param webVROptions Options to modify the vr experience helper's behavior.
  105191. */
  105192. constructor(scene: Scene,
  105193. /** Options to modify the vr experience helper's behavior. */
  105194. webVROptions?: VRExperienceHelperOptions);
  105195. private _onDefaultMeshLoaded;
  105196. private _onResize;
  105197. private _onFullscreenChange;
  105198. /**
  105199. * Gets a value indicating if we are currently in VR mode.
  105200. */
  105201. readonly isInVRMode: boolean;
  105202. private onVrDisplayPresentChange;
  105203. private onVRDisplayChanged;
  105204. private moveButtonToBottomRight;
  105205. private displayVRButton;
  105206. private updateButtonVisibility;
  105207. private _cachedAngularSensibility;
  105208. /**
  105209. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  105210. * Otherwise, will use the fullscreen API.
  105211. */
  105212. enterVR(): void;
  105213. /**
  105214. * Attempt to exit VR, or fullscreen.
  105215. */
  105216. exitVR(): void;
  105217. /**
  105218. * The position of the vr experience helper.
  105219. */
  105220. /**
  105221. * Sets the position of the vr experience helper.
  105222. */
  105223. position: Vector3;
  105224. /**
  105225. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  105226. */
  105227. enableInteractions(): void;
  105228. private readonly _noControllerIsActive;
  105229. private beforeRender;
  105230. private _isTeleportationFloor;
  105231. /**
  105232. * Adds a floor mesh to be used for teleportation.
  105233. * @param floorMesh the mesh to be used for teleportation.
  105234. */
  105235. addFloorMesh(floorMesh: Mesh): void;
  105236. /**
  105237. * Removes a floor mesh from being used for teleportation.
  105238. * @param floorMesh the mesh to be removed.
  105239. */
  105240. removeFloorMesh(floorMesh: Mesh): void;
  105241. /**
  105242. * Enables interactions and teleportation using the VR controllers and gaze.
  105243. * @param vrTeleportationOptions options to modify teleportation behavior.
  105244. */
  105245. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  105246. private _onNewGamepadConnected;
  105247. private _tryEnableInteractionOnController;
  105248. private _onNewGamepadDisconnected;
  105249. private _enableInteractionOnController;
  105250. private _checkTeleportWithRay;
  105251. private _checkRotate;
  105252. private _checkTeleportBackwards;
  105253. private _enableTeleportationOnController;
  105254. private _createTeleportationCircles;
  105255. private _displayTeleportationTarget;
  105256. private _hideTeleportationTarget;
  105257. private _rotateCamera;
  105258. private _moveTeleportationSelectorTo;
  105259. private _workingVector;
  105260. private _workingQuaternion;
  105261. private _workingMatrix;
  105262. /**
  105263. * Teleports the users feet to the desired location
  105264. * @param location The location where the user's feet should be placed
  105265. */
  105266. teleportCamera(location: Vector3): void;
  105267. private _convertNormalToDirectionOfRay;
  105268. private _castRayAndSelectObject;
  105269. private _notifySelectedMeshUnselected;
  105270. /**
  105271. * Sets the color of the laser ray from the vr controllers.
  105272. * @param color new color for the ray.
  105273. */
  105274. changeLaserColor(color: Color3): void;
  105275. /**
  105276. * Sets the color of the ray from the vr headsets gaze.
  105277. * @param color new color for the ray.
  105278. */
  105279. changeGazeColor(color: Color3): void;
  105280. /**
  105281. * Exits VR and disposes of the vr experience helper
  105282. */
  105283. dispose(): void;
  105284. /**
  105285. * Gets the name of the VRExperienceHelper class
  105286. * @returns "VRExperienceHelper"
  105287. */
  105288. getClassName(): string;
  105289. }
  105290. }
  105291. declare module BABYLON {
  105292. /**
  105293. * Manages an XRSession to work with Babylon's engine
  105294. * @see https://doc.babylonjs.com/how_to/webxr
  105295. */
  105296. export class WebXRSessionManager implements IDisposable {
  105297. private scene;
  105298. /**
  105299. * Fires every time a new xrFrame arrives which can be used to update the camera
  105300. */
  105301. onXRFrameObservable: Observable<any>;
  105302. /**
  105303. * Fires when the xr session is ended either by the device or manually done
  105304. */
  105305. onXRSessionEnded: Observable<any>;
  105306. /**
  105307. * Underlying xr session
  105308. */
  105309. session: XRSession;
  105310. /**
  105311. * Type of reference space used when creating the session
  105312. */
  105313. referenceSpace: XRReferenceSpace;
  105314. /** @hidden */
  105315. _sessionRenderTargetTexture: Nullable<RenderTargetTexture>;
  105316. /**
  105317. * Current XR frame
  105318. */
  105319. currentFrame: Nullable<XRFrame>;
  105320. private _xrNavigator;
  105321. private baseLayer;
  105322. /**
  105323. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  105324. * @param scene The scene which the session should be created for
  105325. */
  105326. constructor(scene: Scene);
  105327. /**
  105328. * Initializes the manager
  105329. * After initialization enterXR can be called to start an XR session
  105330. * @returns Promise which resolves after it is initialized
  105331. */
  105332. initializeAsync(): Promise<void>;
  105333. /**
  105334. * Initializes an xr session
  105335. * @param xrSessionMode mode to initialize
  105336. * @returns a promise which will resolve once the session has been initialized
  105337. */
  105338. initializeSessionAsync(xrSessionMode: XRSessionMode): any;
  105339. /**
  105340. * Sets the reference space on the xr session
  105341. * @param referenceSpace space to set
  105342. * @returns a promise that will resolve once the reference space has been set
  105343. */
  105344. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  105345. /**
  105346. * Updates the render state of the session
  105347. * @param state state to set
  105348. * @returns a promise that resolves once the render state has been updated
  105349. */
  105350. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  105351. /**
  105352. * Starts rendering to the xr layer
  105353. * @returns a promise that will resolve once rendering has started
  105354. */
  105355. startRenderingToXRAsync(): Promise<void>;
  105356. /**
  105357. * Stops the xrSession and restores the renderloop
  105358. * @returns Promise which resolves after it exits XR
  105359. */
  105360. exitXRAsync(): Promise<unknown>;
  105361. /**
  105362. * Checks if a session would be supported for the creation options specified
  105363. * @param sessionMode session mode to check if supported eg. immersive-vr
  105364. * @returns true if supported
  105365. */
  105366. supportsSessionAsync(sessionMode: XRSessionMode): any;
  105367. /**
  105368. * @hidden
  105369. * Converts the render layer of xrSession to a render target
  105370. * @param session session to create render target for
  105371. * @param scene scene the new render target should be created for
  105372. */
  105373. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  105374. /**
  105375. * Disposes of the session manager
  105376. */
  105377. dispose(): void;
  105378. }
  105379. }
  105380. declare module BABYLON {
  105381. /**
  105382. * WebXR Camera which holds the views for the xrSession
  105383. * @see https://doc.babylonjs.com/how_to/webxr
  105384. */
  105385. export class WebXRCamera extends FreeCamera {
  105386. private static _TmpMatrix;
  105387. /**
  105388. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  105389. * @param name the name of the camera
  105390. * @param scene the scene to add the camera to
  105391. */
  105392. constructor(name: string, scene: Scene);
  105393. private _updateNumberOfRigCameras;
  105394. /** @hidden */
  105395. _updateForDualEyeDebugging(pupilDistance?: number): void;
  105396. /**
  105397. * Updates the cameras position from the current pose information of the XR session
  105398. * @param xrSessionManager the session containing pose information
  105399. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  105400. */
  105401. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  105402. }
  105403. }
  105404. declare module BABYLON {
  105405. /**
  105406. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  105407. */
  105408. export class WebXRManagedOutputCanvas implements IDisposable {
  105409. private helper;
  105410. private _canvas;
  105411. /**
  105412. * xrpresent context of the canvas which can be used to display/mirror xr content
  105413. */
  105414. canvasContext: WebGLRenderingContext;
  105415. /**
  105416. * xr layer for the canvas
  105417. */
  105418. xrLayer: Nullable<XRWebGLLayer>;
  105419. /**
  105420. * Initializes the xr layer for the session
  105421. * @param xrSession xr session
  105422. * @returns a promise that will resolve once the XR Layer has been created
  105423. */
  105424. initializeXRLayerAsync(xrSession: any): any;
  105425. /**
  105426. * Initializes the canvas to be added/removed upon entering/exiting xr
  105427. * @param helper the xr experience helper used to trigger adding/removing of the canvas
  105428. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  105429. */
  105430. constructor(helper: WebXRExperienceHelper, canvas?: HTMLCanvasElement);
  105431. /**
  105432. * Disposes of the object
  105433. */
  105434. dispose(): void;
  105435. private _setManagedOutputCanvas;
  105436. private _addCanvas;
  105437. private _removeCanvas;
  105438. }
  105439. }
  105440. declare module BABYLON {
  105441. /**
  105442. * States of the webXR experience
  105443. */
  105444. export enum WebXRState {
  105445. /**
  105446. * Transitioning to being in XR mode
  105447. */
  105448. ENTERING_XR = 0,
  105449. /**
  105450. * Transitioning to non XR mode
  105451. */
  105452. EXITING_XR = 1,
  105453. /**
  105454. * In XR mode and presenting
  105455. */
  105456. IN_XR = 2,
  105457. /**
  105458. * Not entered XR mode
  105459. */
  105460. NOT_IN_XR = 3
  105461. }
  105462. /**
  105463. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  105464. * @see https://doc.babylonjs.com/how_to/webxr
  105465. */
  105466. export class WebXRExperienceHelper implements IDisposable {
  105467. private scene;
  105468. /**
  105469. * 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
  105470. */
  105471. container: AbstractMesh;
  105472. /**
  105473. * Camera used to render xr content
  105474. */
  105475. camera: WebXRCamera;
  105476. /**
  105477. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  105478. */
  105479. state: WebXRState;
  105480. private _setState;
  105481. private static _TmpVector;
  105482. /**
  105483. * Fires when the state of the experience helper has changed
  105484. */
  105485. onStateChangedObservable: Observable<WebXRState>;
  105486. /** Session manager used to keep track of xr session */
  105487. sessionManager: WebXRSessionManager;
  105488. private _nonVRCamera;
  105489. private _originalSceneAutoClear;
  105490. private _supported;
  105491. /**
  105492. * Creates the experience helper
  105493. * @param scene the scene to attach the experience helper to
  105494. * @returns a promise for the experience helper
  105495. */
  105496. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  105497. /**
  105498. * Creates a WebXRExperienceHelper
  105499. * @param scene The scene the helper should be created in
  105500. */
  105501. private constructor();
  105502. /**
  105503. * Exits XR mode and returns the scene to its original state
  105504. * @returns promise that resolves after xr mode has exited
  105505. */
  105506. exitXRAsync(): Promise<unknown>;
  105507. /**
  105508. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  105509. * @param sessionCreationOptions options for the XR session
  105510. * @param referenceSpaceType frame of reference of the XR session
  105511. * @param outputCanvas the output canvas that will be used to enter XR mode
  105512. * @returns promise that resolves after xr mode has entered
  105513. */
  105514. enterXRAsync(sessionCreationOptions: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, outputCanvas: WebXRManagedOutputCanvas): any;
  105515. /**
  105516. * Updates the global position of the camera by moving the camera's container
  105517. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  105518. * @param position The desired global position of the camera
  105519. */
  105520. setPositionOfCameraUsingContainer(position: Vector3): void;
  105521. /**
  105522. * Rotates the xr camera by rotating the camera's container around the camera's position
  105523. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  105524. * @param rotation the desired quaternion rotation to apply to the camera
  105525. */
  105526. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  105527. /**
  105528. * Disposes of the experience helper
  105529. */
  105530. dispose(): void;
  105531. }
  105532. }
  105533. declare module BABYLON {
  105534. /**
  105535. * Button which can be used to enter a different mode of XR
  105536. */
  105537. export class WebXREnterExitUIButton {
  105538. /** button element */
  105539. element: HTMLElement;
  105540. /** XR initialization options for the button */
  105541. sessionMode: XRSessionMode;
  105542. /** Reference space type */
  105543. referenceSpaceType: XRReferenceSpaceType;
  105544. /**
  105545. * Creates a WebXREnterExitUIButton
  105546. * @param element button element
  105547. * @param sessionMode XR initialization session mode
  105548. * @param referenceSpaceType the type of reference space to be used
  105549. */
  105550. constructor(
  105551. /** button element */
  105552. element: HTMLElement,
  105553. /** XR initialization options for the button */
  105554. sessionMode: XRSessionMode,
  105555. /** Reference space type */
  105556. referenceSpaceType: XRReferenceSpaceType);
  105557. /**
  105558. * Overwritable function which can be used to update the button's visuals when the state changes
  105559. * @param activeButton the current active button in the UI
  105560. */
  105561. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  105562. }
  105563. /**
  105564. * Options to create the webXR UI
  105565. */
  105566. export class WebXREnterExitUIOptions {
  105567. /**
  105568. * Context to enter xr with
  105569. */
  105570. webXRManagedOutputCanvas?: Nullable<WebXRManagedOutputCanvas>;
  105571. /**
  105572. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  105573. */
  105574. customButtons?: Array<WebXREnterExitUIButton>;
  105575. }
  105576. /**
  105577. * UI to allow the user to enter/exit XR mode
  105578. */
  105579. export class WebXREnterExitUI implements IDisposable {
  105580. private scene;
  105581. private _overlay;
  105582. private _buttons;
  105583. private _activeButton;
  105584. /**
  105585. * Fired every time the active button is changed.
  105586. *
  105587. * When xr is entered via a button that launches xr that button will be the callback parameter
  105588. *
  105589. * When exiting xr the callback parameter will be null)
  105590. */
  105591. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  105592. /**
  105593. * Creates UI to allow the user to enter/exit XR mode
  105594. * @param scene the scene to add the ui to
  105595. * @param helper the xr experience helper to enter/exit xr with
  105596. * @param options options to configure the UI
  105597. * @returns the created ui
  105598. */
  105599. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  105600. private constructor();
  105601. private _updateButtons;
  105602. /**
  105603. * Disposes of the object
  105604. */
  105605. dispose(): void;
  105606. }
  105607. }
  105608. declare module BABYLON {
  105609. /**
  105610. * Represents an XR input
  105611. */
  105612. export class WebXRController {
  105613. private scene;
  105614. /** The underlying input source for the controller */
  105615. inputSource: XRInputSource;
  105616. private parentContainer;
  105617. /**
  105618. * 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
  105619. */
  105620. grip?: AbstractMesh;
  105621. /**
  105622. * Pointer which can be used to select objects or attach a visible laser to
  105623. */
  105624. pointer: AbstractMesh;
  105625. /**
  105626. * Event that fires when the controller is removed/disposed
  105627. */
  105628. onDisposeObservable: Observable<{}>;
  105629. private _tmpMatrix;
  105630. private _tmpQuaternion;
  105631. private _tmpVector;
  105632. /**
  105633. * Creates the controller
  105634. * @see https://doc.babylonjs.com/how_to/webxr
  105635. * @param scene the scene which the controller should be associated to
  105636. * @param inputSource the underlying input source for the controller
  105637. * @param parentContainer parent that the controller meshes should be children of
  105638. */
  105639. constructor(scene: Scene,
  105640. /** The underlying input source for the controller */
  105641. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  105642. /**
  105643. * Updates the controller pose based on the given XRFrame
  105644. * @param xrFrame xr frame to update the pose with
  105645. * @param referenceSpace reference space to use
  105646. */
  105647. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  105648. /**
  105649. * Gets a world space ray coming from the controller
  105650. * @param result the resulting ray
  105651. */
  105652. getWorldPointerRayToRef(result: Ray): void;
  105653. /**
  105654. * Disposes of the object
  105655. */
  105656. dispose(): void;
  105657. }
  105658. }
  105659. declare module BABYLON {
  105660. /**
  105661. * XR input used to track XR inputs such as controllers/rays
  105662. */
  105663. export class WebXRInput implements IDisposable {
  105664. /**
  105665. * Base experience the input listens to
  105666. */
  105667. baseExperience: WebXRExperienceHelper;
  105668. /**
  105669. * XR controllers being tracked
  105670. */
  105671. controllers: Array<WebXRController>;
  105672. private _frameObserver;
  105673. private _stateObserver;
  105674. /**
  105675. * Event when a controller has been connected/added
  105676. */
  105677. onControllerAddedObservable: Observable<WebXRController>;
  105678. /**
  105679. * Event when a controller has been removed/disconnected
  105680. */
  105681. onControllerRemovedObservable: Observable<WebXRController>;
  105682. /**
  105683. * Initializes the WebXRInput
  105684. * @param baseExperience experience helper which the input should be created for
  105685. */
  105686. constructor(
  105687. /**
  105688. * Base experience the input listens to
  105689. */
  105690. baseExperience: WebXRExperienceHelper);
  105691. private _onInputSourcesChange;
  105692. private _addAndRemoveControllers;
  105693. /**
  105694. * Disposes of the object
  105695. */
  105696. dispose(): void;
  105697. }
  105698. }
  105699. declare module BABYLON {
  105700. /**
  105701. * Enables teleportation
  105702. */
  105703. export class WebXRControllerTeleportation {
  105704. private _teleportationFillColor;
  105705. private _teleportationBorderColor;
  105706. private _tmpRay;
  105707. private _tmpVector;
  105708. /**
  105709. * Creates a WebXRControllerTeleportation
  105710. * @param input input manager to add teleportation to
  105711. * @param floorMeshes floormeshes which can be teleported to
  105712. */
  105713. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  105714. }
  105715. }
  105716. declare module BABYLON {
  105717. /**
  105718. * Handles pointer input automatically for the pointer of XR controllers
  105719. */
  105720. export class WebXRControllerPointerSelection {
  105721. private static _idCounter;
  105722. private _tmpRay;
  105723. /**
  105724. * Creates a WebXRControllerPointerSelection
  105725. * @param input input manager to setup pointer selection
  105726. */
  105727. constructor(input: WebXRInput);
  105728. private _convertNormalToDirectionOfRay;
  105729. private _updatePointerDistance;
  105730. }
  105731. }
  105732. declare module BABYLON {
  105733. /**
  105734. * Class used to represent data loading progression
  105735. */
  105736. export class SceneLoaderProgressEvent {
  105737. /** defines if data length to load can be evaluated */
  105738. readonly lengthComputable: boolean;
  105739. /** defines the loaded data length */
  105740. readonly loaded: number;
  105741. /** defines the data length to load */
  105742. readonly total: number;
  105743. /**
  105744. * Create a new progress event
  105745. * @param lengthComputable defines if data length to load can be evaluated
  105746. * @param loaded defines the loaded data length
  105747. * @param total defines the data length to load
  105748. */
  105749. constructor(
  105750. /** defines if data length to load can be evaluated */
  105751. lengthComputable: boolean,
  105752. /** defines the loaded data length */
  105753. loaded: number,
  105754. /** defines the data length to load */
  105755. total: number);
  105756. /**
  105757. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  105758. * @param event defines the source event
  105759. * @returns a new SceneLoaderProgressEvent
  105760. */
  105761. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  105762. }
  105763. /**
  105764. * Interface used by SceneLoader plugins to define supported file extensions
  105765. */
  105766. export interface ISceneLoaderPluginExtensions {
  105767. /**
  105768. * Defines the list of supported extensions
  105769. */
  105770. [extension: string]: {
  105771. isBinary: boolean;
  105772. };
  105773. }
  105774. /**
  105775. * Interface used by SceneLoader plugin factory
  105776. */
  105777. export interface ISceneLoaderPluginFactory {
  105778. /**
  105779. * Defines the name of the factory
  105780. */
  105781. name: string;
  105782. /**
  105783. * Function called to create a new plugin
  105784. * @return the new plugin
  105785. */
  105786. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  105787. /**
  105788. * Boolean indicating if the plugin can direct load specific data
  105789. */
  105790. canDirectLoad?: (data: string) => boolean;
  105791. }
  105792. /**
  105793. * Interface used to define a SceneLoader plugin
  105794. */
  105795. export interface ISceneLoaderPlugin {
  105796. /**
  105797. * The friendly name of this plugin.
  105798. */
  105799. name: string;
  105800. /**
  105801. * The file extensions supported by this plugin.
  105802. */
  105803. extensions: string | ISceneLoaderPluginExtensions;
  105804. /**
  105805. * Import meshes into a scene.
  105806. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  105807. * @param scene The scene to import into
  105808. * @param data The data to import
  105809. * @param rootUrl The root url for scene and resources
  105810. * @param meshes The meshes array to import into
  105811. * @param particleSystems The particle systems array to import into
  105812. * @param skeletons The skeletons array to import into
  105813. * @param onError The callback when import fails
  105814. * @returns True if successful or false otherwise
  105815. */
  105816. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  105817. /**
  105818. * Load into a scene.
  105819. * @param scene The scene to load into
  105820. * @param data The data to import
  105821. * @param rootUrl The root url for scene and resources
  105822. * @param onError The callback when import fails
  105823. * @returns true if successful or false otherwise
  105824. */
  105825. load(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  105826. /**
  105827. * The callback that returns true if the data can be directly loaded.
  105828. */
  105829. canDirectLoad?: (data: string) => boolean;
  105830. /**
  105831. * The callback that allows custom handling of the root url based on the response url.
  105832. */
  105833. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  105834. /**
  105835. * Load into an asset container.
  105836. * @param scene The scene to load into
  105837. * @param data The data to import
  105838. * @param rootUrl The root url for scene and resources
  105839. * @param onError The callback when import fails
  105840. * @returns The loaded asset container
  105841. */
  105842. loadAssetContainer(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  105843. }
  105844. /**
  105845. * Interface used to define an async SceneLoader plugin
  105846. */
  105847. export interface ISceneLoaderPluginAsync {
  105848. /**
  105849. * The friendly name of this plugin.
  105850. */
  105851. name: string;
  105852. /**
  105853. * The file extensions supported by this plugin.
  105854. */
  105855. extensions: string | ISceneLoaderPluginExtensions;
  105856. /**
  105857. * Import meshes into a scene.
  105858. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  105859. * @param scene The scene to import into
  105860. * @param data The data to import
  105861. * @param rootUrl The root url for scene and resources
  105862. * @param onProgress The callback when the load progresses
  105863. * @param fileName Defines the name of the file to load
  105864. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  105865. */
  105866. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  105867. meshes: AbstractMesh[];
  105868. particleSystems: IParticleSystem[];
  105869. skeletons: Skeleton[];
  105870. animationGroups: AnimationGroup[];
  105871. }>;
  105872. /**
  105873. * Load into a scene.
  105874. * @param scene The scene to load into
  105875. * @param data The data to import
  105876. * @param rootUrl The root url for scene and resources
  105877. * @param onProgress The callback when the load progresses
  105878. * @param fileName Defines the name of the file to load
  105879. * @returns Nothing
  105880. */
  105881. loadAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  105882. /**
  105883. * The callback that returns true if the data can be directly loaded.
  105884. */
  105885. canDirectLoad?: (data: string) => boolean;
  105886. /**
  105887. * The callback that allows custom handling of the root url based on the response url.
  105888. */
  105889. rewriteRootURL?: (rootUrl: string, responseURL?: string) => string;
  105890. /**
  105891. * Load into an asset container.
  105892. * @param scene The scene to load into
  105893. * @param data The data to import
  105894. * @param rootUrl The root url for scene and resources
  105895. * @param onProgress The callback when the load progresses
  105896. * @param fileName Defines the name of the file to load
  105897. * @returns The loaded asset container
  105898. */
  105899. loadAssetContainerAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  105900. }
  105901. /**
  105902. * Class used to load scene from various file formats using registered plugins
  105903. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  105904. */
  105905. export class SceneLoader {
  105906. /**
  105907. * No logging while loading
  105908. */
  105909. static readonly NO_LOGGING: number;
  105910. /**
  105911. * Minimal logging while loading
  105912. */
  105913. static readonly MINIMAL_LOGGING: number;
  105914. /**
  105915. * Summary logging while loading
  105916. */
  105917. static readonly SUMMARY_LOGGING: number;
  105918. /**
  105919. * Detailled logging while loading
  105920. */
  105921. static readonly DETAILED_LOGGING: number;
  105922. /**
  105923. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105924. */
  105925. static ForceFullSceneLoadingForIncremental: boolean;
  105926. /**
  105927. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105928. */
  105929. static ShowLoadingScreen: boolean;
  105930. /**
  105931. * Defines the current logging level (while loading the scene)
  105932. * @ignorenaming
  105933. */
  105934. static loggingLevel: number;
  105935. /**
  105936. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105937. */
  105938. static CleanBoneMatrixWeights: boolean;
  105939. /**
  105940. * Event raised when a plugin is used to load a scene
  105941. */
  105942. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  105943. private static _registeredPlugins;
  105944. private static _getDefaultPlugin;
  105945. private static _getPluginForExtension;
  105946. private static _getPluginForDirectLoad;
  105947. private static _getPluginForFilename;
  105948. private static _getDirectLoad;
  105949. private static _loadData;
  105950. private static _getFileInfo;
  105951. /**
  105952. * Gets a plugin that can load the given extension
  105953. * @param extension defines the extension to load
  105954. * @returns a plugin or null if none works
  105955. */
  105956. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  105957. /**
  105958. * Gets a boolean indicating that the given extension can be loaded
  105959. * @param extension defines the extension to load
  105960. * @returns true if the extension is supported
  105961. */
  105962. static IsPluginForExtensionAvailable(extension: string): boolean;
  105963. /**
  105964. * Adds a new plugin to the list of registered plugins
  105965. * @param plugin defines the plugin to add
  105966. */
  105967. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  105968. /**
  105969. * Import meshes into a scene
  105970. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  105971. * @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)
  105972. * @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)
  105973. * @param scene the instance of BABYLON.Scene to append to
  105974. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  105975. * @param onProgress a callback with a progress event for each file being loaded
  105976. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  105977. * @param pluginExtension the extension used to determine the plugin
  105978. * @returns The loaded plugin
  105979. */
  105980. 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>;
  105981. /**
  105982. * Import meshes into a scene
  105983. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  105984. * @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)
  105985. * @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)
  105986. * @param scene the instance of BABYLON.Scene to append to
  105987. * @param onProgress a callback with a progress event for each file being loaded
  105988. * @param pluginExtension the extension used to determine the plugin
  105989. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  105990. */
  105991. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  105992. meshes: AbstractMesh[];
  105993. particleSystems: IParticleSystem[];
  105994. skeletons: Skeleton[];
  105995. animationGroups: AnimationGroup[];
  105996. }>;
  105997. /**
  105998. * Load a scene
  105999. * @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)
  106000. * @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)
  106001. * @param engine is the instance of BABYLON.Engine to use to create the scene
  106002. * @param onSuccess a callback with the scene when import succeeds
  106003. * @param onProgress a callback with a progress event for each file being loaded
  106004. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  106005. * @param pluginExtension the extension used to determine the plugin
  106006. * @returns The loaded plugin
  106007. */
  106008. 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>;
  106009. /**
  106010. * Load a scene
  106011. * @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)
  106012. * @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)
  106013. * @param engine is the instance of BABYLON.Engine to use to create the scene
  106014. * @param onProgress a callback with a progress event for each file being loaded
  106015. * @param pluginExtension the extension used to determine the plugin
  106016. * @returns The loaded scene
  106017. */
  106018. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  106019. /**
  106020. * Append a scene
  106021. * @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)
  106022. * @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)
  106023. * @param scene is the instance of BABYLON.Scene to append to
  106024. * @param onSuccess a callback with the scene when import succeeds
  106025. * @param onProgress a callback with a progress event for each file being loaded
  106026. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  106027. * @param pluginExtension the extension used to determine the plugin
  106028. * @returns The loaded plugin
  106029. */
  106030. 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>;
  106031. /**
  106032. * Append a scene
  106033. * @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)
  106034. * @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)
  106035. * @param scene is the instance of BABYLON.Scene to append to
  106036. * @param onProgress a callback with a progress event for each file being loaded
  106037. * @param pluginExtension the extension used to determine the plugin
  106038. * @returns The given scene
  106039. */
  106040. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  106041. /**
  106042. * Load a scene into an asset container
  106043. * @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)
  106044. * @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)
  106045. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  106046. * @param onSuccess a callback with the scene when import succeeds
  106047. * @param onProgress a callback with a progress event for each file being loaded
  106048. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  106049. * @param pluginExtension the extension used to determine the plugin
  106050. * @returns The loaded plugin
  106051. */
  106052. 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>;
  106053. /**
  106054. * Load a scene into an asset container
  106055. * @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)
  106056. * @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)
  106057. * @param scene is the instance of Scene to append to
  106058. * @param onProgress a callback with a progress event for each file being loaded
  106059. * @param pluginExtension the extension used to determine the plugin
  106060. * @returns The loaded asset container
  106061. */
  106062. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  106063. }
  106064. }
  106065. declare module BABYLON {
  106066. /**
  106067. * Generic Controller
  106068. */
  106069. export class GenericController extends WebVRController {
  106070. /**
  106071. * Base Url for the controller model.
  106072. */
  106073. static readonly MODEL_BASE_URL: string;
  106074. /**
  106075. * File name for the controller model.
  106076. */
  106077. static readonly MODEL_FILENAME: string;
  106078. /**
  106079. * Creates a new GenericController from a gamepad
  106080. * @param vrGamepad the gamepad that the controller should be created from
  106081. */
  106082. constructor(vrGamepad: any);
  106083. /**
  106084. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  106085. * @param scene scene in which to add meshes
  106086. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  106087. */
  106088. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  106089. /**
  106090. * Called once for each button that changed state since the last frame
  106091. * @param buttonIdx Which button index changed
  106092. * @param state New state of the button
  106093. * @param changes Which properties on the state changed since last frame
  106094. */
  106095. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  106096. }
  106097. }
  106098. declare module BABYLON {
  106099. /**
  106100. * Defines the WindowsMotionController object that the state of the windows motion controller
  106101. */
  106102. export class WindowsMotionController extends WebVRController {
  106103. /**
  106104. * The base url used to load the left and right controller models
  106105. */
  106106. static MODEL_BASE_URL: string;
  106107. /**
  106108. * The name of the left controller model file
  106109. */
  106110. static MODEL_LEFT_FILENAME: string;
  106111. /**
  106112. * The name of the right controller model file
  106113. */
  106114. static MODEL_RIGHT_FILENAME: string;
  106115. /**
  106116. * The controller name prefix for this controller type
  106117. */
  106118. static readonly GAMEPAD_ID_PREFIX: string;
  106119. /**
  106120. * The controller id pattern for this controller type
  106121. */
  106122. private static readonly GAMEPAD_ID_PATTERN;
  106123. private _loadedMeshInfo;
  106124. private readonly _mapping;
  106125. /**
  106126. * Fired when the trackpad on this controller is clicked
  106127. */
  106128. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  106129. /**
  106130. * Fired when the trackpad on this controller is modified
  106131. */
  106132. onTrackpadValuesChangedObservable: Observable<StickValues>;
  106133. /**
  106134. * The current x and y values of this controller's trackpad
  106135. */
  106136. trackpad: StickValues;
  106137. /**
  106138. * Creates a new WindowsMotionController from a gamepad
  106139. * @param vrGamepad the gamepad that the controller should be created from
  106140. */
  106141. constructor(vrGamepad: any);
  106142. /**
  106143. * Fired when the trigger on this controller is modified
  106144. */
  106145. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106146. /**
  106147. * Fired when the menu button on this controller is modified
  106148. */
  106149. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106150. /**
  106151. * Fired when the grip button on this controller is modified
  106152. */
  106153. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106154. /**
  106155. * Fired when the thumbstick button on this controller is modified
  106156. */
  106157. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106158. /**
  106159. * Fired when the touchpad button on this controller is modified
  106160. */
  106161. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106162. /**
  106163. * Fired when the touchpad values on this controller are modified
  106164. */
  106165. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  106166. private _updateTrackpad;
  106167. /**
  106168. * Called once per frame by the engine.
  106169. */
  106170. update(): void;
  106171. /**
  106172. * Called once for each button that changed state since the last frame
  106173. * @param buttonIdx Which button index changed
  106174. * @param state New state of the button
  106175. * @param changes Which properties on the state changed since last frame
  106176. */
  106177. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  106178. /**
  106179. * Moves the buttons on the controller mesh based on their current state
  106180. * @param buttonName the name of the button to move
  106181. * @param buttonValue the value of the button which determines the buttons new position
  106182. */
  106183. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  106184. /**
  106185. * Moves the axis on the controller mesh based on its current state
  106186. * @param axis the index of the axis
  106187. * @param axisValue the value of the axis which determines the meshes new position
  106188. * @hidden
  106189. */
  106190. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  106191. /**
  106192. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  106193. * @param scene scene in which to add meshes
  106194. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  106195. */
  106196. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  106197. /**
  106198. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  106199. * can be transformed by button presses and axes values, based on this._mapping.
  106200. *
  106201. * @param scene scene in which the meshes exist
  106202. * @param meshes list of meshes that make up the controller model to process
  106203. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  106204. */
  106205. private processModel;
  106206. private createMeshInfo;
  106207. /**
  106208. * Gets the ray of the controller in the direction the controller is pointing
  106209. * @param length the length the resulting ray should be
  106210. * @returns a ray in the direction the controller is pointing
  106211. */
  106212. getForwardRay(length?: number): Ray;
  106213. /**
  106214. * Disposes of the controller
  106215. */
  106216. dispose(): void;
  106217. }
  106218. }
  106219. declare module BABYLON {
  106220. /**
  106221. * Oculus Touch Controller
  106222. */
  106223. export class OculusTouchController extends WebVRController {
  106224. /**
  106225. * Base Url for the controller model.
  106226. */
  106227. static MODEL_BASE_URL: string;
  106228. /**
  106229. * File name for the left controller model.
  106230. */
  106231. static MODEL_LEFT_FILENAME: string;
  106232. /**
  106233. * File name for the right controller model.
  106234. */
  106235. static MODEL_RIGHT_FILENAME: string;
  106236. /**
  106237. * Base Url for the Quest controller model.
  106238. */
  106239. static QUEST_MODEL_BASE_URL: string;
  106240. /**
  106241. * @hidden
  106242. * If the controllers are running on a device that needs the updated Quest controller models
  106243. */
  106244. static _IsQuest: boolean;
  106245. /**
  106246. * Fired when the secondary trigger on this controller is modified
  106247. */
  106248. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  106249. /**
  106250. * Fired when the thumb rest on this controller is modified
  106251. */
  106252. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  106253. /**
  106254. * Creates a new OculusTouchController from a gamepad
  106255. * @param vrGamepad the gamepad that the controller should be created from
  106256. */
  106257. constructor(vrGamepad: any);
  106258. /**
  106259. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  106260. * @param scene scene in which to add meshes
  106261. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  106262. */
  106263. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  106264. /**
  106265. * Fired when the A button on this controller is modified
  106266. */
  106267. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106268. /**
  106269. * Fired when the B button on this controller is modified
  106270. */
  106271. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106272. /**
  106273. * Fired when the X button on this controller is modified
  106274. */
  106275. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106276. /**
  106277. * Fired when the Y button on this controller is modified
  106278. */
  106279. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106280. /**
  106281. * Called once for each button that changed state since the last frame
  106282. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  106283. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  106284. * 2) secondary trigger (same)
  106285. * 3) A (right) X (left), touch, pressed = value
  106286. * 4) B / Y
  106287. * 5) thumb rest
  106288. * @param buttonIdx Which button index changed
  106289. * @param state New state of the button
  106290. * @param changes Which properties on the state changed since last frame
  106291. */
  106292. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  106293. }
  106294. }
  106295. declare module BABYLON {
  106296. /**
  106297. * Vive Controller
  106298. */
  106299. export class ViveController extends WebVRController {
  106300. /**
  106301. * Base Url for the controller model.
  106302. */
  106303. static MODEL_BASE_URL: string;
  106304. /**
  106305. * File name for the controller model.
  106306. */
  106307. static MODEL_FILENAME: string;
  106308. /**
  106309. * Creates a new ViveController from a gamepad
  106310. * @param vrGamepad the gamepad that the controller should be created from
  106311. */
  106312. constructor(vrGamepad: any);
  106313. /**
  106314. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  106315. * @param scene scene in which to add meshes
  106316. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  106317. */
  106318. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  106319. /**
  106320. * Fired when the left button on this controller is modified
  106321. */
  106322. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106323. /**
  106324. * Fired when the right button on this controller is modified
  106325. */
  106326. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106327. /**
  106328. * Fired when the menu button on this controller is modified
  106329. */
  106330. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  106331. /**
  106332. * Called once for each button that changed state since the last frame
  106333. * Vive mapping:
  106334. * 0: touchpad
  106335. * 1: trigger
  106336. * 2: left AND right buttons
  106337. * 3: menu button
  106338. * @param buttonIdx Which button index changed
  106339. * @param state New state of the button
  106340. * @param changes Which properties on the state changed since last frame
  106341. */
  106342. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  106343. }
  106344. }
  106345. declare module BABYLON {
  106346. /**
  106347. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  106348. */
  106349. export class WebXRControllerModelLoader {
  106350. /**
  106351. * Creates the WebXRControllerModelLoader
  106352. * @param input xr input that creates the controllers
  106353. */
  106354. constructor(input: WebXRInput);
  106355. }
  106356. }
  106357. declare module BABYLON {
  106358. /**
  106359. * Contains an array of blocks representing the octree
  106360. */
  106361. export interface IOctreeContainer<T> {
  106362. /**
  106363. * Blocks within the octree
  106364. */
  106365. blocks: Array<OctreeBlock<T>>;
  106366. }
  106367. /**
  106368. * Class used to store a cell in an octree
  106369. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  106370. */
  106371. export class OctreeBlock<T> {
  106372. /**
  106373. * Gets the content of the current block
  106374. */
  106375. entries: T[];
  106376. /**
  106377. * Gets the list of block children
  106378. */
  106379. blocks: Array<OctreeBlock<T>>;
  106380. private _depth;
  106381. private _maxDepth;
  106382. private _capacity;
  106383. private _minPoint;
  106384. private _maxPoint;
  106385. private _boundingVectors;
  106386. private _creationFunc;
  106387. /**
  106388. * Creates a new block
  106389. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  106390. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  106391. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  106392. * @param depth defines the current depth of this block in the octree
  106393. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  106394. * @param creationFunc defines a callback to call when an element is added to the block
  106395. */
  106396. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  106397. /**
  106398. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  106399. */
  106400. readonly capacity: number;
  106401. /**
  106402. * Gets the minimum vector (in world space) of the block's bounding box
  106403. */
  106404. readonly minPoint: Vector3;
  106405. /**
  106406. * Gets the maximum vector (in world space) of the block's bounding box
  106407. */
  106408. readonly maxPoint: Vector3;
  106409. /**
  106410. * Add a new element to this block
  106411. * @param entry defines the element to add
  106412. */
  106413. addEntry(entry: T): void;
  106414. /**
  106415. * Remove an element from this block
  106416. * @param entry defines the element to remove
  106417. */
  106418. removeEntry(entry: T): void;
  106419. /**
  106420. * Add an array of elements to this block
  106421. * @param entries defines the array of elements to add
  106422. */
  106423. addEntries(entries: T[]): void;
  106424. /**
  106425. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  106426. * @param frustumPlanes defines the frustum planes to test
  106427. * @param selection defines the array to store current content if selection is positive
  106428. * @param allowDuplicate defines if the selection array can contains duplicated entries
  106429. */
  106430. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  106431. /**
  106432. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  106433. * @param sphereCenter defines the bounding sphere center
  106434. * @param sphereRadius defines the bounding sphere radius
  106435. * @param selection defines the array to store current content if selection is positive
  106436. * @param allowDuplicate defines if the selection array can contains duplicated entries
  106437. */
  106438. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  106439. /**
  106440. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  106441. * @param ray defines the ray to test with
  106442. * @param selection defines the array to store current content if selection is positive
  106443. */
  106444. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  106445. /**
  106446. * Subdivide the content into child blocks (this block will then be empty)
  106447. */
  106448. createInnerBlocks(): void;
  106449. /**
  106450. * @hidden
  106451. */
  106452. 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;
  106453. }
  106454. }
  106455. declare module BABYLON {
  106456. /**
  106457. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  106458. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  106459. */
  106460. export class Octree<T> {
  106461. /** 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.) */
  106462. maxDepth: number;
  106463. /**
  106464. * Blocks within the octree containing objects
  106465. */
  106466. blocks: Array<OctreeBlock<T>>;
  106467. /**
  106468. * Content stored in the octree
  106469. */
  106470. dynamicContent: T[];
  106471. private _maxBlockCapacity;
  106472. private _selectionContent;
  106473. private _creationFunc;
  106474. /**
  106475. * Creates a octree
  106476. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  106477. * @param creationFunc function to be used to instatiate the octree
  106478. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  106479. * @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.)
  106480. */
  106481. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  106482. /** 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.) */
  106483. maxDepth?: number);
  106484. /**
  106485. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  106486. * @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);
  106487. * @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);
  106488. * @param entries meshes to be added to the octree blocks
  106489. */
  106490. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  106491. /**
  106492. * Adds a mesh to the octree
  106493. * @param entry Mesh to add to the octree
  106494. */
  106495. addMesh(entry: T): void;
  106496. /**
  106497. * Remove an element from the octree
  106498. * @param entry defines the element to remove
  106499. */
  106500. removeMesh(entry: T): void;
  106501. /**
  106502. * Selects an array of meshes within the frustum
  106503. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  106504. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  106505. * @returns array of meshes within the frustum
  106506. */
  106507. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  106508. /**
  106509. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  106510. * @param sphereCenter defines the bounding sphere center
  106511. * @param sphereRadius defines the bounding sphere radius
  106512. * @param allowDuplicate defines if the selection array can contains duplicated entries
  106513. * @returns an array of objects that intersect the sphere
  106514. */
  106515. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  106516. /**
  106517. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  106518. * @param ray defines the ray to test with
  106519. * @returns array of intersected objects
  106520. */
  106521. intersectsRay(ray: Ray): SmartArray<T>;
  106522. /**
  106523. * Adds a mesh into the octree block if it intersects the block
  106524. */
  106525. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  106526. /**
  106527. * Adds a submesh into the octree block if it intersects the block
  106528. */
  106529. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  106530. }
  106531. }
  106532. declare module BABYLON {
  106533. interface Scene {
  106534. /**
  106535. * @hidden
  106536. * Backing Filed
  106537. */
  106538. _selectionOctree: Octree<AbstractMesh>;
  106539. /**
  106540. * Gets the octree used to boost mesh selection (picking)
  106541. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  106542. */
  106543. selectionOctree: Octree<AbstractMesh>;
  106544. /**
  106545. * Creates or updates the octree used to boost selection (picking)
  106546. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  106547. * @param maxCapacity defines the maximum capacity per leaf
  106548. * @param maxDepth defines the maximum depth of the octree
  106549. * @returns an octree of AbstractMesh
  106550. */
  106551. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  106552. }
  106553. interface AbstractMesh {
  106554. /**
  106555. * @hidden
  106556. * Backing Field
  106557. */
  106558. _submeshesOctree: Octree<SubMesh>;
  106559. /**
  106560. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  106561. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106562. * @param maxCapacity defines the maximum size of each block (64 by default)
  106563. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  106564. * @returns the new octree
  106565. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  106566. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  106567. */
  106568. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  106569. }
  106570. /**
  106571. * Defines the octree scene component responsible to manage any octrees
  106572. * in a given scene.
  106573. */
  106574. export class OctreeSceneComponent {
  106575. /**
  106576. * The component name help to identify the component in the list of scene components.
  106577. */
  106578. readonly name: string;
  106579. /**
  106580. * The scene the component belongs to.
  106581. */
  106582. scene: Scene;
  106583. /**
  106584. * Indicates if the meshes have been checked to make sure they are isEnabled()
  106585. */
  106586. readonly checksIsEnabled: boolean;
  106587. /**
  106588. * Creates a new instance of the component for the given scene
  106589. * @param scene Defines the scene to register the component in
  106590. */
  106591. constructor(scene: Scene);
  106592. /**
  106593. * Registers the component in a given scene
  106594. */
  106595. register(): void;
  106596. /**
  106597. * Return the list of active meshes
  106598. * @returns the list of active meshes
  106599. */
  106600. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  106601. /**
  106602. * Return the list of active sub meshes
  106603. * @param mesh The mesh to get the candidates sub meshes from
  106604. * @returns the list of active sub meshes
  106605. */
  106606. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  106607. private _tempRay;
  106608. /**
  106609. * Return the list of sub meshes intersecting with a given local ray
  106610. * @param mesh defines the mesh to find the submesh for
  106611. * @param localRay defines the ray in local space
  106612. * @returns the list of intersecting sub meshes
  106613. */
  106614. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  106615. /**
  106616. * Return the list of sub meshes colliding with a collider
  106617. * @param mesh defines the mesh to find the submesh for
  106618. * @param collider defines the collider to evaluate the collision against
  106619. * @returns the list of colliding sub meshes
  106620. */
  106621. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  106622. /**
  106623. * Rebuilds the elements related to this component in case of
  106624. * context lost for instance.
  106625. */
  106626. rebuild(): void;
  106627. /**
  106628. * Disposes the component and the associated ressources.
  106629. */
  106630. dispose(): void;
  106631. }
  106632. }
  106633. declare module BABYLON {
  106634. /**
  106635. * Renders a layer on top of an existing scene
  106636. */
  106637. export class UtilityLayerRenderer implements IDisposable {
  106638. /** the original scene that will be rendered on top of */
  106639. originalScene: Scene;
  106640. private _pointerCaptures;
  106641. private _lastPointerEvents;
  106642. private static _DefaultUtilityLayer;
  106643. private static _DefaultKeepDepthUtilityLayer;
  106644. private _sharedGizmoLight;
  106645. private _renderCamera;
  106646. /**
  106647. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  106648. * @returns the camera that is used when rendering the utility layer
  106649. */
  106650. getRenderCamera(): Nullable<Camera>;
  106651. /**
  106652. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  106653. * @param cam the camera that should be used when rendering the utility layer
  106654. */
  106655. setRenderCamera(cam: Nullable<Camera>): void;
  106656. /**
  106657. * @hidden
  106658. * Light which used by gizmos to get light shading
  106659. */
  106660. _getSharedGizmoLight(): HemisphericLight;
  106661. /**
  106662. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  106663. */
  106664. pickUtilitySceneFirst: boolean;
  106665. /**
  106666. * 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)
  106667. */
  106668. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  106669. /**
  106670. * 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)
  106671. */
  106672. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  106673. /**
  106674. * The scene that is rendered on top of the original scene
  106675. */
  106676. utilityLayerScene: Scene;
  106677. /**
  106678. * If the utility layer should automatically be rendered on top of existing scene
  106679. */
  106680. shouldRender: boolean;
  106681. /**
  106682. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  106683. */
  106684. onlyCheckPointerDownEvents: boolean;
  106685. /**
  106686. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  106687. */
  106688. processAllEvents: boolean;
  106689. /**
  106690. * Observable raised when the pointer move from the utility layer scene to the main scene
  106691. */
  106692. onPointerOutObservable: Observable<number>;
  106693. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  106694. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  106695. private _afterRenderObserver;
  106696. private _sceneDisposeObserver;
  106697. private _originalPointerObserver;
  106698. /**
  106699. * Instantiates a UtilityLayerRenderer
  106700. * @param originalScene the original scene that will be rendered on top of
  106701. * @param handleEvents boolean indicating if the utility layer should handle events
  106702. */
  106703. constructor(
  106704. /** the original scene that will be rendered on top of */
  106705. originalScene: Scene, handleEvents?: boolean);
  106706. private _notifyObservers;
  106707. /**
  106708. * Renders the utility layers scene on top of the original scene
  106709. */
  106710. render(): void;
  106711. /**
  106712. * Disposes of the renderer
  106713. */
  106714. dispose(): void;
  106715. private _updateCamera;
  106716. }
  106717. }
  106718. declare module BABYLON {
  106719. /**
  106720. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  106721. */
  106722. export class Gizmo implements IDisposable {
  106723. /** The utility layer the gizmo will be added to */
  106724. gizmoLayer: UtilityLayerRenderer;
  106725. /**
  106726. * The root mesh of the gizmo
  106727. */
  106728. _rootMesh: Mesh;
  106729. private _attachedMesh;
  106730. /**
  106731. * Ratio for the scale of the gizmo (Default: 1)
  106732. */
  106733. scaleRatio: number;
  106734. /**
  106735. * If a custom mesh has been set (Default: false)
  106736. */
  106737. protected _customMeshSet: boolean;
  106738. /**
  106739. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  106740. * * When set, interactions will be enabled
  106741. */
  106742. attachedMesh: Nullable<AbstractMesh>;
  106743. /**
  106744. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  106745. * @param mesh The mesh to replace the default mesh of the gizmo
  106746. */
  106747. setCustomMesh(mesh: Mesh): void;
  106748. /**
  106749. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  106750. */
  106751. updateGizmoRotationToMatchAttachedMesh: boolean;
  106752. /**
  106753. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  106754. */
  106755. updateGizmoPositionToMatchAttachedMesh: boolean;
  106756. /**
  106757. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  106758. */
  106759. updateScale: boolean;
  106760. protected _interactionsEnabled: boolean;
  106761. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  106762. private _beforeRenderObserver;
  106763. private _tempVector;
  106764. /**
  106765. * Creates a gizmo
  106766. * @param gizmoLayer The utility layer the gizmo will be added to
  106767. */
  106768. constructor(
  106769. /** The utility layer the gizmo will be added to */
  106770. gizmoLayer?: UtilityLayerRenderer);
  106771. /**
  106772. * Updates the gizmo to match the attached mesh's position/rotation
  106773. */
  106774. protected _update(): void;
  106775. /**
  106776. * Disposes of the gizmo
  106777. */
  106778. dispose(): void;
  106779. }
  106780. }
  106781. declare module BABYLON {
  106782. /**
  106783. * Single plane drag gizmo
  106784. */
  106785. export class PlaneDragGizmo extends Gizmo {
  106786. /**
  106787. * Drag behavior responsible for the gizmos dragging interactions
  106788. */
  106789. dragBehavior: PointerDragBehavior;
  106790. private _pointerObserver;
  106791. /**
  106792. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  106793. */
  106794. snapDistance: number;
  106795. /**
  106796. * Event that fires each time the gizmo snaps to a new location.
  106797. * * snapDistance is the the change in distance
  106798. */
  106799. onSnapObservable: Observable<{
  106800. snapDistance: number;
  106801. }>;
  106802. private _plane;
  106803. private _coloredMaterial;
  106804. private _hoverMaterial;
  106805. private _isEnabled;
  106806. private _parent;
  106807. /** @hidden */
  106808. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  106809. /** @hidden */
  106810. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  106811. /**
  106812. * Creates a PlaneDragGizmo
  106813. * @param gizmoLayer The utility layer the gizmo will be added to
  106814. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  106815. * @param color The color of the gizmo
  106816. */
  106817. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  106818. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  106819. /**
  106820. * If the gizmo is enabled
  106821. */
  106822. isEnabled: boolean;
  106823. /**
  106824. * Disposes of the gizmo
  106825. */
  106826. dispose(): void;
  106827. }
  106828. }
  106829. declare module BABYLON {
  106830. /**
  106831. * Gizmo that enables dragging a mesh along 3 axis
  106832. */
  106833. export class PositionGizmo extends Gizmo {
  106834. /**
  106835. * Internal gizmo used for interactions on the x axis
  106836. */
  106837. xGizmo: AxisDragGizmo;
  106838. /**
  106839. * Internal gizmo used for interactions on the y axis
  106840. */
  106841. yGizmo: AxisDragGizmo;
  106842. /**
  106843. * Internal gizmo used for interactions on the z axis
  106844. */
  106845. zGizmo: AxisDragGizmo;
  106846. /**
  106847. * Internal gizmo used for interactions on the yz plane
  106848. */
  106849. xPlaneGizmo: PlaneDragGizmo;
  106850. /**
  106851. * Internal gizmo used for interactions on the xz plane
  106852. */
  106853. yPlaneGizmo: PlaneDragGizmo;
  106854. /**
  106855. * Internal gizmo used for interactions on the xy plane
  106856. */
  106857. zPlaneGizmo: PlaneDragGizmo;
  106858. /**
  106859. * private variables
  106860. */
  106861. private _meshAttached;
  106862. private _updateGizmoRotationToMatchAttachedMesh;
  106863. private _snapDistance;
  106864. private _scaleRatio;
  106865. /** Fires an event when any of it's sub gizmos are dragged */
  106866. onDragStartObservable: Observable<unknown>;
  106867. /** Fires an event when any of it's sub gizmos are released from dragging */
  106868. onDragEndObservable: Observable<unknown>;
  106869. /**
  106870. * If set to true, planar drag is enabled
  106871. */
  106872. private _planarGizmoEnabled;
  106873. attachedMesh: Nullable<AbstractMesh>;
  106874. /**
  106875. * Creates a PositionGizmo
  106876. * @param gizmoLayer The utility layer the gizmo will be added to
  106877. */
  106878. constructor(gizmoLayer?: UtilityLayerRenderer);
  106879. /**
  106880. * If the planar drag gizmo is enabled
  106881. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  106882. */
  106883. planarGizmoEnabled: boolean;
  106884. updateGizmoRotationToMatchAttachedMesh: boolean;
  106885. /**
  106886. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  106887. */
  106888. snapDistance: number;
  106889. /**
  106890. * Ratio for the scale of the gizmo (Default: 1)
  106891. */
  106892. scaleRatio: number;
  106893. /**
  106894. * Disposes of the gizmo
  106895. */
  106896. dispose(): void;
  106897. /**
  106898. * CustomMeshes are not supported by this gizmo
  106899. * @param mesh The mesh to replace the default mesh of the gizmo
  106900. */
  106901. setCustomMesh(mesh: Mesh): void;
  106902. }
  106903. }
  106904. declare module BABYLON {
  106905. /**
  106906. * Single axis drag gizmo
  106907. */
  106908. export class AxisDragGizmo extends Gizmo {
  106909. /**
  106910. * Drag behavior responsible for the gizmos dragging interactions
  106911. */
  106912. dragBehavior: PointerDragBehavior;
  106913. private _pointerObserver;
  106914. /**
  106915. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  106916. */
  106917. snapDistance: number;
  106918. /**
  106919. * Event that fires each time the gizmo snaps to a new location.
  106920. * * snapDistance is the the change in distance
  106921. */
  106922. onSnapObservable: Observable<{
  106923. snapDistance: number;
  106924. }>;
  106925. private _isEnabled;
  106926. private _parent;
  106927. private _arrow;
  106928. private _coloredMaterial;
  106929. private _hoverMaterial;
  106930. /** @hidden */
  106931. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  106932. /** @hidden */
  106933. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  106934. /**
  106935. * Creates an AxisDragGizmo
  106936. * @param gizmoLayer The utility layer the gizmo will be added to
  106937. * @param dragAxis The axis which the gizmo will be able to drag on
  106938. * @param color The color of the gizmo
  106939. */
  106940. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  106941. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  106942. /**
  106943. * If the gizmo is enabled
  106944. */
  106945. isEnabled: boolean;
  106946. /**
  106947. * Disposes of the gizmo
  106948. */
  106949. dispose(): void;
  106950. }
  106951. }
  106952. declare module BABYLON.Debug {
  106953. /**
  106954. * The Axes viewer will show 3 axes in a specific point in space
  106955. */
  106956. export class AxesViewer {
  106957. private _xAxis;
  106958. private _yAxis;
  106959. private _zAxis;
  106960. private _scaleLinesFactor;
  106961. private _instanced;
  106962. /**
  106963. * Gets the hosting scene
  106964. */
  106965. scene: Scene;
  106966. /**
  106967. * Gets or sets a number used to scale line length
  106968. */
  106969. scaleLines: number;
  106970. /** Gets the node hierarchy used to render x-axis */
  106971. readonly xAxis: TransformNode;
  106972. /** Gets the node hierarchy used to render y-axis */
  106973. readonly yAxis: TransformNode;
  106974. /** Gets the node hierarchy used to render z-axis */
  106975. readonly zAxis: TransformNode;
  106976. /**
  106977. * Creates a new AxesViewer
  106978. * @param scene defines the hosting scene
  106979. * @param scaleLines defines a number used to scale line length (1 by default)
  106980. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  106981. * @param xAxis defines the node hierarchy used to render the x-axis
  106982. * @param yAxis defines the node hierarchy used to render the y-axis
  106983. * @param zAxis defines the node hierarchy used to render the z-axis
  106984. */
  106985. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  106986. /**
  106987. * Force the viewer to update
  106988. * @param position defines the position of the viewer
  106989. * @param xaxis defines the x axis of the viewer
  106990. * @param yaxis defines the y axis of the viewer
  106991. * @param zaxis defines the z axis of the viewer
  106992. */
  106993. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  106994. /**
  106995. * Creates an instance of this axes viewer.
  106996. * @returns a new axes viewer with instanced meshes
  106997. */
  106998. createInstance(): AxesViewer;
  106999. /** Releases resources */
  107000. dispose(): void;
  107001. private static _SetRenderingGroupId;
  107002. }
  107003. }
  107004. declare module BABYLON.Debug {
  107005. /**
  107006. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  107007. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  107008. */
  107009. export class BoneAxesViewer extends AxesViewer {
  107010. /**
  107011. * Gets or sets the target mesh where to display the axes viewer
  107012. */
  107013. mesh: Nullable<Mesh>;
  107014. /**
  107015. * Gets or sets the target bone where to display the axes viewer
  107016. */
  107017. bone: Nullable<Bone>;
  107018. /** Gets current position */
  107019. pos: Vector3;
  107020. /** Gets direction of X axis */
  107021. xaxis: Vector3;
  107022. /** Gets direction of Y axis */
  107023. yaxis: Vector3;
  107024. /** Gets direction of Z axis */
  107025. zaxis: Vector3;
  107026. /**
  107027. * Creates a new BoneAxesViewer
  107028. * @param scene defines the hosting scene
  107029. * @param bone defines the target bone
  107030. * @param mesh defines the target mesh
  107031. * @param scaleLines defines a scaling factor for line length (1 by default)
  107032. */
  107033. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  107034. /**
  107035. * Force the viewer to update
  107036. */
  107037. update(): void;
  107038. /** Releases resources */
  107039. dispose(): void;
  107040. }
  107041. }
  107042. declare module BABYLON {
  107043. /**
  107044. * Interface used to define scene explorer extensibility option
  107045. */
  107046. export interface IExplorerExtensibilityOption {
  107047. /**
  107048. * Define the option label
  107049. */
  107050. label: string;
  107051. /**
  107052. * Defines the action to execute on click
  107053. */
  107054. action: (entity: any) => void;
  107055. }
  107056. /**
  107057. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  107058. */
  107059. export interface IExplorerExtensibilityGroup {
  107060. /**
  107061. * Defines a predicate to test if a given type mut be extended
  107062. */
  107063. predicate: (entity: any) => boolean;
  107064. /**
  107065. * Gets the list of options added to a type
  107066. */
  107067. entries: IExplorerExtensibilityOption[];
  107068. }
  107069. /**
  107070. * Interface used to define the options to use to create the Inspector
  107071. */
  107072. export interface IInspectorOptions {
  107073. /**
  107074. * Display in overlay mode (default: false)
  107075. */
  107076. overlay?: boolean;
  107077. /**
  107078. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  107079. */
  107080. globalRoot?: HTMLElement;
  107081. /**
  107082. * Display the Scene explorer
  107083. */
  107084. showExplorer?: boolean;
  107085. /**
  107086. * Display the property inspector
  107087. */
  107088. showInspector?: boolean;
  107089. /**
  107090. * Display in embed mode (both panes on the right)
  107091. */
  107092. embedMode?: boolean;
  107093. /**
  107094. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  107095. */
  107096. handleResize?: boolean;
  107097. /**
  107098. * Allow the panes to popup (default: true)
  107099. */
  107100. enablePopup?: boolean;
  107101. /**
  107102. * Allow the panes to be closed by users (default: true)
  107103. */
  107104. enableClose?: boolean;
  107105. /**
  107106. * Optional list of extensibility entries
  107107. */
  107108. explorerExtensibility?: IExplorerExtensibilityGroup[];
  107109. /**
  107110. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  107111. */
  107112. inspectorURL?: string;
  107113. }
  107114. interface Scene {
  107115. /**
  107116. * @hidden
  107117. * Backing field
  107118. */
  107119. _debugLayer: DebugLayer;
  107120. /**
  107121. * Gets the debug layer (aka Inspector) associated with the scene
  107122. * @see http://doc.babylonjs.com/features/playground_debuglayer
  107123. */
  107124. debugLayer: DebugLayer;
  107125. }
  107126. /**
  107127. * The debug layer (aka Inspector) is the go to tool in order to better understand
  107128. * what is happening in your scene
  107129. * @see http://doc.babylonjs.com/features/playground_debuglayer
  107130. */
  107131. export class DebugLayer {
  107132. /**
  107133. * Define the url to get the inspector script from.
  107134. * By default it uses the babylonjs CDN.
  107135. * @ignoreNaming
  107136. */
  107137. static InspectorURL: string;
  107138. private _scene;
  107139. private BJSINSPECTOR;
  107140. private _onPropertyChangedObservable?;
  107141. /**
  107142. * Observable triggered when a property is changed through the inspector.
  107143. */
  107144. readonly onPropertyChangedObservable: any;
  107145. /**
  107146. * Instantiates a new debug layer.
  107147. * The debug layer (aka Inspector) is the go to tool in order to better understand
  107148. * what is happening in your scene
  107149. * @see http://doc.babylonjs.com/features/playground_debuglayer
  107150. * @param scene Defines the scene to inspect
  107151. */
  107152. constructor(scene: Scene);
  107153. /** Creates the inspector window. */
  107154. private _createInspector;
  107155. /**
  107156. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  107157. * @param entity defines the entity to select
  107158. * @param lineContainerTitle defines the specific block to highlight
  107159. */
  107160. select(entity: any, lineContainerTitle?: string): void;
  107161. /** Get the inspector from bundle or global */
  107162. private _getGlobalInspector;
  107163. /**
  107164. * Get if the inspector is visible or not.
  107165. * @returns true if visible otherwise, false
  107166. */
  107167. isVisible(): boolean;
  107168. /**
  107169. * Hide the inspector and close its window.
  107170. */
  107171. hide(): void;
  107172. /**
  107173. * Launch the debugLayer.
  107174. * @param config Define the configuration of the inspector
  107175. * @return a promise fulfilled when the debug layer is visible
  107176. */
  107177. show(config?: IInspectorOptions): Promise<DebugLayer>;
  107178. }
  107179. }
  107180. declare module BABYLON {
  107181. /**
  107182. * Class containing static functions to help procedurally build meshes
  107183. */
  107184. export class BoxBuilder {
  107185. /**
  107186. * Creates a box mesh
  107187. * * The parameter `size` sets the size (float) of each box side (default 1)
  107188. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  107189. * * 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)
  107190. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  107191. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  107192. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  107193. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107194. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  107195. * @param name defines the name of the mesh
  107196. * @param options defines the options used to create the mesh
  107197. * @param scene defines the hosting scene
  107198. * @returns the box mesh
  107199. */
  107200. static CreateBox(name: string, options: {
  107201. size?: number;
  107202. width?: number;
  107203. height?: number;
  107204. depth?: number;
  107205. faceUV?: Vector4[];
  107206. faceColors?: Color4[];
  107207. sideOrientation?: number;
  107208. frontUVs?: Vector4;
  107209. backUVs?: Vector4;
  107210. wrap?: boolean;
  107211. topBaseAt?: number;
  107212. bottomBaseAt?: number;
  107213. updatable?: boolean;
  107214. }, scene?: Nullable<Scene>): Mesh;
  107215. }
  107216. }
  107217. declare module BABYLON {
  107218. /**
  107219. * Class containing static functions to help procedurally build meshes
  107220. */
  107221. export class SphereBuilder {
  107222. /**
  107223. * Creates a sphere mesh
  107224. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  107225. * * 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`)
  107226. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  107227. * * 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
  107228. * * 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)
  107229. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  107230. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  107231. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107232. * @param name defines the name of the mesh
  107233. * @param options defines the options used to create the mesh
  107234. * @param scene defines the hosting scene
  107235. * @returns the sphere mesh
  107236. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  107237. */
  107238. static CreateSphere(name: string, options: {
  107239. segments?: number;
  107240. diameter?: number;
  107241. diameterX?: number;
  107242. diameterY?: number;
  107243. diameterZ?: number;
  107244. arc?: number;
  107245. slice?: number;
  107246. sideOrientation?: number;
  107247. frontUVs?: Vector4;
  107248. backUVs?: Vector4;
  107249. updatable?: boolean;
  107250. }, scene: any): Mesh;
  107251. }
  107252. }
  107253. declare module BABYLON.Debug {
  107254. /**
  107255. * Used to show the physics impostor around the specific mesh
  107256. */
  107257. export class PhysicsViewer {
  107258. /** @hidden */
  107259. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  107260. /** @hidden */
  107261. protected _meshes: Array<Nullable<AbstractMesh>>;
  107262. /** @hidden */
  107263. protected _scene: Nullable<Scene>;
  107264. /** @hidden */
  107265. protected _numMeshes: number;
  107266. /** @hidden */
  107267. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  107268. private _renderFunction;
  107269. private _utilityLayer;
  107270. private _debugBoxMesh;
  107271. private _debugSphereMesh;
  107272. private _debugCylinderMesh;
  107273. private _debugMaterial;
  107274. private _debugMeshMeshes;
  107275. /**
  107276. * Creates a new PhysicsViewer
  107277. * @param scene defines the hosting scene
  107278. */
  107279. constructor(scene: Scene);
  107280. /** @hidden */
  107281. protected _updateDebugMeshes(): void;
  107282. /**
  107283. * Renders a specified physic impostor
  107284. * @param impostor defines the impostor to render
  107285. * @param targetMesh defines the mesh represented by the impostor
  107286. * @returns the new debug mesh used to render the impostor
  107287. */
  107288. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  107289. /**
  107290. * Hides a specified physic impostor
  107291. * @param impostor defines the impostor to hide
  107292. */
  107293. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  107294. private _getDebugMaterial;
  107295. private _getDebugBoxMesh;
  107296. private _getDebugSphereMesh;
  107297. private _getDebugCylinderMesh;
  107298. private _getDebugMeshMesh;
  107299. private _getDebugMesh;
  107300. /** Releases all resources */
  107301. dispose(): void;
  107302. }
  107303. }
  107304. declare module BABYLON {
  107305. /**
  107306. * Class containing static functions to help procedurally build meshes
  107307. */
  107308. export class LinesBuilder {
  107309. /**
  107310. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  107311. * * 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
  107312. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  107313. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  107314. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  107315. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  107316. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  107317. * * 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
  107318. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  107319. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107320. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  107321. * @param name defines the name of the new line system
  107322. * @param options defines the options used to create the line system
  107323. * @param scene defines the hosting scene
  107324. * @returns a new line system mesh
  107325. */
  107326. static CreateLineSystem(name: string, options: {
  107327. lines: Vector3[][];
  107328. updatable?: boolean;
  107329. instance?: Nullable<LinesMesh>;
  107330. colors?: Nullable<Color4[][]>;
  107331. useVertexAlpha?: boolean;
  107332. }, scene: Nullable<Scene>): LinesMesh;
  107333. /**
  107334. * Creates a line mesh
  107335. * 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
  107336. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  107337. * * The parameter `points` is an array successive Vector3
  107338. * * 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
  107339. * * The optional parameter `colors` is an array of successive Color4, one per line point
  107340. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  107341. * * When updating an instance, remember that only point positions can change, not the number of points
  107342. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107343. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  107344. * @param name defines the name of the new line system
  107345. * @param options defines the options used to create the line system
  107346. * @param scene defines the hosting scene
  107347. * @returns a new line mesh
  107348. */
  107349. static CreateLines(name: string, options: {
  107350. points: Vector3[];
  107351. updatable?: boolean;
  107352. instance?: Nullable<LinesMesh>;
  107353. colors?: Color4[];
  107354. useVertexAlpha?: boolean;
  107355. }, scene?: Nullable<Scene>): LinesMesh;
  107356. /**
  107357. * Creates a dashed line mesh
  107358. * * 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
  107359. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  107360. * * The parameter `points` is an array successive Vector3
  107361. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  107362. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  107363. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  107364. * * 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
  107365. * * When updating an instance, remember that only point positions can change, not the number of points
  107366. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107367. * @param name defines the name of the mesh
  107368. * @param options defines the options used to create the mesh
  107369. * @param scene defines the hosting scene
  107370. * @returns the dashed line mesh
  107371. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  107372. */
  107373. static CreateDashedLines(name: string, options: {
  107374. points: Vector3[];
  107375. dashSize?: number;
  107376. gapSize?: number;
  107377. dashNb?: number;
  107378. updatable?: boolean;
  107379. instance?: LinesMesh;
  107380. }, scene?: Nullable<Scene>): LinesMesh;
  107381. }
  107382. }
  107383. declare module BABYLON {
  107384. /**
  107385. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  107386. * in order to better appreciate the issue one might have.
  107387. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  107388. */
  107389. export class RayHelper {
  107390. /**
  107391. * Defines the ray we are currently tryin to visualize.
  107392. */
  107393. ray: Nullable<Ray>;
  107394. private _renderPoints;
  107395. private _renderLine;
  107396. private _renderFunction;
  107397. private _scene;
  107398. private _updateToMeshFunction;
  107399. private _attachedToMesh;
  107400. private _meshSpaceDirection;
  107401. private _meshSpaceOrigin;
  107402. /**
  107403. * Helper function to create a colored helper in a scene in one line.
  107404. * @param ray Defines the ray we are currently tryin to visualize
  107405. * @param scene Defines the scene the ray is used in
  107406. * @param color Defines the color we want to see the ray in
  107407. * @returns The newly created ray helper.
  107408. */
  107409. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  107410. /**
  107411. * Instantiate a new ray helper.
  107412. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  107413. * in order to better appreciate the issue one might have.
  107414. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  107415. * @param ray Defines the ray we are currently tryin to visualize
  107416. */
  107417. constructor(ray: Ray);
  107418. /**
  107419. * Shows the ray we are willing to debug.
  107420. * @param scene Defines the scene the ray needs to be rendered in
  107421. * @param color Defines the color the ray needs to be rendered in
  107422. */
  107423. show(scene: Scene, color?: Color3): void;
  107424. /**
  107425. * Hides the ray we are debugging.
  107426. */
  107427. hide(): void;
  107428. private _render;
  107429. /**
  107430. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  107431. * @param mesh Defines the mesh we want the helper attached to
  107432. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  107433. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  107434. * @param length Defines the length of the ray
  107435. */
  107436. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  107437. /**
  107438. * Detach the ray helper from the mesh it has previously been attached to.
  107439. */
  107440. detachFromMesh(): void;
  107441. private _updateToMesh;
  107442. /**
  107443. * Dispose the helper and release its associated resources.
  107444. */
  107445. dispose(): void;
  107446. }
  107447. }
  107448. declare module BABYLON.Debug {
  107449. /**
  107450. * Class used to render a debug view of a given skeleton
  107451. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  107452. */
  107453. export class SkeletonViewer {
  107454. /** defines the skeleton to render */
  107455. skeleton: Skeleton;
  107456. /** defines the mesh attached to the skeleton */
  107457. mesh: AbstractMesh;
  107458. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  107459. autoUpdateBonesMatrices: boolean;
  107460. /** defines the rendering group id to use with the viewer */
  107461. renderingGroupId: number;
  107462. /** Gets or sets the color used to render the skeleton */
  107463. color: Color3;
  107464. private _scene;
  107465. private _debugLines;
  107466. private _debugMesh;
  107467. private _isEnabled;
  107468. private _renderFunction;
  107469. private _utilityLayer;
  107470. /**
  107471. * Returns the mesh used to render the bones
  107472. */
  107473. readonly debugMesh: Nullable<LinesMesh>;
  107474. /**
  107475. * Creates a new SkeletonViewer
  107476. * @param skeleton defines the skeleton to render
  107477. * @param mesh defines the mesh attached to the skeleton
  107478. * @param scene defines the hosting scene
  107479. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  107480. * @param renderingGroupId defines the rendering group id to use with the viewer
  107481. */
  107482. constructor(
  107483. /** defines the skeleton to render */
  107484. skeleton: Skeleton,
  107485. /** defines the mesh attached to the skeleton */
  107486. mesh: AbstractMesh, scene: Scene,
  107487. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  107488. autoUpdateBonesMatrices?: boolean,
  107489. /** defines the rendering group id to use with the viewer */
  107490. renderingGroupId?: number);
  107491. /** Gets or sets a boolean indicating if the viewer is enabled */
  107492. isEnabled: boolean;
  107493. private _getBonePosition;
  107494. private _getLinesForBonesWithLength;
  107495. private _getLinesForBonesNoLength;
  107496. /** Update the viewer to sync with current skeleton state */
  107497. update(): void;
  107498. /** Release associated resources */
  107499. dispose(): void;
  107500. }
  107501. }
  107502. declare module BABYLON {
  107503. /**
  107504. * Options to create the null engine
  107505. */
  107506. export class NullEngineOptions {
  107507. /**
  107508. * Render width (Default: 512)
  107509. */
  107510. renderWidth: number;
  107511. /**
  107512. * Render height (Default: 256)
  107513. */
  107514. renderHeight: number;
  107515. /**
  107516. * Texture size (Default: 512)
  107517. */
  107518. textureSize: number;
  107519. /**
  107520. * If delta time between frames should be constant
  107521. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  107522. */
  107523. deterministicLockstep: boolean;
  107524. /**
  107525. * Maximum about of steps between frames (Default: 4)
  107526. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  107527. */
  107528. lockstepMaxSteps: number;
  107529. }
  107530. /**
  107531. * The null engine class provides support for headless version of babylon.js.
  107532. * This can be used in server side scenario or for testing purposes
  107533. */
  107534. export class NullEngine extends Engine {
  107535. private _options;
  107536. /**
  107537. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  107538. */
  107539. isDeterministicLockStep(): boolean;
  107540. /** @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep */
  107541. getLockstepMaxSteps(): number;
  107542. /**
  107543. * Sets hardware scaling, used to save performance if needed
  107544. * @see https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  107545. */
  107546. getHardwareScalingLevel(): number;
  107547. constructor(options?: NullEngineOptions);
  107548. createVertexBuffer(vertices: FloatArray): DataBuffer;
  107549. createIndexBuffer(indices: IndicesArray): DataBuffer;
  107550. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  107551. getRenderWidth(useScreen?: boolean): number;
  107552. getRenderHeight(useScreen?: boolean): number;
  107553. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  107554. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  107555. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  107556. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  107557. bindSamplers(effect: Effect): void;
  107558. enableEffect(effect: Effect): void;
  107559. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  107560. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  107561. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  107562. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  107563. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  107564. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  107565. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  107566. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  107567. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  107568. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  107569. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  107570. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  107571. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  107572. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  107573. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  107574. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  107575. setFloat(uniform: WebGLUniformLocation, value: number): void;
  107576. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  107577. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  107578. setBool(uniform: WebGLUniformLocation, bool: number): void;
  107579. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  107580. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  107581. bindBuffers(vertexBuffers: {
  107582. [key: string]: VertexBuffer;
  107583. }, indexBuffer: DataBuffer, effect: Effect): void;
  107584. wipeCaches(bruteForce?: boolean): void;
  107585. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  107586. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  107587. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  107588. /** @hidden */
  107589. _createTexture(): WebGLTexture;
  107590. /** @hidden */
  107591. _releaseTexture(texture: InternalTexture): void;
  107592. 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;
  107593. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  107594. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  107595. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  107596. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  107597. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  107598. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  107599. areAllEffectsReady(): boolean;
  107600. /**
  107601. * @hidden
  107602. * Get the current error code of the webGL context
  107603. * @returns the error code
  107604. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  107605. */
  107606. getError(): number;
  107607. /** @hidden */
  107608. _getUnpackAlignement(): number;
  107609. /** @hidden */
  107610. _unpackFlipY(value: boolean): void;
  107611. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  107612. /**
  107613. * Updates a dynamic vertex buffer.
  107614. * @param vertexBuffer the vertex buffer to update
  107615. * @param data the data used to update the vertex buffer
  107616. * @param byteOffset the byte offset of the data (optional)
  107617. * @param byteLength the byte length of the data (optional)
  107618. */
  107619. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  107620. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  107621. /** @hidden */
  107622. _bindTexture(channel: number, texture: InternalTexture): void;
  107623. /** @hidden */
  107624. _releaseBuffer(buffer: DataBuffer): boolean;
  107625. releaseEffects(): void;
  107626. displayLoadingUI(): void;
  107627. hideLoadingUI(): void;
  107628. /** @hidden */
  107629. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  107630. /** @hidden */
  107631. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  107632. /** @hidden */
  107633. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  107634. /** @hidden */
  107635. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  107636. }
  107637. }
  107638. declare module BABYLON {
  107639. /** @hidden */
  107640. export class _OcclusionDataStorage {
  107641. /** @hidden */
  107642. occlusionInternalRetryCounter: number;
  107643. /** @hidden */
  107644. isOcclusionQueryInProgress: boolean;
  107645. /** @hidden */
  107646. isOccluded: boolean;
  107647. /** @hidden */
  107648. occlusionRetryCount: number;
  107649. /** @hidden */
  107650. occlusionType: number;
  107651. /** @hidden */
  107652. occlusionQueryAlgorithmType: number;
  107653. }
  107654. interface Engine {
  107655. /**
  107656. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  107657. * @return the new query
  107658. */
  107659. createQuery(): WebGLQuery;
  107660. /**
  107661. * Delete and release a webGL query
  107662. * @param query defines the query to delete
  107663. * @return the current engine
  107664. */
  107665. deleteQuery(query: WebGLQuery): Engine;
  107666. /**
  107667. * Check if a given query has resolved and got its value
  107668. * @param query defines the query to check
  107669. * @returns true if the query got its value
  107670. */
  107671. isQueryResultAvailable(query: WebGLQuery): boolean;
  107672. /**
  107673. * Gets the value of a given query
  107674. * @param query defines the query to check
  107675. * @returns the value of the query
  107676. */
  107677. getQueryResult(query: WebGLQuery): number;
  107678. /**
  107679. * Initiates an occlusion query
  107680. * @param algorithmType defines the algorithm to use
  107681. * @param query defines the query to use
  107682. * @returns the current engine
  107683. * @see http://doc.babylonjs.com/features/occlusionquery
  107684. */
  107685. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  107686. /**
  107687. * Ends an occlusion query
  107688. * @see http://doc.babylonjs.com/features/occlusionquery
  107689. * @param algorithmType defines the algorithm to use
  107690. * @returns the current engine
  107691. */
  107692. endOcclusionQuery(algorithmType: number): Engine;
  107693. /**
  107694. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  107695. * Please note that only one query can be issued at a time
  107696. * @returns a time token used to track the time span
  107697. */
  107698. startTimeQuery(): Nullable<_TimeToken>;
  107699. /**
  107700. * Ends a time query
  107701. * @param token defines the token used to measure the time span
  107702. * @returns the time spent (in ns)
  107703. */
  107704. endTimeQuery(token: _TimeToken): int;
  107705. /** @hidden */
  107706. _currentNonTimestampToken: Nullable<_TimeToken>;
  107707. /** @hidden */
  107708. _createTimeQuery(): WebGLQuery;
  107709. /** @hidden */
  107710. _deleteTimeQuery(query: WebGLQuery): void;
  107711. /** @hidden */
  107712. _getGlAlgorithmType(algorithmType: number): number;
  107713. /** @hidden */
  107714. _getTimeQueryResult(query: WebGLQuery): any;
  107715. /** @hidden */
  107716. _getTimeQueryAvailability(query: WebGLQuery): any;
  107717. }
  107718. interface AbstractMesh {
  107719. /**
  107720. * Backing filed
  107721. * @hidden
  107722. */
  107723. __occlusionDataStorage: _OcclusionDataStorage;
  107724. /**
  107725. * Access property
  107726. * @hidden
  107727. */
  107728. _occlusionDataStorage: _OcclusionDataStorage;
  107729. /**
  107730. * 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.
  107731. * The default value is -1 which means don't break the query and wait till the result
  107732. * @see http://doc.babylonjs.com/features/occlusionquery
  107733. */
  107734. occlusionRetryCount: number;
  107735. /**
  107736. * 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:
  107737. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  107738. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  107739. * * 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.
  107740. * @see http://doc.babylonjs.com/features/occlusionquery
  107741. */
  107742. occlusionType: number;
  107743. /**
  107744. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  107745. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  107746. * * 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.
  107747. * @see http://doc.babylonjs.com/features/occlusionquery
  107748. */
  107749. occlusionQueryAlgorithmType: number;
  107750. /**
  107751. * 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
  107752. * @see http://doc.babylonjs.com/features/occlusionquery
  107753. */
  107754. isOccluded: boolean;
  107755. /**
  107756. * Flag to check the progress status of the query
  107757. * @see http://doc.babylonjs.com/features/occlusionquery
  107758. */
  107759. isOcclusionQueryInProgress: boolean;
  107760. }
  107761. }
  107762. declare module BABYLON {
  107763. /** @hidden */
  107764. export var _forceTransformFeedbackToBundle: boolean;
  107765. interface Engine {
  107766. /**
  107767. * Creates a webGL transform feedback object
  107768. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  107769. * @returns the webGL transform feedback object
  107770. */
  107771. createTransformFeedback(): WebGLTransformFeedback;
  107772. /**
  107773. * Delete a webGL transform feedback object
  107774. * @param value defines the webGL transform feedback object to delete
  107775. */
  107776. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  107777. /**
  107778. * Bind a webGL transform feedback object to the webgl context
  107779. * @param value defines the webGL transform feedback object to bind
  107780. */
  107781. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  107782. /**
  107783. * Begins a transform feedback operation
  107784. * @param usePoints defines if points or triangles must be used
  107785. */
  107786. beginTransformFeedback(usePoints: boolean): void;
  107787. /**
  107788. * Ends a transform feedback operation
  107789. */
  107790. endTransformFeedback(): void;
  107791. /**
  107792. * Specify the varyings to use with transform feedback
  107793. * @param program defines the associated webGL program
  107794. * @param value defines the list of strings representing the varying names
  107795. */
  107796. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  107797. /**
  107798. * Bind a webGL buffer for a transform feedback operation
  107799. * @param value defines the webGL buffer to bind
  107800. */
  107801. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  107802. }
  107803. }
  107804. declare module BABYLON {
  107805. /**
  107806. * Creation options of the multi render target texture.
  107807. */
  107808. export interface IMultiRenderTargetOptions {
  107809. /**
  107810. * Define if the texture needs to create mip maps after render.
  107811. */
  107812. generateMipMaps?: boolean;
  107813. /**
  107814. * Define the types of all the draw buffers we want to create
  107815. */
  107816. types?: number[];
  107817. /**
  107818. * Define the sampling modes of all the draw buffers we want to create
  107819. */
  107820. samplingModes?: number[];
  107821. /**
  107822. * Define if a depth buffer is required
  107823. */
  107824. generateDepthBuffer?: boolean;
  107825. /**
  107826. * Define if a stencil buffer is required
  107827. */
  107828. generateStencilBuffer?: boolean;
  107829. /**
  107830. * Define if a depth texture is required instead of a depth buffer
  107831. */
  107832. generateDepthTexture?: boolean;
  107833. /**
  107834. * Define the number of desired draw buffers
  107835. */
  107836. textureCount?: number;
  107837. /**
  107838. * Define if aspect ratio should be adapted to the texture or stay the scene one
  107839. */
  107840. doNotChangeAspectRatio?: boolean;
  107841. /**
  107842. * Define the default type of the buffers we are creating
  107843. */
  107844. defaultType?: number;
  107845. }
  107846. /**
  107847. * A multi render target, like a render target provides the ability to render to a texture.
  107848. * Unlike the render target, it can render to several draw buffers in one draw.
  107849. * This is specially interesting in deferred rendering or for any effects requiring more than
  107850. * just one color from a single pass.
  107851. */
  107852. export class MultiRenderTarget extends RenderTargetTexture {
  107853. private _internalTextures;
  107854. private _textures;
  107855. private _multiRenderTargetOptions;
  107856. /**
  107857. * Get if draw buffers are currently supported by the used hardware and browser.
  107858. */
  107859. readonly isSupported: boolean;
  107860. /**
  107861. * Get the list of textures generated by the multi render target.
  107862. */
  107863. readonly textures: Texture[];
  107864. /**
  107865. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  107866. */
  107867. readonly depthTexture: Texture;
  107868. /**
  107869. * Set the wrapping mode on U of all the textures we are rendering to.
  107870. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  107871. */
  107872. wrapU: number;
  107873. /**
  107874. * Set the wrapping mode on V of all the textures we are rendering to.
  107875. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  107876. */
  107877. wrapV: number;
  107878. /**
  107879. * Instantiate a new multi render target texture.
  107880. * A multi render target, like a render target provides the ability to render to a texture.
  107881. * Unlike the render target, it can render to several draw buffers in one draw.
  107882. * This is specially interesting in deferred rendering or for any effects requiring more than
  107883. * just one color from a single pass.
  107884. * @param name Define the name of the texture
  107885. * @param size Define the size of the buffers to render to
  107886. * @param count Define the number of target we are rendering into
  107887. * @param scene Define the scene the texture belongs to
  107888. * @param options Define the options used to create the multi render target
  107889. */
  107890. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  107891. /** @hidden */
  107892. _rebuild(): void;
  107893. private _createInternalTextures;
  107894. private _createTextures;
  107895. /**
  107896. * Define the number of samples used if MSAA is enabled.
  107897. */
  107898. samples: number;
  107899. /**
  107900. * Resize all the textures in the multi render target.
  107901. * Be carrefull as it will recreate all the data in the new texture.
  107902. * @param size Define the new size
  107903. */
  107904. resize(size: any): void;
  107905. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  107906. /**
  107907. * Dispose the render targets and their associated resources
  107908. */
  107909. dispose(): void;
  107910. /**
  107911. * Release all the underlying texture used as draw buffers.
  107912. */
  107913. releaseInternalTextures(): void;
  107914. }
  107915. }
  107916. declare module BABYLON {
  107917. interface Engine {
  107918. /**
  107919. * Unbind a list of render target textures from the webGL context
  107920. * This is used only when drawBuffer extension or webGL2 are active
  107921. * @param textures defines the render target textures to unbind
  107922. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  107923. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  107924. */
  107925. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  107926. /**
  107927. * Create a multi render target texture
  107928. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  107929. * @param size defines the size of the texture
  107930. * @param options defines the creation options
  107931. * @returns the cube texture as an InternalTexture
  107932. */
  107933. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  107934. /**
  107935. * Update the sample count for a given multiple render target texture
  107936. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  107937. * @param textures defines the textures to update
  107938. * @param samples defines the sample count to set
  107939. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  107940. */
  107941. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  107942. }
  107943. }
  107944. declare module BABYLON {
  107945. /**
  107946. * Gather the list of clipboard event types as constants.
  107947. */
  107948. export class ClipboardEventTypes {
  107949. /**
  107950. * The clipboard event is fired when a copy command is active (pressed).
  107951. */
  107952. static readonly COPY: number;
  107953. /**
  107954. * The clipboard event is fired when a cut command is active (pressed).
  107955. */
  107956. static readonly CUT: number;
  107957. /**
  107958. * The clipboard event is fired when a paste command is active (pressed).
  107959. */
  107960. static readonly PASTE: number;
  107961. }
  107962. /**
  107963. * This class is used to store clipboard related info for the onClipboardObservable event.
  107964. */
  107965. export class ClipboardInfo {
  107966. /**
  107967. * Defines the type of event (BABYLON.ClipboardEventTypes)
  107968. */
  107969. type: number;
  107970. /**
  107971. * Defines the related dom event
  107972. */
  107973. event: ClipboardEvent;
  107974. /**
  107975. *Creates an instance of ClipboardInfo.
  107976. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  107977. * @param event Defines the related dom event
  107978. */
  107979. constructor(
  107980. /**
  107981. * Defines the type of event (BABYLON.ClipboardEventTypes)
  107982. */
  107983. type: number,
  107984. /**
  107985. * Defines the related dom event
  107986. */
  107987. event: ClipboardEvent);
  107988. /**
  107989. * Get the clipboard event's type from the keycode.
  107990. * @param keyCode Defines the keyCode for the current keyboard event.
  107991. * @return {number}
  107992. */
  107993. static GetTypeFromCharacter(keyCode: number): number;
  107994. }
  107995. }
  107996. declare module BABYLON {
  107997. /**
  107998. * Google Daydream controller
  107999. */
  108000. export class DaydreamController extends WebVRController {
  108001. /**
  108002. * Base Url for the controller model.
  108003. */
  108004. static MODEL_BASE_URL: string;
  108005. /**
  108006. * File name for the controller model.
  108007. */
  108008. static MODEL_FILENAME: string;
  108009. /**
  108010. * Gamepad Id prefix used to identify Daydream Controller.
  108011. */
  108012. static readonly GAMEPAD_ID_PREFIX: string;
  108013. /**
  108014. * Creates a new DaydreamController from a gamepad
  108015. * @param vrGamepad the gamepad that the controller should be created from
  108016. */
  108017. constructor(vrGamepad: any);
  108018. /**
  108019. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  108020. * @param scene scene in which to add meshes
  108021. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  108022. */
  108023. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  108024. /**
  108025. * Called once for each button that changed state since the last frame
  108026. * @param buttonIdx Which button index changed
  108027. * @param state New state of the button
  108028. * @param changes Which properties on the state changed since last frame
  108029. */
  108030. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  108031. }
  108032. }
  108033. declare module BABYLON {
  108034. /**
  108035. * Gear VR Controller
  108036. */
  108037. export class GearVRController extends WebVRController {
  108038. /**
  108039. * Base Url for the controller model.
  108040. */
  108041. static MODEL_BASE_URL: string;
  108042. /**
  108043. * File name for the controller model.
  108044. */
  108045. static MODEL_FILENAME: string;
  108046. /**
  108047. * Gamepad Id prefix used to identify this controller.
  108048. */
  108049. static readonly GAMEPAD_ID_PREFIX: string;
  108050. private readonly _buttonIndexToObservableNameMap;
  108051. /**
  108052. * Creates a new GearVRController from a gamepad
  108053. * @param vrGamepad the gamepad that the controller should be created from
  108054. */
  108055. constructor(vrGamepad: any);
  108056. /**
  108057. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  108058. * @param scene scene in which to add meshes
  108059. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  108060. */
  108061. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  108062. /**
  108063. * Called once for each button that changed state since the last frame
  108064. * @param buttonIdx Which button index changed
  108065. * @param state New state of the button
  108066. * @param changes Which properties on the state changed since last frame
  108067. */
  108068. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  108069. }
  108070. }
  108071. declare module BABYLON {
  108072. /**
  108073. * Class containing static functions to help procedurally build meshes
  108074. */
  108075. export class PolyhedronBuilder {
  108076. /**
  108077. * Creates a polyhedron mesh
  108078. * * 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
  108079. * * The parameter `size` (positive float, default 1) sets the polygon size
  108080. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108081. * * 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`
  108082. * * 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
  108083. * * 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)`)
  108084. * * 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
  108085. * * 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
  108086. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108087. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108088. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108089. * @param name defines the name of the mesh
  108090. * @param options defines the options used to create the mesh
  108091. * @param scene defines the hosting scene
  108092. * @returns the polyhedron mesh
  108093. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  108094. */
  108095. static CreatePolyhedron(name: string, options: {
  108096. type?: number;
  108097. size?: number;
  108098. sizeX?: number;
  108099. sizeY?: number;
  108100. sizeZ?: number;
  108101. custom?: any;
  108102. faceUV?: Vector4[];
  108103. faceColors?: Color4[];
  108104. flat?: boolean;
  108105. updatable?: boolean;
  108106. sideOrientation?: number;
  108107. frontUVs?: Vector4;
  108108. backUVs?: Vector4;
  108109. }, scene?: Nullable<Scene>): Mesh;
  108110. }
  108111. }
  108112. declare module BABYLON {
  108113. /**
  108114. * Gizmo that enables scaling a mesh along 3 axis
  108115. */
  108116. export class ScaleGizmo extends Gizmo {
  108117. /**
  108118. * Internal gizmo used for interactions on the x axis
  108119. */
  108120. xGizmo: AxisScaleGizmo;
  108121. /**
  108122. * Internal gizmo used for interactions on the y axis
  108123. */
  108124. yGizmo: AxisScaleGizmo;
  108125. /**
  108126. * Internal gizmo used for interactions on the z axis
  108127. */
  108128. zGizmo: AxisScaleGizmo;
  108129. /**
  108130. * Internal gizmo used to scale all axis equally
  108131. */
  108132. uniformScaleGizmo: AxisScaleGizmo;
  108133. private _meshAttached;
  108134. private _updateGizmoRotationToMatchAttachedMesh;
  108135. private _snapDistance;
  108136. private _scaleRatio;
  108137. private _uniformScalingMesh;
  108138. private _octahedron;
  108139. /** Fires an event when any of it's sub gizmos are dragged */
  108140. onDragStartObservable: Observable<unknown>;
  108141. /** Fires an event when any of it's sub gizmos are released from dragging */
  108142. onDragEndObservable: Observable<unknown>;
  108143. attachedMesh: Nullable<AbstractMesh>;
  108144. /**
  108145. * Creates a ScaleGizmo
  108146. * @param gizmoLayer The utility layer the gizmo will be added to
  108147. */
  108148. constructor(gizmoLayer?: UtilityLayerRenderer);
  108149. updateGizmoRotationToMatchAttachedMesh: boolean;
  108150. /**
  108151. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  108152. */
  108153. snapDistance: number;
  108154. /**
  108155. * Ratio for the scale of the gizmo (Default: 1)
  108156. */
  108157. scaleRatio: number;
  108158. /**
  108159. * Disposes of the gizmo
  108160. */
  108161. dispose(): void;
  108162. }
  108163. }
  108164. declare module BABYLON {
  108165. /**
  108166. * Single axis scale gizmo
  108167. */
  108168. export class AxisScaleGizmo extends Gizmo {
  108169. /**
  108170. * Drag behavior responsible for the gizmos dragging interactions
  108171. */
  108172. dragBehavior: PointerDragBehavior;
  108173. private _pointerObserver;
  108174. /**
  108175. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  108176. */
  108177. snapDistance: number;
  108178. /**
  108179. * Event that fires each time the gizmo snaps to a new location.
  108180. * * snapDistance is the the change in distance
  108181. */
  108182. onSnapObservable: Observable<{
  108183. snapDistance: number;
  108184. }>;
  108185. /**
  108186. * If the scaling operation should be done on all axis (default: false)
  108187. */
  108188. uniformScaling: boolean;
  108189. private _isEnabled;
  108190. private _parent;
  108191. private _arrow;
  108192. private _coloredMaterial;
  108193. private _hoverMaterial;
  108194. /**
  108195. * Creates an AxisScaleGizmo
  108196. * @param gizmoLayer The utility layer the gizmo will be added to
  108197. * @param dragAxis The axis which the gizmo will be able to scale on
  108198. * @param color The color of the gizmo
  108199. */
  108200. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  108201. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  108202. /**
  108203. * If the gizmo is enabled
  108204. */
  108205. isEnabled: boolean;
  108206. /**
  108207. * Disposes of the gizmo
  108208. */
  108209. dispose(): void;
  108210. /**
  108211. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  108212. * @param mesh The mesh to replace the default mesh of the gizmo
  108213. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  108214. */
  108215. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  108216. }
  108217. }
  108218. declare module BABYLON {
  108219. /**
  108220. * Bounding box gizmo
  108221. */
  108222. export class BoundingBoxGizmo extends Gizmo {
  108223. private _lineBoundingBox;
  108224. private _rotateSpheresParent;
  108225. private _scaleBoxesParent;
  108226. private _boundingDimensions;
  108227. private _renderObserver;
  108228. private _pointerObserver;
  108229. private _scaleDragSpeed;
  108230. private _tmpQuaternion;
  108231. private _tmpVector;
  108232. private _tmpRotationMatrix;
  108233. /**
  108234. * 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)
  108235. */
  108236. ignoreChildren: boolean;
  108237. /**
  108238. * 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)
  108239. */
  108240. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  108241. /**
  108242. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  108243. */
  108244. rotationSphereSize: number;
  108245. /**
  108246. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  108247. */
  108248. scaleBoxSize: number;
  108249. /**
  108250. * 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)
  108251. */
  108252. fixedDragMeshScreenSize: boolean;
  108253. /**
  108254. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  108255. */
  108256. fixedDragMeshScreenSizeDistanceFactor: number;
  108257. /**
  108258. * Fired when a rotation sphere or scale box is dragged
  108259. */
  108260. onDragStartObservable: Observable<{}>;
  108261. /**
  108262. * Fired when a scale box is dragged
  108263. */
  108264. onScaleBoxDragObservable: Observable<{}>;
  108265. /**
  108266. * Fired when a scale box drag is ended
  108267. */
  108268. onScaleBoxDragEndObservable: Observable<{}>;
  108269. /**
  108270. * Fired when a rotation sphere is dragged
  108271. */
  108272. onRotationSphereDragObservable: Observable<{}>;
  108273. /**
  108274. * Fired when a rotation sphere drag is ended
  108275. */
  108276. onRotationSphereDragEndObservable: Observable<{}>;
  108277. /**
  108278. * 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)
  108279. */
  108280. scalePivot: Nullable<Vector3>;
  108281. /**
  108282. * Mesh used as a pivot to rotate the attached mesh
  108283. */
  108284. private _anchorMesh;
  108285. private _existingMeshScale;
  108286. private _dragMesh;
  108287. private pointerDragBehavior;
  108288. private coloredMaterial;
  108289. private hoverColoredMaterial;
  108290. /**
  108291. * Sets the color of the bounding box gizmo
  108292. * @param color the color to set
  108293. */
  108294. setColor(color: Color3): void;
  108295. /**
  108296. * Creates an BoundingBoxGizmo
  108297. * @param gizmoLayer The utility layer the gizmo will be added to
  108298. * @param color The color of the gizmo
  108299. */
  108300. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  108301. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  108302. private _selectNode;
  108303. /**
  108304. * Updates the bounding box information for the Gizmo
  108305. */
  108306. updateBoundingBox(): void;
  108307. private _updateRotationSpheres;
  108308. private _updateScaleBoxes;
  108309. /**
  108310. * Enables rotation on the specified axis and disables rotation on the others
  108311. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  108312. */
  108313. setEnabledRotationAxis(axis: string): void;
  108314. /**
  108315. * Enables/disables scaling
  108316. * @param enable if scaling should be enabled
  108317. */
  108318. setEnabledScaling(enable: boolean): void;
  108319. private _updateDummy;
  108320. /**
  108321. * Enables a pointer drag behavior on the bounding box of the gizmo
  108322. */
  108323. enableDragBehavior(): void;
  108324. /**
  108325. * Disposes of the gizmo
  108326. */
  108327. dispose(): void;
  108328. /**
  108329. * 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)
  108330. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  108331. * @returns the bounding box mesh with the passed in mesh as a child
  108332. */
  108333. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  108334. /**
  108335. * CustomMeshes are not supported by this gizmo
  108336. * @param mesh The mesh to replace the default mesh of the gizmo
  108337. */
  108338. setCustomMesh(mesh: Mesh): void;
  108339. }
  108340. }
  108341. declare module BABYLON {
  108342. /**
  108343. * Single plane rotation gizmo
  108344. */
  108345. export class PlaneRotationGizmo extends Gizmo {
  108346. /**
  108347. * Drag behavior responsible for the gizmos dragging interactions
  108348. */
  108349. dragBehavior: PointerDragBehavior;
  108350. private _pointerObserver;
  108351. /**
  108352. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  108353. */
  108354. snapDistance: number;
  108355. /**
  108356. * Event that fires each time the gizmo snaps to a new location.
  108357. * * snapDistance is the the change in distance
  108358. */
  108359. onSnapObservable: Observable<{
  108360. snapDistance: number;
  108361. }>;
  108362. private _isEnabled;
  108363. private _parent;
  108364. /**
  108365. * Creates a PlaneRotationGizmo
  108366. * @param gizmoLayer The utility layer the gizmo will be added to
  108367. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  108368. * @param color The color of the gizmo
  108369. * @param tessellation Amount of tessellation to be used when creating rotation circles
  108370. * @param useEulerRotation Use and update Euler angle instead of quaternion
  108371. */
  108372. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  108373. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  108374. /**
  108375. * If the gizmo is enabled
  108376. */
  108377. isEnabled: boolean;
  108378. /**
  108379. * Disposes of the gizmo
  108380. */
  108381. dispose(): void;
  108382. }
  108383. }
  108384. declare module BABYLON {
  108385. /**
  108386. * Gizmo that enables rotating a mesh along 3 axis
  108387. */
  108388. export class RotationGizmo extends Gizmo {
  108389. /**
  108390. * Internal gizmo used for interactions on the x axis
  108391. */
  108392. xGizmo: PlaneRotationGizmo;
  108393. /**
  108394. * Internal gizmo used for interactions on the y axis
  108395. */
  108396. yGizmo: PlaneRotationGizmo;
  108397. /**
  108398. * Internal gizmo used for interactions on the z axis
  108399. */
  108400. zGizmo: PlaneRotationGizmo;
  108401. /** Fires an event when any of it's sub gizmos are dragged */
  108402. onDragStartObservable: Observable<unknown>;
  108403. /** Fires an event when any of it's sub gizmos are released from dragging */
  108404. onDragEndObservable: Observable<unknown>;
  108405. private _meshAttached;
  108406. attachedMesh: Nullable<AbstractMesh>;
  108407. /**
  108408. * Creates a RotationGizmo
  108409. * @param gizmoLayer The utility layer the gizmo will be added to
  108410. * @param tessellation Amount of tessellation to be used when creating rotation circles
  108411. * @param useEulerRotation Use and update Euler angle instead of quaternion
  108412. */
  108413. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  108414. updateGizmoRotationToMatchAttachedMesh: boolean;
  108415. /**
  108416. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  108417. */
  108418. snapDistance: number;
  108419. /**
  108420. * Ratio for the scale of the gizmo (Default: 1)
  108421. */
  108422. scaleRatio: number;
  108423. /**
  108424. * Disposes of the gizmo
  108425. */
  108426. dispose(): void;
  108427. /**
  108428. * CustomMeshes are not supported by this gizmo
  108429. * @param mesh The mesh to replace the default mesh of the gizmo
  108430. */
  108431. setCustomMesh(mesh: Mesh): void;
  108432. }
  108433. }
  108434. declare module BABYLON {
  108435. /**
  108436. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  108437. */
  108438. export class GizmoManager implements IDisposable {
  108439. private scene;
  108440. /**
  108441. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  108442. */
  108443. gizmos: {
  108444. positionGizmo: Nullable<PositionGizmo>;
  108445. rotationGizmo: Nullable<RotationGizmo>;
  108446. scaleGizmo: Nullable<ScaleGizmo>;
  108447. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  108448. };
  108449. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  108450. clearGizmoOnEmptyPointerEvent: boolean;
  108451. /** Fires an event when the manager is attached to a mesh */
  108452. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  108453. private _gizmosEnabled;
  108454. private _pointerObserver;
  108455. private _attachedMesh;
  108456. private _boundingBoxColor;
  108457. private _defaultUtilityLayer;
  108458. private _defaultKeepDepthUtilityLayer;
  108459. /**
  108460. * When bounding box gizmo is enabled, this can be used to track drag/end events
  108461. */
  108462. boundingBoxDragBehavior: SixDofDragBehavior;
  108463. /**
  108464. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  108465. */
  108466. attachableMeshes: Nullable<Array<AbstractMesh>>;
  108467. /**
  108468. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  108469. */
  108470. usePointerToAttachGizmos: boolean;
  108471. /**
  108472. * Utility layer that the bounding box gizmo belongs to
  108473. */
  108474. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  108475. /**
  108476. * Utility layer that all gizmos besides bounding box belong to
  108477. */
  108478. readonly utilityLayer: UtilityLayerRenderer;
  108479. /**
  108480. * Instatiates a gizmo manager
  108481. * @param scene the scene to overlay the gizmos on top of
  108482. */
  108483. constructor(scene: Scene);
  108484. /**
  108485. * Attaches a set of gizmos to the specified mesh
  108486. * @param mesh The mesh the gizmo's should be attached to
  108487. */
  108488. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  108489. /**
  108490. * If the position gizmo is enabled
  108491. */
  108492. positionGizmoEnabled: boolean;
  108493. /**
  108494. * If the rotation gizmo is enabled
  108495. */
  108496. rotationGizmoEnabled: boolean;
  108497. /**
  108498. * If the scale gizmo is enabled
  108499. */
  108500. scaleGizmoEnabled: boolean;
  108501. /**
  108502. * If the boundingBox gizmo is enabled
  108503. */
  108504. boundingBoxGizmoEnabled: boolean;
  108505. /**
  108506. * Disposes of the gizmo manager
  108507. */
  108508. dispose(): void;
  108509. }
  108510. }
  108511. declare module BABYLON {
  108512. /**
  108513. * A directional light is defined by a direction (what a surprise!).
  108514. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  108515. * 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.
  108516. * Documentation: https://doc.babylonjs.com/babylon101/lights
  108517. */
  108518. export class DirectionalLight extends ShadowLight {
  108519. private _shadowFrustumSize;
  108520. /**
  108521. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  108522. */
  108523. /**
  108524. * Specifies a fix frustum size for the shadow generation.
  108525. */
  108526. shadowFrustumSize: number;
  108527. private _shadowOrthoScale;
  108528. /**
  108529. * Gets the shadow projection scale against the optimal computed one.
  108530. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  108531. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  108532. */
  108533. /**
  108534. * Sets the shadow projection scale against the optimal computed one.
  108535. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  108536. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  108537. */
  108538. shadowOrthoScale: number;
  108539. /**
  108540. * Automatically compute the projection matrix to best fit (including all the casters)
  108541. * on each frame.
  108542. */
  108543. autoUpdateExtends: boolean;
  108544. private _orthoLeft;
  108545. private _orthoRight;
  108546. private _orthoTop;
  108547. private _orthoBottom;
  108548. /**
  108549. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  108550. * The directional light is emitted from everywhere in the given direction.
  108551. * It can cast shadows.
  108552. * Documentation : https://doc.babylonjs.com/babylon101/lights
  108553. * @param name The friendly name of the light
  108554. * @param direction The direction of the light
  108555. * @param scene The scene the light belongs to
  108556. */
  108557. constructor(name: string, direction: Vector3, scene: Scene);
  108558. /**
  108559. * Returns the string "DirectionalLight".
  108560. * @return The class name
  108561. */
  108562. getClassName(): string;
  108563. /**
  108564. * Returns the integer 1.
  108565. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  108566. */
  108567. getTypeID(): number;
  108568. /**
  108569. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  108570. * Returns the DirectionalLight Shadow projection matrix.
  108571. */
  108572. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  108573. /**
  108574. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  108575. * Returns the DirectionalLight Shadow projection matrix.
  108576. */
  108577. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  108578. /**
  108579. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  108580. * Returns the DirectionalLight Shadow projection matrix.
  108581. */
  108582. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  108583. protected _buildUniformLayout(): void;
  108584. /**
  108585. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  108586. * @param effect The effect to update
  108587. * @param lightIndex The index of the light in the effect to update
  108588. * @returns The directional light
  108589. */
  108590. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  108591. /**
  108592. * Gets the minZ used for shadow according to both the scene and the light.
  108593. *
  108594. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  108595. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  108596. * @param activeCamera The camera we are returning the min for
  108597. * @returns the depth min z
  108598. */
  108599. getDepthMinZ(activeCamera: Camera): number;
  108600. /**
  108601. * Gets the maxZ used for shadow according to both the scene and the light.
  108602. *
  108603. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  108604. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  108605. * @param activeCamera The camera we are returning the max for
  108606. * @returns the depth max z
  108607. */
  108608. getDepthMaxZ(activeCamera: Camera): number;
  108609. /**
  108610. * Prepares the list of defines specific to the light type.
  108611. * @param defines the list of defines
  108612. * @param lightIndex defines the index of the light for the effect
  108613. */
  108614. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  108615. }
  108616. }
  108617. declare module BABYLON {
  108618. /**
  108619. * Class containing static functions to help procedurally build meshes
  108620. */
  108621. export class HemisphereBuilder {
  108622. /**
  108623. * Creates a hemisphere mesh
  108624. * @param name defines the name of the mesh
  108625. * @param options defines the options used to create the mesh
  108626. * @param scene defines the hosting scene
  108627. * @returns the hemisphere mesh
  108628. */
  108629. static CreateHemisphere(name: string, options: {
  108630. segments?: number;
  108631. diameter?: number;
  108632. sideOrientation?: number;
  108633. }, scene: any): Mesh;
  108634. }
  108635. }
  108636. declare module BABYLON {
  108637. /**
  108638. * A spot light is defined by a position, a direction, an angle, and an exponent.
  108639. * These values define a cone of light starting from the position, emitting toward the direction.
  108640. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  108641. * and the exponent defines the speed of the decay of the light with distance (reach).
  108642. * Documentation: https://doc.babylonjs.com/babylon101/lights
  108643. */
  108644. export class SpotLight extends ShadowLight {
  108645. private _angle;
  108646. private _innerAngle;
  108647. private _cosHalfAngle;
  108648. private _lightAngleScale;
  108649. private _lightAngleOffset;
  108650. /**
  108651. * Gets the cone angle of the spot light in Radians.
  108652. */
  108653. /**
  108654. * Sets the cone angle of the spot light in Radians.
  108655. */
  108656. angle: number;
  108657. /**
  108658. * Only used in gltf falloff mode, this defines the angle where
  108659. * the directional falloff will start before cutting at angle which could be seen
  108660. * as outer angle.
  108661. */
  108662. /**
  108663. * Only used in gltf falloff mode, this defines the angle where
  108664. * the directional falloff will start before cutting at angle which could be seen
  108665. * as outer angle.
  108666. */
  108667. innerAngle: number;
  108668. private _shadowAngleScale;
  108669. /**
  108670. * Allows scaling the angle of the light for shadow generation only.
  108671. */
  108672. /**
  108673. * Allows scaling the angle of the light for shadow generation only.
  108674. */
  108675. shadowAngleScale: number;
  108676. /**
  108677. * The light decay speed with the distance from the emission spot.
  108678. */
  108679. exponent: number;
  108680. private _projectionTextureMatrix;
  108681. /**
  108682. * Allows reading the projecton texture
  108683. */
  108684. readonly projectionTextureMatrix: Matrix;
  108685. protected _projectionTextureLightNear: number;
  108686. /**
  108687. * Gets the near clip of the Spotlight for texture projection.
  108688. */
  108689. /**
  108690. * Sets the near clip of the Spotlight for texture projection.
  108691. */
  108692. projectionTextureLightNear: number;
  108693. protected _projectionTextureLightFar: number;
  108694. /**
  108695. * Gets the far clip of the Spotlight for texture projection.
  108696. */
  108697. /**
  108698. * Sets the far clip of the Spotlight for texture projection.
  108699. */
  108700. projectionTextureLightFar: number;
  108701. protected _projectionTextureUpDirection: Vector3;
  108702. /**
  108703. * Gets the Up vector of the Spotlight for texture projection.
  108704. */
  108705. /**
  108706. * Sets the Up vector of the Spotlight for texture projection.
  108707. */
  108708. projectionTextureUpDirection: Vector3;
  108709. private _projectionTexture;
  108710. /**
  108711. * Gets the projection texture of the light.
  108712. */
  108713. /**
  108714. * Sets the projection texture of the light.
  108715. */
  108716. projectionTexture: Nullable<BaseTexture>;
  108717. private _projectionTextureViewLightDirty;
  108718. private _projectionTextureProjectionLightDirty;
  108719. private _projectionTextureDirty;
  108720. private _projectionTextureViewTargetVector;
  108721. private _projectionTextureViewLightMatrix;
  108722. private _projectionTextureProjectionLightMatrix;
  108723. private _projectionTextureScalingMatrix;
  108724. /**
  108725. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  108726. * It can cast shadows.
  108727. * Documentation : https://doc.babylonjs.com/babylon101/lights
  108728. * @param name The light friendly name
  108729. * @param position The position of the spot light in the scene
  108730. * @param direction The direction of the light in the scene
  108731. * @param angle The cone angle of the light in Radians
  108732. * @param exponent The light decay speed with the distance from the emission spot
  108733. * @param scene The scene the lights belongs to
  108734. */
  108735. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  108736. /**
  108737. * Returns the string "SpotLight".
  108738. * @returns the class name
  108739. */
  108740. getClassName(): string;
  108741. /**
  108742. * Returns the integer 2.
  108743. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  108744. */
  108745. getTypeID(): number;
  108746. /**
  108747. * Overrides the direction setter to recompute the projection texture view light Matrix.
  108748. */
  108749. protected _setDirection(value: Vector3): void;
  108750. /**
  108751. * Overrides the position setter to recompute the projection texture view light Matrix.
  108752. */
  108753. protected _setPosition(value: Vector3): void;
  108754. /**
  108755. * 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.
  108756. * Returns the SpotLight.
  108757. */
  108758. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  108759. protected _computeProjectionTextureViewLightMatrix(): void;
  108760. protected _computeProjectionTextureProjectionLightMatrix(): void;
  108761. /**
  108762. * Main function for light texture projection matrix computing.
  108763. */
  108764. protected _computeProjectionTextureMatrix(): void;
  108765. protected _buildUniformLayout(): void;
  108766. private _computeAngleValues;
  108767. /**
  108768. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  108769. * @param effect The effect to update
  108770. * @param lightIndex The index of the light in the effect to update
  108771. * @returns The spot light
  108772. */
  108773. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  108774. /**
  108775. * Disposes the light and the associated resources.
  108776. */
  108777. dispose(): void;
  108778. /**
  108779. * Prepares the list of defines specific to the light type.
  108780. * @param defines the list of defines
  108781. * @param lightIndex defines the index of the light for the effect
  108782. */
  108783. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  108784. }
  108785. }
  108786. declare module BABYLON {
  108787. /**
  108788. * Gizmo that enables viewing a light
  108789. */
  108790. export class LightGizmo extends Gizmo {
  108791. private _lightMesh;
  108792. private _material;
  108793. private cachedPosition;
  108794. private cachedForward;
  108795. /**
  108796. * Creates a LightGizmo
  108797. * @param gizmoLayer The utility layer the gizmo will be added to
  108798. */
  108799. constructor(gizmoLayer?: UtilityLayerRenderer);
  108800. private _light;
  108801. /**
  108802. * The light that the gizmo is attached to
  108803. */
  108804. light: Nullable<Light>;
  108805. /**
  108806. * @hidden
  108807. * Updates the gizmo to match the attached mesh's position/rotation
  108808. */
  108809. protected _update(): void;
  108810. private static _Scale;
  108811. /**
  108812. * Creates the lines for a light mesh
  108813. */
  108814. private static _createLightLines;
  108815. /**
  108816. * Disposes of the light gizmo
  108817. */
  108818. dispose(): void;
  108819. private static _CreateHemisphericLightMesh;
  108820. private static _CreatePointLightMesh;
  108821. private static _CreateSpotLightMesh;
  108822. private static _CreateDirectionalLightMesh;
  108823. }
  108824. }
  108825. declare module BABYLON {
  108826. /** @hidden */
  108827. export var backgroundFragmentDeclaration: {
  108828. name: string;
  108829. shader: string;
  108830. };
  108831. }
  108832. declare module BABYLON {
  108833. /** @hidden */
  108834. export var backgroundUboDeclaration: {
  108835. name: string;
  108836. shader: string;
  108837. };
  108838. }
  108839. declare module BABYLON {
  108840. /** @hidden */
  108841. export var backgroundPixelShader: {
  108842. name: string;
  108843. shader: string;
  108844. };
  108845. }
  108846. declare module BABYLON {
  108847. /** @hidden */
  108848. export var backgroundVertexDeclaration: {
  108849. name: string;
  108850. shader: string;
  108851. };
  108852. }
  108853. declare module BABYLON {
  108854. /** @hidden */
  108855. export var backgroundVertexShader: {
  108856. name: string;
  108857. shader: string;
  108858. };
  108859. }
  108860. declare module BABYLON {
  108861. /**
  108862. * Background material used to create an efficient environement around your scene.
  108863. */
  108864. export class BackgroundMaterial extends PushMaterial {
  108865. /**
  108866. * Standard reflectance value at parallel view angle.
  108867. */
  108868. static StandardReflectance0: number;
  108869. /**
  108870. * Standard reflectance value at grazing angle.
  108871. */
  108872. static StandardReflectance90: number;
  108873. protected _primaryColor: Color3;
  108874. /**
  108875. * Key light Color (multiply against the environement texture)
  108876. */
  108877. primaryColor: Color3;
  108878. protected __perceptualColor: Nullable<Color3>;
  108879. /**
  108880. * Experimental Internal Use Only.
  108881. *
  108882. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  108883. * This acts as a helper to set the primary color to a more "human friendly" value.
  108884. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  108885. * output color as close as possible from the chosen value.
  108886. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  108887. * part of lighting setup.)
  108888. */
  108889. _perceptualColor: Nullable<Color3>;
  108890. protected _primaryColorShadowLevel: float;
  108891. /**
  108892. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  108893. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  108894. */
  108895. primaryColorShadowLevel: float;
  108896. protected _primaryColorHighlightLevel: float;
  108897. /**
  108898. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  108899. * The primary color is used at the level chosen to define what the white area would look.
  108900. */
  108901. primaryColorHighlightLevel: float;
  108902. protected _reflectionTexture: Nullable<BaseTexture>;
  108903. /**
  108904. * Reflection Texture used in the material.
  108905. * Should be author in a specific way for the best result (refer to the documentation).
  108906. */
  108907. reflectionTexture: Nullable<BaseTexture>;
  108908. protected _reflectionBlur: float;
  108909. /**
  108910. * Reflection Texture level of blur.
  108911. *
  108912. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  108913. * texture twice.
  108914. */
  108915. reflectionBlur: float;
  108916. protected _diffuseTexture: Nullable<BaseTexture>;
  108917. /**
  108918. * Diffuse Texture used in the material.
  108919. * Should be author in a specific way for the best result (refer to the documentation).
  108920. */
  108921. diffuseTexture: Nullable<BaseTexture>;
  108922. protected _shadowLights: Nullable<IShadowLight[]>;
  108923. /**
  108924. * Specify the list of lights casting shadow on the material.
  108925. * All scene shadow lights will be included if null.
  108926. */
  108927. shadowLights: Nullable<IShadowLight[]>;
  108928. protected _shadowLevel: float;
  108929. /**
  108930. * Helps adjusting the shadow to a softer level if required.
  108931. * 0 means black shadows and 1 means no shadows.
  108932. */
  108933. shadowLevel: float;
  108934. protected _sceneCenter: Vector3;
  108935. /**
  108936. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  108937. * It is usually zero but might be interesting to modify according to your setup.
  108938. */
  108939. sceneCenter: Vector3;
  108940. protected _opacityFresnel: boolean;
  108941. /**
  108942. * This helps specifying that the material is falling off to the sky box at grazing angle.
  108943. * This helps ensuring a nice transition when the camera goes under the ground.
  108944. */
  108945. opacityFresnel: boolean;
  108946. protected _reflectionFresnel: boolean;
  108947. /**
  108948. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  108949. * This helps adding a mirror texture on the ground.
  108950. */
  108951. reflectionFresnel: boolean;
  108952. protected _reflectionFalloffDistance: number;
  108953. /**
  108954. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  108955. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  108956. */
  108957. reflectionFalloffDistance: number;
  108958. protected _reflectionAmount: number;
  108959. /**
  108960. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  108961. */
  108962. reflectionAmount: number;
  108963. protected _reflectionReflectance0: number;
  108964. /**
  108965. * This specifies the weight of the reflection at grazing angle.
  108966. */
  108967. reflectionReflectance0: number;
  108968. protected _reflectionReflectance90: number;
  108969. /**
  108970. * This specifies the weight of the reflection at a perpendicular point of view.
  108971. */
  108972. reflectionReflectance90: number;
  108973. /**
  108974. * Sets the reflection reflectance fresnel values according to the default standard
  108975. * empirically know to work well :-)
  108976. */
  108977. reflectionStandardFresnelWeight: number;
  108978. protected _useRGBColor: boolean;
  108979. /**
  108980. * Helps to directly use the maps channels instead of their level.
  108981. */
  108982. useRGBColor: boolean;
  108983. protected _enableNoise: boolean;
  108984. /**
  108985. * This helps reducing the banding effect that could occur on the background.
  108986. */
  108987. enableNoise: boolean;
  108988. /**
  108989. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  108990. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  108991. * Recommended to be keep at 1.0 except for special cases.
  108992. */
  108993. fovMultiplier: number;
  108994. private _fovMultiplier;
  108995. /**
  108996. * Enable the FOV adjustment feature controlled by fovMultiplier.
  108997. */
  108998. useEquirectangularFOV: boolean;
  108999. private _maxSimultaneousLights;
  109000. /**
  109001. * Number of Simultaneous lights allowed on the material.
  109002. */
  109003. maxSimultaneousLights: int;
  109004. /**
  109005. * Default configuration related to image processing available in the Background Material.
  109006. */
  109007. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109008. /**
  109009. * Keep track of the image processing observer to allow dispose and replace.
  109010. */
  109011. private _imageProcessingObserver;
  109012. /**
  109013. * Attaches a new image processing configuration to the PBR Material.
  109014. * @param configuration (if null the scene configuration will be use)
  109015. */
  109016. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  109017. /**
  109018. * Gets the image processing configuration used either in this material.
  109019. */
  109020. /**
  109021. * Sets the Default image processing configuration used either in the this material.
  109022. *
  109023. * If sets to null, the scene one is in use.
  109024. */
  109025. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  109026. /**
  109027. * Gets wether the color curves effect is enabled.
  109028. */
  109029. /**
  109030. * Sets wether the color curves effect is enabled.
  109031. */
  109032. cameraColorCurvesEnabled: boolean;
  109033. /**
  109034. * Gets wether the color grading effect is enabled.
  109035. */
  109036. /**
  109037. * Gets wether the color grading effect is enabled.
  109038. */
  109039. cameraColorGradingEnabled: boolean;
  109040. /**
  109041. * Gets wether tonemapping is enabled or not.
  109042. */
  109043. /**
  109044. * Sets wether tonemapping is enabled or not
  109045. */
  109046. cameraToneMappingEnabled: boolean;
  109047. /**
  109048. * The camera exposure used on this material.
  109049. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109050. * This corresponds to a photographic exposure.
  109051. */
  109052. /**
  109053. * The camera exposure used on this material.
  109054. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109055. * This corresponds to a photographic exposure.
  109056. */
  109057. cameraExposure: float;
  109058. /**
  109059. * Gets The camera contrast used on this material.
  109060. */
  109061. /**
  109062. * Sets The camera contrast used on this material.
  109063. */
  109064. cameraContrast: float;
  109065. /**
  109066. * Gets the Color Grading 2D Lookup Texture.
  109067. */
  109068. /**
  109069. * Sets the Color Grading 2D Lookup Texture.
  109070. */
  109071. cameraColorGradingTexture: Nullable<BaseTexture>;
  109072. /**
  109073. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109074. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109075. * 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;
  109076. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109077. */
  109078. /**
  109079. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109080. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109081. * 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;
  109082. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109083. */
  109084. cameraColorCurves: Nullable<ColorCurves>;
  109085. /**
  109086. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  109087. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  109088. */
  109089. switchToBGR: boolean;
  109090. private _renderTargets;
  109091. private _reflectionControls;
  109092. private _white;
  109093. private _primaryShadowColor;
  109094. private _primaryHighlightColor;
  109095. /**
  109096. * Instantiates a Background Material in the given scene
  109097. * @param name The friendly name of the material
  109098. * @param scene The scene to add the material to
  109099. */
  109100. constructor(name: string, scene: Scene);
  109101. /**
  109102. * Gets a boolean indicating that current material needs to register RTT
  109103. */
  109104. readonly hasRenderTargetTextures: boolean;
  109105. /**
  109106. * The entire material has been created in order to prevent overdraw.
  109107. * @returns false
  109108. */
  109109. needAlphaTesting(): boolean;
  109110. /**
  109111. * The entire material has been created in order to prevent overdraw.
  109112. * @returns true if blending is enable
  109113. */
  109114. needAlphaBlending(): boolean;
  109115. /**
  109116. * Checks wether the material is ready to be rendered for a given mesh.
  109117. * @param mesh The mesh to render
  109118. * @param subMesh The submesh to check against
  109119. * @param useInstances Specify wether or not the material is used with instances
  109120. * @returns true if all the dependencies are ready (Textures, Effects...)
  109121. */
  109122. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  109123. /**
  109124. * Compute the primary color according to the chosen perceptual color.
  109125. */
  109126. private _computePrimaryColorFromPerceptualColor;
  109127. /**
  109128. * Compute the highlights and shadow colors according to their chosen levels.
  109129. */
  109130. private _computePrimaryColors;
  109131. /**
  109132. * Build the uniform buffer used in the material.
  109133. */
  109134. buildUniformLayout(): void;
  109135. /**
  109136. * Unbind the material.
  109137. */
  109138. unbind(): void;
  109139. /**
  109140. * Bind only the world matrix to the material.
  109141. * @param world The world matrix to bind.
  109142. */
  109143. bindOnlyWorldMatrix(world: Matrix): void;
  109144. /**
  109145. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  109146. * @param world The world matrix to bind.
  109147. * @param subMesh The submesh to bind for.
  109148. */
  109149. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  109150. /**
  109151. * Dispose the material.
  109152. * @param forceDisposeEffect Force disposal of the associated effect.
  109153. * @param forceDisposeTextures Force disposal of the associated textures.
  109154. */
  109155. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  109156. /**
  109157. * Clones the material.
  109158. * @param name The cloned name.
  109159. * @returns The cloned material.
  109160. */
  109161. clone(name: string): BackgroundMaterial;
  109162. /**
  109163. * Serializes the current material to its JSON representation.
  109164. * @returns The JSON representation.
  109165. */
  109166. serialize(): any;
  109167. /**
  109168. * Gets the class name of the material
  109169. * @returns "BackgroundMaterial"
  109170. */
  109171. getClassName(): string;
  109172. /**
  109173. * Parse a JSON input to create back a background material.
  109174. * @param source The JSON data to parse
  109175. * @param scene The scene to create the parsed material in
  109176. * @param rootUrl The root url of the assets the material depends upon
  109177. * @returns the instantiated BackgroundMaterial.
  109178. */
  109179. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  109180. }
  109181. }
  109182. declare module BABYLON {
  109183. /**
  109184. * Represents the different options available during the creation of
  109185. * a Environment helper.
  109186. *
  109187. * This can control the default ground, skybox and image processing setup of your scene.
  109188. */
  109189. export interface IEnvironmentHelperOptions {
  109190. /**
  109191. * Specifies wether or not to create a ground.
  109192. * True by default.
  109193. */
  109194. createGround: boolean;
  109195. /**
  109196. * Specifies the ground size.
  109197. * 15 by default.
  109198. */
  109199. groundSize: number;
  109200. /**
  109201. * The texture used on the ground for the main color.
  109202. * Comes from the BabylonJS CDN by default.
  109203. *
  109204. * Remarks: Can be either a texture or a url.
  109205. */
  109206. groundTexture: string | BaseTexture;
  109207. /**
  109208. * The color mixed in the ground texture by default.
  109209. * BabylonJS clearColor by default.
  109210. */
  109211. groundColor: Color3;
  109212. /**
  109213. * Specifies the ground opacity.
  109214. * 1 by default.
  109215. */
  109216. groundOpacity: number;
  109217. /**
  109218. * Enables the ground to receive shadows.
  109219. * True by default.
  109220. */
  109221. enableGroundShadow: boolean;
  109222. /**
  109223. * Helps preventing the shadow to be fully black on the ground.
  109224. * 0.5 by default.
  109225. */
  109226. groundShadowLevel: number;
  109227. /**
  109228. * Creates a mirror texture attach to the ground.
  109229. * false by default.
  109230. */
  109231. enableGroundMirror: boolean;
  109232. /**
  109233. * Specifies the ground mirror size ratio.
  109234. * 0.3 by default as the default kernel is 64.
  109235. */
  109236. groundMirrorSizeRatio: number;
  109237. /**
  109238. * Specifies the ground mirror blur kernel size.
  109239. * 64 by default.
  109240. */
  109241. groundMirrorBlurKernel: number;
  109242. /**
  109243. * Specifies the ground mirror visibility amount.
  109244. * 1 by default
  109245. */
  109246. groundMirrorAmount: number;
  109247. /**
  109248. * Specifies the ground mirror reflectance weight.
  109249. * This uses the standard weight of the background material to setup the fresnel effect
  109250. * of the mirror.
  109251. * 1 by default.
  109252. */
  109253. groundMirrorFresnelWeight: number;
  109254. /**
  109255. * Specifies the ground mirror Falloff distance.
  109256. * This can helps reducing the size of the reflection.
  109257. * 0 by Default.
  109258. */
  109259. groundMirrorFallOffDistance: number;
  109260. /**
  109261. * Specifies the ground mirror texture type.
  109262. * Unsigned Int by Default.
  109263. */
  109264. groundMirrorTextureType: number;
  109265. /**
  109266. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  109267. * the shown objects.
  109268. */
  109269. groundYBias: number;
  109270. /**
  109271. * Specifies wether or not to create a skybox.
  109272. * True by default.
  109273. */
  109274. createSkybox: boolean;
  109275. /**
  109276. * Specifies the skybox size.
  109277. * 20 by default.
  109278. */
  109279. skyboxSize: number;
  109280. /**
  109281. * The texture used on the skybox for the main color.
  109282. * Comes from the BabylonJS CDN by default.
  109283. *
  109284. * Remarks: Can be either a texture or a url.
  109285. */
  109286. skyboxTexture: string | BaseTexture;
  109287. /**
  109288. * The color mixed in the skybox texture by default.
  109289. * BabylonJS clearColor by default.
  109290. */
  109291. skyboxColor: Color3;
  109292. /**
  109293. * The background rotation around the Y axis of the scene.
  109294. * This helps aligning the key lights of your scene with the background.
  109295. * 0 by default.
  109296. */
  109297. backgroundYRotation: number;
  109298. /**
  109299. * Compute automatically the size of the elements to best fit with the scene.
  109300. */
  109301. sizeAuto: boolean;
  109302. /**
  109303. * Default position of the rootMesh if autoSize is not true.
  109304. */
  109305. rootPosition: Vector3;
  109306. /**
  109307. * Sets up the image processing in the scene.
  109308. * true by default.
  109309. */
  109310. setupImageProcessing: boolean;
  109311. /**
  109312. * The texture used as your environment texture in the scene.
  109313. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  109314. *
  109315. * Remarks: Can be either a texture or a url.
  109316. */
  109317. environmentTexture: string | BaseTexture;
  109318. /**
  109319. * The value of the exposure to apply to the scene.
  109320. * 0.6 by default if setupImageProcessing is true.
  109321. */
  109322. cameraExposure: number;
  109323. /**
  109324. * The value of the contrast to apply to the scene.
  109325. * 1.6 by default if setupImageProcessing is true.
  109326. */
  109327. cameraContrast: number;
  109328. /**
  109329. * Specifies wether or not tonemapping should be enabled in the scene.
  109330. * true by default if setupImageProcessing is true.
  109331. */
  109332. toneMappingEnabled: boolean;
  109333. }
  109334. /**
  109335. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  109336. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  109337. * It also helps with the default setup of your imageProcessing configuration.
  109338. */
  109339. export class EnvironmentHelper {
  109340. /**
  109341. * Default ground texture URL.
  109342. */
  109343. private static _groundTextureCDNUrl;
  109344. /**
  109345. * Default skybox texture URL.
  109346. */
  109347. private static _skyboxTextureCDNUrl;
  109348. /**
  109349. * Default environment texture URL.
  109350. */
  109351. private static _environmentTextureCDNUrl;
  109352. /**
  109353. * Creates the default options for the helper.
  109354. */
  109355. private static _getDefaultOptions;
  109356. private _rootMesh;
  109357. /**
  109358. * Gets the root mesh created by the helper.
  109359. */
  109360. readonly rootMesh: Mesh;
  109361. private _skybox;
  109362. /**
  109363. * Gets the skybox created by the helper.
  109364. */
  109365. readonly skybox: Nullable<Mesh>;
  109366. private _skyboxTexture;
  109367. /**
  109368. * Gets the skybox texture created by the helper.
  109369. */
  109370. readonly skyboxTexture: Nullable<BaseTexture>;
  109371. private _skyboxMaterial;
  109372. /**
  109373. * Gets the skybox material created by the helper.
  109374. */
  109375. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  109376. private _ground;
  109377. /**
  109378. * Gets the ground mesh created by the helper.
  109379. */
  109380. readonly ground: Nullable<Mesh>;
  109381. private _groundTexture;
  109382. /**
  109383. * Gets the ground texture created by the helper.
  109384. */
  109385. readonly groundTexture: Nullable<BaseTexture>;
  109386. private _groundMirror;
  109387. /**
  109388. * Gets the ground mirror created by the helper.
  109389. */
  109390. readonly groundMirror: Nullable<MirrorTexture>;
  109391. /**
  109392. * Gets the ground mirror render list to helps pushing the meshes
  109393. * you wish in the ground reflection.
  109394. */
  109395. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  109396. private _groundMaterial;
  109397. /**
  109398. * Gets the ground material created by the helper.
  109399. */
  109400. readonly groundMaterial: Nullable<BackgroundMaterial>;
  109401. /**
  109402. * Stores the creation options.
  109403. */
  109404. private readonly _scene;
  109405. private _options;
  109406. /**
  109407. * This observable will be notified with any error during the creation of the environment,
  109408. * mainly texture creation errors.
  109409. */
  109410. onErrorObservable: Observable<{
  109411. message?: string;
  109412. exception?: any;
  109413. }>;
  109414. /**
  109415. * constructor
  109416. * @param options Defines the options we want to customize the helper
  109417. * @param scene The scene to add the material to
  109418. */
  109419. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  109420. /**
  109421. * Updates the background according to the new options
  109422. * @param options
  109423. */
  109424. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  109425. /**
  109426. * Sets the primary color of all the available elements.
  109427. * @param color the main color to affect to the ground and the background
  109428. */
  109429. setMainColor(color: Color3): void;
  109430. /**
  109431. * Setup the image processing according to the specified options.
  109432. */
  109433. private _setupImageProcessing;
  109434. /**
  109435. * Setup the environment texture according to the specified options.
  109436. */
  109437. private _setupEnvironmentTexture;
  109438. /**
  109439. * Setup the background according to the specified options.
  109440. */
  109441. private _setupBackground;
  109442. /**
  109443. * Get the scene sizes according to the setup.
  109444. */
  109445. private _getSceneSize;
  109446. /**
  109447. * Setup the ground according to the specified options.
  109448. */
  109449. private _setupGround;
  109450. /**
  109451. * Setup the ground material according to the specified options.
  109452. */
  109453. private _setupGroundMaterial;
  109454. /**
  109455. * Setup the ground diffuse texture according to the specified options.
  109456. */
  109457. private _setupGroundDiffuseTexture;
  109458. /**
  109459. * Setup the ground mirror texture according to the specified options.
  109460. */
  109461. private _setupGroundMirrorTexture;
  109462. /**
  109463. * Setup the ground to receive the mirror texture.
  109464. */
  109465. private _setupMirrorInGroundMaterial;
  109466. /**
  109467. * Setup the skybox according to the specified options.
  109468. */
  109469. private _setupSkybox;
  109470. /**
  109471. * Setup the skybox material according to the specified options.
  109472. */
  109473. private _setupSkyboxMaterial;
  109474. /**
  109475. * Setup the skybox reflection texture according to the specified options.
  109476. */
  109477. private _setupSkyboxReflectionTexture;
  109478. private _errorHandler;
  109479. /**
  109480. * Dispose all the elements created by the Helper.
  109481. */
  109482. dispose(): void;
  109483. }
  109484. }
  109485. declare module BABYLON {
  109486. /**
  109487. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  109488. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  109489. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  109490. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  109491. */
  109492. export class PhotoDome extends TransformNode {
  109493. /**
  109494. * Define the image as a Monoscopic panoramic 360 image.
  109495. */
  109496. static readonly MODE_MONOSCOPIC: number;
  109497. /**
  109498. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  109499. */
  109500. static readonly MODE_TOPBOTTOM: number;
  109501. /**
  109502. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  109503. */
  109504. static readonly MODE_SIDEBYSIDE: number;
  109505. private _useDirectMapping;
  109506. /**
  109507. * The texture being displayed on the sphere
  109508. */
  109509. protected _photoTexture: Texture;
  109510. /**
  109511. * Gets or sets the texture being displayed on the sphere
  109512. */
  109513. photoTexture: Texture;
  109514. /**
  109515. * Observable raised when an error occured while loading the 360 image
  109516. */
  109517. onLoadErrorObservable: Observable<string>;
  109518. /**
  109519. * The skybox material
  109520. */
  109521. protected _material: BackgroundMaterial;
  109522. /**
  109523. * The surface used for the skybox
  109524. */
  109525. protected _mesh: Mesh;
  109526. /**
  109527. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  109528. * Also see the options.resolution property.
  109529. */
  109530. fovMultiplier: number;
  109531. private _imageMode;
  109532. /**
  109533. * Gets or set the current video mode for the video. It can be:
  109534. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  109535. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  109536. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  109537. */
  109538. imageMode: number;
  109539. /**
  109540. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  109541. * @param name Element's name, child elements will append suffixes for their own names.
  109542. * @param urlsOfPhoto defines the url of the photo to display
  109543. * @param options defines an object containing optional or exposed sub element properties
  109544. * @param onError defines a callback called when an error occured while loading the texture
  109545. */
  109546. constructor(name: string, urlOfPhoto: string, options: {
  109547. resolution?: number;
  109548. size?: number;
  109549. useDirectMapping?: boolean;
  109550. faceForward?: boolean;
  109551. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  109552. private _onBeforeCameraRenderObserver;
  109553. private _changeImageMode;
  109554. /**
  109555. * Releases resources associated with this node.
  109556. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109557. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109558. */
  109559. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109560. }
  109561. }
  109562. declare module BABYLON {
  109563. /** @hidden */
  109564. export var rgbdDecodePixelShader: {
  109565. name: string;
  109566. shader: string;
  109567. };
  109568. }
  109569. declare module BABYLON {
  109570. /**
  109571. * Class used to host texture specific utilities
  109572. */
  109573. export class BRDFTextureTools {
  109574. /**
  109575. * Expand the BRDF Texture from RGBD to Half Float if necessary.
  109576. * @param texture the texture to expand.
  109577. */
  109578. private static _ExpandDefaultBRDFTexture;
  109579. /**
  109580. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  109581. * @param scene defines the hosting scene
  109582. * @returns the environment BRDF texture
  109583. */
  109584. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  109585. private static _environmentBRDFBase64Texture;
  109586. }
  109587. }
  109588. declare module BABYLON {
  109589. /**
  109590. * @hidden
  109591. */
  109592. export interface IMaterialClearCoatDefines {
  109593. CLEARCOAT: boolean;
  109594. CLEARCOAT_DEFAULTIOR: boolean;
  109595. CLEARCOAT_TEXTURE: boolean;
  109596. CLEARCOAT_TEXTUREDIRECTUV: number;
  109597. CLEARCOAT_BUMP: boolean;
  109598. CLEARCOAT_BUMPDIRECTUV: number;
  109599. CLEARCOAT_TINT: boolean;
  109600. CLEARCOAT_TINT_TEXTURE: boolean;
  109601. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  109602. /** @hidden */
  109603. _areTexturesDirty: boolean;
  109604. }
  109605. /**
  109606. * Define the code related to the clear coat parameters of the pbr material.
  109607. */
  109608. export class PBRClearCoatConfiguration {
  109609. /**
  109610. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  109611. * The default fits with a polyurethane material.
  109612. */
  109613. private static readonly _DefaultIndexOfRefraction;
  109614. private _isEnabled;
  109615. /**
  109616. * Defines if the clear coat is enabled in the material.
  109617. */
  109618. isEnabled: boolean;
  109619. /**
  109620. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  109621. */
  109622. intensity: number;
  109623. /**
  109624. * Defines the clear coat layer roughness.
  109625. */
  109626. roughness: number;
  109627. private _indexOfRefraction;
  109628. /**
  109629. * Defines the index of refraction of the clear coat.
  109630. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  109631. * The default fits with a polyurethane material.
  109632. * Changing the default value is more performance intensive.
  109633. */
  109634. indexOfRefraction: number;
  109635. private _texture;
  109636. /**
  109637. * Stores the clear coat values in a texture.
  109638. */
  109639. texture: Nullable<BaseTexture>;
  109640. private _bumpTexture;
  109641. /**
  109642. * Define the clear coat specific bump texture.
  109643. */
  109644. bumpTexture: Nullable<BaseTexture>;
  109645. private _isTintEnabled;
  109646. /**
  109647. * Defines if the clear coat tint is enabled in the material.
  109648. */
  109649. isTintEnabled: boolean;
  109650. /**
  109651. * Defines the clear coat tint of the material.
  109652. * This is only use if tint is enabled
  109653. */
  109654. tintColor: Color3;
  109655. /**
  109656. * Defines the distance at which the tint color should be found in the
  109657. * clear coat media.
  109658. * This is only use if tint is enabled
  109659. */
  109660. tintColorAtDistance: number;
  109661. /**
  109662. * Defines the clear coat layer thickness.
  109663. * This is only use if tint is enabled
  109664. */
  109665. tintThickness: number;
  109666. private _tintTexture;
  109667. /**
  109668. * Stores the clear tint values in a texture.
  109669. * rgb is tint
  109670. * a is a thickness factor
  109671. */
  109672. tintTexture: Nullable<BaseTexture>;
  109673. /** @hidden */
  109674. private _internalMarkAllSubMeshesAsTexturesDirty;
  109675. /** @hidden */
  109676. _markAllSubMeshesAsTexturesDirty(): void;
  109677. /**
  109678. * Instantiate a new istance of clear coat configuration.
  109679. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109680. */
  109681. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109682. /**
  109683. * Gets wehter the submesh is ready to be used or not.
  109684. * @param defines the list of "defines" to update.
  109685. * @param scene defines the scene the material belongs to.
  109686. * @param engine defines the engine the material belongs to.
  109687. * @param disableBumpMap defines wether the material disables bump or not.
  109688. * @returns - boolean indicating that the submesh is ready or not.
  109689. */
  109690. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  109691. /**
  109692. * Checks to see if a texture is used in the material.
  109693. * @param defines the list of "defines" to update.
  109694. * @param scene defines the scene to the material belongs to.
  109695. */
  109696. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  109697. /**
  109698. * Binds the material data.
  109699. * @param uniformBuffer defines the Uniform buffer to fill in.
  109700. * @param scene defines the scene the material belongs to.
  109701. * @param engine defines the engine the material belongs to.
  109702. * @param disableBumpMap defines wether the material disables bump or not.
  109703. * @param isFrozen defines wether the material is frozen or not.
  109704. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  109705. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  109706. */
  109707. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  109708. /**
  109709. * Checks to see if a texture is used in the material.
  109710. * @param texture - Base texture to use.
  109711. * @returns - Boolean specifying if a texture is used in the material.
  109712. */
  109713. hasTexture(texture: BaseTexture): boolean;
  109714. /**
  109715. * Returns an array of the actively used textures.
  109716. * @param activeTextures Array of BaseTextures
  109717. */
  109718. getActiveTextures(activeTextures: BaseTexture[]): void;
  109719. /**
  109720. * Returns the animatable textures.
  109721. * @param animatables Array of animatable textures.
  109722. */
  109723. getAnimatables(animatables: IAnimatable[]): void;
  109724. /**
  109725. * Disposes the resources of the material.
  109726. * @param forceDisposeTextures - Forces the disposal of all textures.
  109727. */
  109728. dispose(forceDisposeTextures?: boolean): void;
  109729. /**
  109730. * Get the current class name of the texture useful for serialization or dynamic coding.
  109731. * @returns "PBRClearCoatConfiguration"
  109732. */
  109733. getClassName(): string;
  109734. /**
  109735. * Add fallbacks to the effect fallbacks list.
  109736. * @param defines defines the Base texture to use.
  109737. * @param fallbacks defines the current fallback list.
  109738. * @param currentRank defines the current fallback rank.
  109739. * @returns the new fallback rank.
  109740. */
  109741. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  109742. /**
  109743. * Add the required uniforms to the current list.
  109744. * @param uniforms defines the current uniform list.
  109745. */
  109746. static AddUniforms(uniforms: string[]): void;
  109747. /**
  109748. * Add the required samplers to the current list.
  109749. * @param samplers defines the current sampler list.
  109750. */
  109751. static AddSamplers(samplers: string[]): void;
  109752. /**
  109753. * Add the required uniforms to the current buffer.
  109754. * @param uniformBuffer defines the current uniform buffer.
  109755. */
  109756. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  109757. /**
  109758. * Makes a duplicate of the current configuration into another one.
  109759. * @param clearCoatConfiguration define the config where to copy the info
  109760. */
  109761. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  109762. /**
  109763. * Serializes this clear coat configuration.
  109764. * @returns - An object with the serialized config.
  109765. */
  109766. serialize(): any;
  109767. /**
  109768. * Parses a anisotropy Configuration from a serialized object.
  109769. * @param source - Serialized object.
  109770. * @param scene Defines the scene we are parsing for
  109771. * @param rootUrl Defines the rootUrl to load from
  109772. */
  109773. parse(source: any, scene: Scene, rootUrl: string): void;
  109774. }
  109775. }
  109776. declare module BABYLON {
  109777. /**
  109778. * @hidden
  109779. */
  109780. export interface IMaterialAnisotropicDefines {
  109781. ANISOTROPIC: boolean;
  109782. ANISOTROPIC_TEXTURE: boolean;
  109783. ANISOTROPIC_TEXTUREDIRECTUV: number;
  109784. MAINUV1: boolean;
  109785. _areTexturesDirty: boolean;
  109786. _needUVs: boolean;
  109787. }
  109788. /**
  109789. * Define the code related to the anisotropic parameters of the pbr material.
  109790. */
  109791. export class PBRAnisotropicConfiguration {
  109792. private _isEnabled;
  109793. /**
  109794. * Defines if the anisotropy is enabled in the material.
  109795. */
  109796. isEnabled: boolean;
  109797. /**
  109798. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  109799. */
  109800. intensity: number;
  109801. /**
  109802. * Defines if the effect is along the tangents, bitangents or in between.
  109803. * By default, the effect is "strectching" the highlights along the tangents.
  109804. */
  109805. direction: Vector2;
  109806. private _texture;
  109807. /**
  109808. * Stores the anisotropy values in a texture.
  109809. * rg is direction (like normal from -1 to 1)
  109810. * b is a intensity
  109811. */
  109812. texture: Nullable<BaseTexture>;
  109813. /** @hidden */
  109814. private _internalMarkAllSubMeshesAsTexturesDirty;
  109815. /** @hidden */
  109816. _markAllSubMeshesAsTexturesDirty(): void;
  109817. /**
  109818. * Instantiate a new istance of anisotropy configuration.
  109819. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109820. */
  109821. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109822. /**
  109823. * Specifies that the submesh is ready to be used.
  109824. * @param defines the list of "defines" to update.
  109825. * @param scene defines the scene the material belongs to.
  109826. * @returns - boolean indicating that the submesh is ready or not.
  109827. */
  109828. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  109829. /**
  109830. * Checks to see if a texture is used in the material.
  109831. * @param defines the list of "defines" to update.
  109832. * @param mesh the mesh we are preparing the defines for.
  109833. * @param scene defines the scene the material belongs to.
  109834. */
  109835. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  109836. /**
  109837. * Binds the material data.
  109838. * @param uniformBuffer defines the Uniform buffer to fill in.
  109839. * @param scene defines the scene the material belongs to.
  109840. * @param isFrozen defines wether the material is frozen or not.
  109841. */
  109842. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109843. /**
  109844. * Checks to see if a texture is used in the material.
  109845. * @param texture - Base texture to use.
  109846. * @returns - Boolean specifying if a texture is used in the material.
  109847. */
  109848. hasTexture(texture: BaseTexture): boolean;
  109849. /**
  109850. * Returns an array of the actively used textures.
  109851. * @param activeTextures Array of BaseTextures
  109852. */
  109853. getActiveTextures(activeTextures: BaseTexture[]): void;
  109854. /**
  109855. * Returns the animatable textures.
  109856. * @param animatables Array of animatable textures.
  109857. */
  109858. getAnimatables(animatables: IAnimatable[]): void;
  109859. /**
  109860. * Disposes the resources of the material.
  109861. * @param forceDisposeTextures - Forces the disposal of all textures.
  109862. */
  109863. dispose(forceDisposeTextures?: boolean): void;
  109864. /**
  109865. * Get the current class name of the texture useful for serialization or dynamic coding.
  109866. * @returns "PBRAnisotropicConfiguration"
  109867. */
  109868. getClassName(): string;
  109869. /**
  109870. * Add fallbacks to the effect fallbacks list.
  109871. * @param defines defines the Base texture to use.
  109872. * @param fallbacks defines the current fallback list.
  109873. * @param currentRank defines the current fallback rank.
  109874. * @returns the new fallback rank.
  109875. */
  109876. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  109877. /**
  109878. * Add the required uniforms to the current list.
  109879. * @param uniforms defines the current uniform list.
  109880. */
  109881. static AddUniforms(uniforms: string[]): void;
  109882. /**
  109883. * Add the required uniforms to the current buffer.
  109884. * @param uniformBuffer defines the current uniform buffer.
  109885. */
  109886. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  109887. /**
  109888. * Add the required samplers to the current list.
  109889. * @param samplers defines the current sampler list.
  109890. */
  109891. static AddSamplers(samplers: string[]): void;
  109892. /**
  109893. * Makes a duplicate of the current configuration into another one.
  109894. * @param anisotropicConfiguration define the config where to copy the info
  109895. */
  109896. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  109897. /**
  109898. * Serializes this anisotropy configuration.
  109899. * @returns - An object with the serialized config.
  109900. */
  109901. serialize(): any;
  109902. /**
  109903. * Parses a anisotropy Configuration from a serialized object.
  109904. * @param source - Serialized object.
  109905. * @param scene Defines the scene we are parsing for
  109906. * @param rootUrl Defines the rootUrl to load from
  109907. */
  109908. parse(source: any, scene: Scene, rootUrl: string): void;
  109909. }
  109910. }
  109911. declare module BABYLON {
  109912. /**
  109913. * @hidden
  109914. */
  109915. export interface IMaterialBRDFDefines {
  109916. BRDF_V_HEIGHT_CORRELATED: boolean;
  109917. MS_BRDF_ENERGY_CONSERVATION: boolean;
  109918. SPHERICAL_HARMONICS: boolean;
  109919. /** @hidden */
  109920. _areMiscDirty: boolean;
  109921. }
  109922. /**
  109923. * Define the code related to the BRDF parameters of the pbr material.
  109924. */
  109925. export class PBRBRDFConfiguration {
  109926. /**
  109927. * Default value used for the energy conservation.
  109928. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  109929. */
  109930. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  109931. /**
  109932. * Default value used for the Smith Visibility Height Correlated mode.
  109933. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  109934. */
  109935. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  109936. /**
  109937. * Default value used for the IBL diffuse part.
  109938. * This can help switching back to the polynomials mode globally which is a tiny bit
  109939. * less GPU intensive at the drawback of a lower quality.
  109940. */
  109941. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  109942. private _useEnergyConservation;
  109943. /**
  109944. * Defines if the material uses energy conservation.
  109945. */
  109946. useEnergyConservation: boolean;
  109947. private _useSmithVisibilityHeightCorrelated;
  109948. /**
  109949. * LEGACY Mode set to false
  109950. * Defines if the material uses height smith correlated visibility term.
  109951. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  109952. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  109953. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  109954. * Not relying on height correlated will also disable energy conservation.
  109955. */
  109956. useSmithVisibilityHeightCorrelated: boolean;
  109957. private _useSphericalHarmonics;
  109958. /**
  109959. * LEGACY Mode set to false
  109960. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  109961. * diffuse part of the IBL.
  109962. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  109963. * to the ground truth.
  109964. */
  109965. useSphericalHarmonics: boolean;
  109966. /** @hidden */
  109967. private _internalMarkAllSubMeshesAsMiscDirty;
  109968. /** @hidden */
  109969. _markAllSubMeshesAsMiscDirty(): void;
  109970. /**
  109971. * Instantiate a new istance of clear coat configuration.
  109972. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  109973. */
  109974. constructor(markAllSubMeshesAsMiscDirty: () => void);
  109975. /**
  109976. * Checks to see if a texture is used in the material.
  109977. * @param defines the list of "defines" to update.
  109978. */
  109979. prepareDefines(defines: IMaterialBRDFDefines): void;
  109980. /**
  109981. * Get the current class name of the texture useful for serialization or dynamic coding.
  109982. * @returns "PBRClearCoatConfiguration"
  109983. */
  109984. getClassName(): string;
  109985. /**
  109986. * Makes a duplicate of the current configuration into another one.
  109987. * @param brdfConfiguration define the config where to copy the info
  109988. */
  109989. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  109990. /**
  109991. * Serializes this BRDF configuration.
  109992. * @returns - An object with the serialized config.
  109993. */
  109994. serialize(): any;
  109995. /**
  109996. * Parses a anisotropy Configuration from a serialized object.
  109997. * @param source - Serialized object.
  109998. * @param scene Defines the scene we are parsing for
  109999. * @param rootUrl Defines the rootUrl to load from
  110000. */
  110001. parse(source: any, scene: Scene, rootUrl: string): void;
  110002. }
  110003. }
  110004. declare module BABYLON {
  110005. /**
  110006. * @hidden
  110007. */
  110008. export interface IMaterialSheenDefines {
  110009. SHEEN: boolean;
  110010. SHEEN_TEXTURE: boolean;
  110011. SHEEN_TEXTUREDIRECTUV: number;
  110012. SHEEN_LINKWITHALBEDO: boolean;
  110013. /** @hidden */
  110014. _areTexturesDirty: boolean;
  110015. }
  110016. /**
  110017. * Define the code related to the Sheen parameters of the pbr material.
  110018. */
  110019. export class PBRSheenConfiguration {
  110020. private _isEnabled;
  110021. /**
  110022. * Defines if the material uses sheen.
  110023. */
  110024. isEnabled: boolean;
  110025. private _linkSheenWithAlbedo;
  110026. /**
  110027. * Defines if the sheen is linked to the sheen color.
  110028. */
  110029. linkSheenWithAlbedo: boolean;
  110030. /**
  110031. * Defines the sheen intensity.
  110032. */
  110033. intensity: number;
  110034. /**
  110035. * Defines the sheen color.
  110036. */
  110037. color: Color3;
  110038. private _texture;
  110039. /**
  110040. * Stores the sheen tint values in a texture.
  110041. * rgb is tint
  110042. * a is a intensity
  110043. */
  110044. texture: Nullable<BaseTexture>;
  110045. /** @hidden */
  110046. private _internalMarkAllSubMeshesAsTexturesDirty;
  110047. /** @hidden */
  110048. _markAllSubMeshesAsTexturesDirty(): void;
  110049. /**
  110050. * Instantiate a new istance of clear coat configuration.
  110051. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  110052. */
  110053. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  110054. /**
  110055. * Specifies that the submesh is ready to be used.
  110056. * @param defines the list of "defines" to update.
  110057. * @param scene defines the scene the material belongs to.
  110058. * @returns - boolean indicating that the submesh is ready or not.
  110059. */
  110060. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  110061. /**
  110062. * Checks to see if a texture is used in the material.
  110063. * @param defines the list of "defines" to update.
  110064. * @param scene defines the scene the material belongs to.
  110065. */
  110066. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  110067. /**
  110068. * Binds the material data.
  110069. * @param uniformBuffer defines the Uniform buffer to fill in.
  110070. * @param scene defines the scene the material belongs to.
  110071. * @param isFrozen defines wether the material is frozen or not.
  110072. */
  110073. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  110074. /**
  110075. * Checks to see if a texture is used in the material.
  110076. * @param texture - Base texture to use.
  110077. * @returns - Boolean specifying if a texture is used in the material.
  110078. */
  110079. hasTexture(texture: BaseTexture): boolean;
  110080. /**
  110081. * Returns an array of the actively used textures.
  110082. * @param activeTextures Array of BaseTextures
  110083. */
  110084. getActiveTextures(activeTextures: BaseTexture[]): void;
  110085. /**
  110086. * Returns the animatable textures.
  110087. * @param animatables Array of animatable textures.
  110088. */
  110089. getAnimatables(animatables: IAnimatable[]): void;
  110090. /**
  110091. * Disposes the resources of the material.
  110092. * @param forceDisposeTextures - Forces the disposal of all textures.
  110093. */
  110094. dispose(forceDisposeTextures?: boolean): void;
  110095. /**
  110096. * Get the current class name of the texture useful for serialization or dynamic coding.
  110097. * @returns "PBRSheenConfiguration"
  110098. */
  110099. getClassName(): string;
  110100. /**
  110101. * Add fallbacks to the effect fallbacks list.
  110102. * @param defines defines the Base texture to use.
  110103. * @param fallbacks defines the current fallback list.
  110104. * @param currentRank defines the current fallback rank.
  110105. * @returns the new fallback rank.
  110106. */
  110107. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  110108. /**
  110109. * Add the required uniforms to the current list.
  110110. * @param uniforms defines the current uniform list.
  110111. */
  110112. static AddUniforms(uniforms: string[]): void;
  110113. /**
  110114. * Add the required uniforms to the current buffer.
  110115. * @param uniformBuffer defines the current uniform buffer.
  110116. */
  110117. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110118. /**
  110119. * Add the required samplers to the current list.
  110120. * @param samplers defines the current sampler list.
  110121. */
  110122. static AddSamplers(samplers: string[]): void;
  110123. /**
  110124. * Makes a duplicate of the current configuration into another one.
  110125. * @param sheenConfiguration define the config where to copy the info
  110126. */
  110127. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  110128. /**
  110129. * Serializes this BRDF configuration.
  110130. * @returns - An object with the serialized config.
  110131. */
  110132. serialize(): any;
  110133. /**
  110134. * Parses a anisotropy Configuration from a serialized object.
  110135. * @param source - Serialized object.
  110136. * @param scene Defines the scene we are parsing for
  110137. * @param rootUrl Defines the rootUrl to load from
  110138. */
  110139. parse(source: any, scene: Scene, rootUrl: string): void;
  110140. }
  110141. }
  110142. declare module BABYLON {
  110143. /**
  110144. * @hidden
  110145. */
  110146. export interface IMaterialSubSurfaceDefines {
  110147. SUBSURFACE: boolean;
  110148. SS_REFRACTION: boolean;
  110149. SS_TRANSLUCENCY: boolean;
  110150. SS_SCATERRING: boolean;
  110151. SS_THICKNESSANDMASK_TEXTURE: boolean;
  110152. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  110153. SS_REFRACTIONMAP_3D: boolean;
  110154. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  110155. SS_LODINREFRACTIONALPHA: boolean;
  110156. SS_GAMMAREFRACTION: boolean;
  110157. SS_RGBDREFRACTION: boolean;
  110158. SS_LINEARSPECULARREFRACTION: boolean;
  110159. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  110160. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  110161. /** @hidden */
  110162. _areTexturesDirty: boolean;
  110163. }
  110164. /**
  110165. * Define the code related to the sub surface parameters of the pbr material.
  110166. */
  110167. export class PBRSubSurfaceConfiguration {
  110168. private _isRefractionEnabled;
  110169. /**
  110170. * Defines if the refraction is enabled in the material.
  110171. */
  110172. isRefractionEnabled: boolean;
  110173. private _isTranslucencyEnabled;
  110174. /**
  110175. * Defines if the translucency is enabled in the material.
  110176. */
  110177. isTranslucencyEnabled: boolean;
  110178. private _isScatteringEnabled;
  110179. /**
  110180. * Defines the refraction intensity of the material.
  110181. * The refraction when enabled replaces the Diffuse part of the material.
  110182. * The intensity helps transitionning between diffuse and refraction.
  110183. */
  110184. refractionIntensity: number;
  110185. /**
  110186. * Defines the translucency intensity of the material.
  110187. * When translucency has been enabled, this defines how much of the "translucency"
  110188. * is addded to the diffuse part of the material.
  110189. */
  110190. translucencyIntensity: number;
  110191. /**
  110192. * Defines the scattering intensity of the material.
  110193. * When scattering has been enabled, this defines how much of the "scattered light"
  110194. * is addded to the diffuse part of the material.
  110195. */
  110196. scatteringIntensity: number;
  110197. private _thicknessTexture;
  110198. /**
  110199. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  110200. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  110201. * 0 would mean minimumThickness
  110202. * 1 would mean maximumThickness
  110203. * The other channels might be use as a mask to vary the different effects intensity.
  110204. */
  110205. thicknessTexture: Nullable<BaseTexture>;
  110206. private _refractionTexture;
  110207. /**
  110208. * Defines the texture to use for refraction.
  110209. */
  110210. refractionTexture: Nullable<BaseTexture>;
  110211. private _indexOfRefraction;
  110212. /**
  110213. * Defines the index of refraction used in the material.
  110214. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  110215. */
  110216. indexOfRefraction: number;
  110217. private _invertRefractionY;
  110218. /**
  110219. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  110220. */
  110221. invertRefractionY: boolean;
  110222. private _linkRefractionWithTransparency;
  110223. /**
  110224. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  110225. * Materials half opaque for instance using refraction could benefit from this control.
  110226. */
  110227. linkRefractionWithTransparency: boolean;
  110228. /**
  110229. * Defines the minimum thickness stored in the thickness map.
  110230. * If no thickness map is defined, this value will be used to simulate thickness.
  110231. */
  110232. minimumThickness: number;
  110233. /**
  110234. * Defines the maximum thickness stored in the thickness map.
  110235. */
  110236. maximumThickness: number;
  110237. /**
  110238. * Defines the volume tint of the material.
  110239. * This is used for both translucency and scattering.
  110240. */
  110241. tintColor: Color3;
  110242. /**
  110243. * Defines the distance at which the tint color should be found in the media.
  110244. * This is used for refraction only.
  110245. */
  110246. tintColorAtDistance: number;
  110247. /**
  110248. * Defines how far each channel transmit through the media.
  110249. * It is defined as a color to simplify it selection.
  110250. */
  110251. diffusionDistance: Color3;
  110252. private _useMaskFromThicknessTexture;
  110253. /**
  110254. * Stores the intensity of the different subsurface effects in the thickness texture.
  110255. * * the green channel is the translucency intensity.
  110256. * * the blue channel is the scattering intensity.
  110257. * * the alpha channel is the refraction intensity.
  110258. */
  110259. useMaskFromThicknessTexture: boolean;
  110260. /** @hidden */
  110261. private _internalMarkAllSubMeshesAsTexturesDirty;
  110262. /** @hidden */
  110263. _markAllSubMeshesAsTexturesDirty(): void;
  110264. /**
  110265. * Instantiate a new istance of sub surface configuration.
  110266. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  110267. */
  110268. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  110269. /**
  110270. * Gets wehter the submesh is ready to be used or not.
  110271. * @param defines the list of "defines" to update.
  110272. * @param scene defines the scene the material belongs to.
  110273. * @returns - boolean indicating that the submesh is ready or not.
  110274. */
  110275. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  110276. /**
  110277. * Checks to see if a texture is used in the material.
  110278. * @param defines the list of "defines" to update.
  110279. * @param scene defines the scene to the material belongs to.
  110280. */
  110281. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  110282. /**
  110283. * Binds the material data.
  110284. * @param uniformBuffer defines the Uniform buffer to fill in.
  110285. * @param scene defines the scene the material belongs to.
  110286. * @param engine defines the engine the material belongs to.
  110287. * @param isFrozen defines wether the material is frozen or not.
  110288. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  110289. */
  110290. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  110291. /**
  110292. * Unbinds the material from the mesh.
  110293. * @param activeEffect defines the effect that should be unbound from.
  110294. * @returns true if unbound, otherwise false
  110295. */
  110296. unbind(activeEffect: Effect): boolean;
  110297. /**
  110298. * Returns the texture used for refraction or null if none is used.
  110299. * @param scene defines the scene the material belongs to.
  110300. * @returns - Refraction texture if present. If no refraction texture and refraction
  110301. * is linked with transparency, returns environment texture. Otherwise, returns null.
  110302. */
  110303. private _getRefractionTexture;
  110304. /**
  110305. * Returns true if alpha blending should be disabled.
  110306. */
  110307. readonly disableAlphaBlending: boolean;
  110308. /**
  110309. * Fills the list of render target textures.
  110310. * @param renderTargets the list of render targets to update
  110311. */
  110312. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  110313. /**
  110314. * Checks to see if a texture is used in the material.
  110315. * @param texture - Base texture to use.
  110316. * @returns - Boolean specifying if a texture is used in the material.
  110317. */
  110318. hasTexture(texture: BaseTexture): boolean;
  110319. /**
  110320. * Gets a boolean indicating that current material needs to register RTT
  110321. * @returns true if this uses a render target otherwise false.
  110322. */
  110323. hasRenderTargetTextures(): boolean;
  110324. /**
  110325. * Returns an array of the actively used textures.
  110326. * @param activeTextures Array of BaseTextures
  110327. */
  110328. getActiveTextures(activeTextures: BaseTexture[]): void;
  110329. /**
  110330. * Returns the animatable textures.
  110331. * @param animatables Array of animatable textures.
  110332. */
  110333. getAnimatables(animatables: IAnimatable[]): void;
  110334. /**
  110335. * Disposes the resources of the material.
  110336. * @param forceDisposeTextures - Forces the disposal of all textures.
  110337. */
  110338. dispose(forceDisposeTextures?: boolean): void;
  110339. /**
  110340. * Get the current class name of the texture useful for serialization or dynamic coding.
  110341. * @returns "PBRSubSurfaceConfiguration"
  110342. */
  110343. getClassName(): string;
  110344. /**
  110345. * Add fallbacks to the effect fallbacks list.
  110346. * @param defines defines the Base texture to use.
  110347. * @param fallbacks defines the current fallback list.
  110348. * @param currentRank defines the current fallback rank.
  110349. * @returns the new fallback rank.
  110350. */
  110351. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  110352. /**
  110353. * Add the required uniforms to the current list.
  110354. * @param uniforms defines the current uniform list.
  110355. */
  110356. static AddUniforms(uniforms: string[]): void;
  110357. /**
  110358. * Add the required samplers to the current list.
  110359. * @param samplers defines the current sampler list.
  110360. */
  110361. static AddSamplers(samplers: string[]): void;
  110362. /**
  110363. * Add the required uniforms to the current buffer.
  110364. * @param uniformBuffer defines the current uniform buffer.
  110365. */
  110366. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110367. /**
  110368. * Makes a duplicate of the current configuration into another one.
  110369. * @param configuration define the config where to copy the info
  110370. */
  110371. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  110372. /**
  110373. * Serializes this Sub Surface configuration.
  110374. * @returns - An object with the serialized config.
  110375. */
  110376. serialize(): any;
  110377. /**
  110378. * Parses a anisotropy Configuration from a serialized object.
  110379. * @param source - Serialized object.
  110380. * @param scene Defines the scene we are parsing for
  110381. * @param rootUrl Defines the rootUrl to load from
  110382. */
  110383. parse(source: any, scene: Scene, rootUrl: string): void;
  110384. }
  110385. }
  110386. declare module BABYLON {
  110387. /** @hidden */
  110388. export var pbrFragmentDeclaration: {
  110389. name: string;
  110390. shader: string;
  110391. };
  110392. }
  110393. declare module BABYLON {
  110394. /** @hidden */
  110395. export var pbrUboDeclaration: {
  110396. name: string;
  110397. shader: string;
  110398. };
  110399. }
  110400. declare module BABYLON {
  110401. /** @hidden */
  110402. export var pbrFragmentExtraDeclaration: {
  110403. name: string;
  110404. shader: string;
  110405. };
  110406. }
  110407. declare module BABYLON {
  110408. /** @hidden */
  110409. export var pbrFragmentSamplersDeclaration: {
  110410. name: string;
  110411. shader: string;
  110412. };
  110413. }
  110414. declare module BABYLON {
  110415. /** @hidden */
  110416. export var pbrHelperFunctions: {
  110417. name: string;
  110418. shader: string;
  110419. };
  110420. }
  110421. declare module BABYLON {
  110422. /** @hidden */
  110423. export var harmonicsFunctions: {
  110424. name: string;
  110425. shader: string;
  110426. };
  110427. }
  110428. declare module BABYLON {
  110429. /** @hidden */
  110430. export var pbrDirectLightingSetupFunctions: {
  110431. name: string;
  110432. shader: string;
  110433. };
  110434. }
  110435. declare module BABYLON {
  110436. /** @hidden */
  110437. export var pbrDirectLightingFalloffFunctions: {
  110438. name: string;
  110439. shader: string;
  110440. };
  110441. }
  110442. declare module BABYLON {
  110443. /** @hidden */
  110444. export var pbrBRDFFunctions: {
  110445. name: string;
  110446. shader: string;
  110447. };
  110448. }
  110449. declare module BABYLON {
  110450. /** @hidden */
  110451. export var pbrDirectLightingFunctions: {
  110452. name: string;
  110453. shader: string;
  110454. };
  110455. }
  110456. declare module BABYLON {
  110457. /** @hidden */
  110458. export var pbrIBLFunctions: {
  110459. name: string;
  110460. shader: string;
  110461. };
  110462. }
  110463. declare module BABYLON {
  110464. /** @hidden */
  110465. export var pbrDebug: {
  110466. name: string;
  110467. shader: string;
  110468. };
  110469. }
  110470. declare module BABYLON {
  110471. /** @hidden */
  110472. export var pbrPixelShader: {
  110473. name: string;
  110474. shader: string;
  110475. };
  110476. }
  110477. declare module BABYLON {
  110478. /** @hidden */
  110479. export var pbrVertexDeclaration: {
  110480. name: string;
  110481. shader: string;
  110482. };
  110483. }
  110484. declare module BABYLON {
  110485. /** @hidden */
  110486. export var pbrVertexShader: {
  110487. name: string;
  110488. shader: string;
  110489. };
  110490. }
  110491. declare module BABYLON {
  110492. /**
  110493. * Manages the defines for the PBR Material.
  110494. * @hidden
  110495. */
  110496. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  110497. PBR: boolean;
  110498. MAINUV1: boolean;
  110499. MAINUV2: boolean;
  110500. UV1: boolean;
  110501. UV2: boolean;
  110502. ALBEDO: boolean;
  110503. ALBEDODIRECTUV: number;
  110504. VERTEXCOLOR: boolean;
  110505. AMBIENT: boolean;
  110506. AMBIENTDIRECTUV: number;
  110507. AMBIENTINGRAYSCALE: boolean;
  110508. OPACITY: boolean;
  110509. VERTEXALPHA: boolean;
  110510. OPACITYDIRECTUV: number;
  110511. OPACITYRGB: boolean;
  110512. ALPHATEST: boolean;
  110513. DEPTHPREPASS: boolean;
  110514. ALPHABLEND: boolean;
  110515. ALPHAFROMALBEDO: boolean;
  110516. ALPHATESTVALUE: string;
  110517. SPECULAROVERALPHA: boolean;
  110518. RADIANCEOVERALPHA: boolean;
  110519. ALPHAFRESNEL: boolean;
  110520. LINEARALPHAFRESNEL: boolean;
  110521. PREMULTIPLYALPHA: boolean;
  110522. EMISSIVE: boolean;
  110523. EMISSIVEDIRECTUV: number;
  110524. REFLECTIVITY: boolean;
  110525. REFLECTIVITYDIRECTUV: number;
  110526. SPECULARTERM: boolean;
  110527. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  110528. MICROSURFACEAUTOMATIC: boolean;
  110529. LODBASEDMICROSFURACE: boolean;
  110530. MICROSURFACEMAP: boolean;
  110531. MICROSURFACEMAPDIRECTUV: number;
  110532. METALLICWORKFLOW: boolean;
  110533. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  110534. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  110535. METALLNESSSTOREINMETALMAPBLUE: boolean;
  110536. AOSTOREINMETALMAPRED: boolean;
  110537. ENVIRONMENTBRDF: boolean;
  110538. ENVIRONMENTBRDF_RGBD: boolean;
  110539. NORMAL: boolean;
  110540. TANGENT: boolean;
  110541. BUMP: boolean;
  110542. BUMPDIRECTUV: number;
  110543. OBJECTSPACE_NORMALMAP: boolean;
  110544. PARALLAX: boolean;
  110545. PARALLAXOCCLUSION: boolean;
  110546. NORMALXYSCALE: boolean;
  110547. LIGHTMAP: boolean;
  110548. LIGHTMAPDIRECTUV: number;
  110549. USELIGHTMAPASSHADOWMAP: boolean;
  110550. GAMMALIGHTMAP: boolean;
  110551. REFLECTION: boolean;
  110552. REFLECTIONMAP_3D: boolean;
  110553. REFLECTIONMAP_SPHERICAL: boolean;
  110554. REFLECTIONMAP_PLANAR: boolean;
  110555. REFLECTIONMAP_CUBIC: boolean;
  110556. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110557. REFLECTIONMAP_PROJECTION: boolean;
  110558. REFLECTIONMAP_SKYBOX: boolean;
  110559. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  110560. REFLECTIONMAP_EXPLICIT: boolean;
  110561. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110562. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110563. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110564. INVERTCUBICMAP: boolean;
  110565. USESPHERICALFROMREFLECTIONMAP: boolean;
  110566. USEIRRADIANCEMAP: boolean;
  110567. SPHERICAL_HARMONICS: boolean;
  110568. USESPHERICALINVERTEX: boolean;
  110569. REFLECTIONMAP_OPPOSITEZ: boolean;
  110570. LODINREFLECTIONALPHA: boolean;
  110571. GAMMAREFLECTION: boolean;
  110572. RGBDREFLECTION: boolean;
  110573. LINEARSPECULARREFLECTION: boolean;
  110574. RADIANCEOCCLUSION: boolean;
  110575. HORIZONOCCLUSION: boolean;
  110576. INSTANCES: boolean;
  110577. NUM_BONE_INFLUENCERS: number;
  110578. BonesPerMesh: number;
  110579. BONETEXTURE: boolean;
  110580. NONUNIFORMSCALING: boolean;
  110581. MORPHTARGETS: boolean;
  110582. MORPHTARGETS_NORMAL: boolean;
  110583. MORPHTARGETS_TANGENT: boolean;
  110584. MORPHTARGETS_UV: boolean;
  110585. NUM_MORPH_INFLUENCERS: number;
  110586. IMAGEPROCESSING: boolean;
  110587. VIGNETTE: boolean;
  110588. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110589. VIGNETTEBLENDMODEOPAQUE: boolean;
  110590. TONEMAPPING: boolean;
  110591. TONEMAPPING_ACES: boolean;
  110592. CONTRAST: boolean;
  110593. COLORCURVES: boolean;
  110594. COLORGRADING: boolean;
  110595. COLORGRADING3D: boolean;
  110596. SAMPLER3DGREENDEPTH: boolean;
  110597. SAMPLER3DBGRMAP: boolean;
  110598. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110599. EXPOSURE: boolean;
  110600. MULTIVIEW: boolean;
  110601. USEPHYSICALLIGHTFALLOFF: boolean;
  110602. USEGLTFLIGHTFALLOFF: boolean;
  110603. TWOSIDEDLIGHTING: boolean;
  110604. SHADOWFLOAT: boolean;
  110605. CLIPPLANE: boolean;
  110606. CLIPPLANE2: boolean;
  110607. CLIPPLANE3: boolean;
  110608. CLIPPLANE4: boolean;
  110609. POINTSIZE: boolean;
  110610. FOG: boolean;
  110611. LOGARITHMICDEPTH: boolean;
  110612. FORCENORMALFORWARD: boolean;
  110613. SPECULARAA: boolean;
  110614. CLEARCOAT: boolean;
  110615. CLEARCOAT_DEFAULTIOR: boolean;
  110616. CLEARCOAT_TEXTURE: boolean;
  110617. CLEARCOAT_TEXTUREDIRECTUV: number;
  110618. CLEARCOAT_BUMP: boolean;
  110619. CLEARCOAT_BUMPDIRECTUV: number;
  110620. CLEARCOAT_TINT: boolean;
  110621. CLEARCOAT_TINT_TEXTURE: boolean;
  110622. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  110623. ANISOTROPIC: boolean;
  110624. ANISOTROPIC_TEXTURE: boolean;
  110625. ANISOTROPIC_TEXTUREDIRECTUV: number;
  110626. BRDF_V_HEIGHT_CORRELATED: boolean;
  110627. MS_BRDF_ENERGY_CONSERVATION: boolean;
  110628. SHEEN: boolean;
  110629. SHEEN_TEXTURE: boolean;
  110630. SHEEN_TEXTUREDIRECTUV: number;
  110631. SHEEN_LINKWITHALBEDO: boolean;
  110632. SUBSURFACE: boolean;
  110633. SS_REFRACTION: boolean;
  110634. SS_TRANSLUCENCY: boolean;
  110635. SS_SCATERRING: boolean;
  110636. SS_THICKNESSANDMASK_TEXTURE: boolean;
  110637. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  110638. SS_REFRACTIONMAP_3D: boolean;
  110639. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  110640. SS_LODINREFRACTIONALPHA: boolean;
  110641. SS_GAMMAREFRACTION: boolean;
  110642. SS_RGBDREFRACTION: boolean;
  110643. SS_LINEARSPECULARREFRACTION: boolean;
  110644. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  110645. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  110646. UNLIT: boolean;
  110647. DEBUGMODE: number;
  110648. /**
  110649. * Initializes the PBR Material defines.
  110650. */
  110651. constructor();
  110652. /**
  110653. * Resets the PBR Material defines.
  110654. */
  110655. reset(): void;
  110656. }
  110657. /**
  110658. * The Physically based material base class of BJS.
  110659. *
  110660. * This offers the main features of a standard PBR material.
  110661. * For more information, please refer to the documentation :
  110662. * https://doc.babylonjs.com/how_to/physically_based_rendering
  110663. */
  110664. export abstract class PBRBaseMaterial extends PushMaterial {
  110665. /**
  110666. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  110667. */
  110668. static readonly PBRMATERIAL_OPAQUE: number;
  110669. /**
  110670. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  110671. */
  110672. static readonly PBRMATERIAL_ALPHATEST: number;
  110673. /**
  110674. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  110675. */
  110676. static readonly PBRMATERIAL_ALPHABLEND: number;
  110677. /**
  110678. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  110679. * They are also discarded below the alpha cutoff threshold to improve performances.
  110680. */
  110681. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  110682. /**
  110683. * Defines the default value of how much AO map is occluding the analytical lights
  110684. * (point spot...).
  110685. */
  110686. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  110687. /**
  110688. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  110689. */
  110690. static readonly LIGHTFALLOFF_PHYSICAL: number;
  110691. /**
  110692. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  110693. * to enhance interoperability with other engines.
  110694. */
  110695. static readonly LIGHTFALLOFF_GLTF: number;
  110696. /**
  110697. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  110698. * to enhance interoperability with other materials.
  110699. */
  110700. static readonly LIGHTFALLOFF_STANDARD: number;
  110701. /**
  110702. * Intensity of the direct lights e.g. the four lights available in your scene.
  110703. * This impacts both the direct diffuse and specular highlights.
  110704. */
  110705. protected _directIntensity: number;
  110706. /**
  110707. * Intensity of the emissive part of the material.
  110708. * This helps controlling the emissive effect without modifying the emissive color.
  110709. */
  110710. protected _emissiveIntensity: number;
  110711. /**
  110712. * Intensity of the environment e.g. how much the environment will light the object
  110713. * either through harmonics for rough material or through the refelction for shiny ones.
  110714. */
  110715. protected _environmentIntensity: number;
  110716. /**
  110717. * This is a special control allowing the reduction of the specular highlights coming from the
  110718. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  110719. */
  110720. protected _specularIntensity: number;
  110721. /**
  110722. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  110723. */
  110724. private _lightingInfos;
  110725. /**
  110726. * Debug Control allowing disabling the bump map on this material.
  110727. */
  110728. protected _disableBumpMap: boolean;
  110729. /**
  110730. * AKA Diffuse Texture in standard nomenclature.
  110731. */
  110732. protected _albedoTexture: Nullable<BaseTexture>;
  110733. /**
  110734. * AKA Occlusion Texture in other nomenclature.
  110735. */
  110736. protected _ambientTexture: Nullable<BaseTexture>;
  110737. /**
  110738. * AKA Occlusion Texture Intensity in other nomenclature.
  110739. */
  110740. protected _ambientTextureStrength: number;
  110741. /**
  110742. * Defines how much the AO map is occluding the analytical lights (point spot...).
  110743. * 1 means it completely occludes it
  110744. * 0 mean it has no impact
  110745. */
  110746. protected _ambientTextureImpactOnAnalyticalLights: number;
  110747. /**
  110748. * Stores the alpha values in a texture.
  110749. */
  110750. protected _opacityTexture: Nullable<BaseTexture>;
  110751. /**
  110752. * Stores the reflection values in a texture.
  110753. */
  110754. protected _reflectionTexture: Nullable<BaseTexture>;
  110755. /**
  110756. * Stores the emissive values in a texture.
  110757. */
  110758. protected _emissiveTexture: Nullable<BaseTexture>;
  110759. /**
  110760. * AKA Specular texture in other nomenclature.
  110761. */
  110762. protected _reflectivityTexture: Nullable<BaseTexture>;
  110763. /**
  110764. * Used to switch from specular/glossiness to metallic/roughness workflow.
  110765. */
  110766. protected _metallicTexture: Nullable<BaseTexture>;
  110767. /**
  110768. * Specifies the metallic scalar of the metallic/roughness workflow.
  110769. * Can also be used to scale the metalness values of the metallic texture.
  110770. */
  110771. protected _metallic: Nullable<number>;
  110772. /**
  110773. * Specifies the roughness scalar of the metallic/roughness workflow.
  110774. * Can also be used to scale the roughness values of the metallic texture.
  110775. */
  110776. protected _roughness: Nullable<number>;
  110777. /**
  110778. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  110779. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  110780. */
  110781. protected _microSurfaceTexture: Nullable<BaseTexture>;
  110782. /**
  110783. * Stores surface normal data used to displace a mesh in a texture.
  110784. */
  110785. protected _bumpTexture: Nullable<BaseTexture>;
  110786. /**
  110787. * Stores the pre-calculated light information of a mesh in a texture.
  110788. */
  110789. protected _lightmapTexture: Nullable<BaseTexture>;
  110790. /**
  110791. * The color of a material in ambient lighting.
  110792. */
  110793. protected _ambientColor: Color3;
  110794. /**
  110795. * AKA Diffuse Color in other nomenclature.
  110796. */
  110797. protected _albedoColor: Color3;
  110798. /**
  110799. * AKA Specular Color in other nomenclature.
  110800. */
  110801. protected _reflectivityColor: Color3;
  110802. /**
  110803. * The color applied when light is reflected from a material.
  110804. */
  110805. protected _reflectionColor: Color3;
  110806. /**
  110807. * The color applied when light is emitted from a material.
  110808. */
  110809. protected _emissiveColor: Color3;
  110810. /**
  110811. * AKA Glossiness in other nomenclature.
  110812. */
  110813. protected _microSurface: number;
  110814. /**
  110815. * Specifies that the material will use the light map as a show map.
  110816. */
  110817. protected _useLightmapAsShadowmap: boolean;
  110818. /**
  110819. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  110820. * makes the reflect vector face the model (under horizon).
  110821. */
  110822. protected _useHorizonOcclusion: boolean;
  110823. /**
  110824. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  110825. * too much the area relying on ambient texture to define their ambient occlusion.
  110826. */
  110827. protected _useRadianceOcclusion: boolean;
  110828. /**
  110829. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  110830. */
  110831. protected _useAlphaFromAlbedoTexture: boolean;
  110832. /**
  110833. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  110834. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110835. */
  110836. protected _useSpecularOverAlpha: boolean;
  110837. /**
  110838. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  110839. */
  110840. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  110841. /**
  110842. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  110843. */
  110844. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  110845. /**
  110846. * Specifies if the metallic texture contains the roughness information in its green channel.
  110847. */
  110848. protected _useRoughnessFromMetallicTextureGreen: boolean;
  110849. /**
  110850. * Specifies if the metallic texture contains the metallness information in its blue channel.
  110851. */
  110852. protected _useMetallnessFromMetallicTextureBlue: boolean;
  110853. /**
  110854. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  110855. */
  110856. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  110857. /**
  110858. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  110859. */
  110860. protected _useAmbientInGrayScale: boolean;
  110861. /**
  110862. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  110863. * The material will try to infer what glossiness each pixel should be.
  110864. */
  110865. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  110866. /**
  110867. * Defines the falloff type used in this material.
  110868. * It by default is Physical.
  110869. */
  110870. protected _lightFalloff: number;
  110871. /**
  110872. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110873. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110874. */
  110875. protected _useRadianceOverAlpha: boolean;
  110876. /**
  110877. * Allows using an object space normal map (instead of tangent space).
  110878. */
  110879. protected _useObjectSpaceNormalMap: boolean;
  110880. /**
  110881. * Allows using the bump map in parallax mode.
  110882. */
  110883. protected _useParallax: boolean;
  110884. /**
  110885. * Allows using the bump map in parallax occlusion mode.
  110886. */
  110887. protected _useParallaxOcclusion: boolean;
  110888. /**
  110889. * Controls the scale bias of the parallax mode.
  110890. */
  110891. protected _parallaxScaleBias: number;
  110892. /**
  110893. * If sets to true, disables all the lights affecting the material.
  110894. */
  110895. protected _disableLighting: boolean;
  110896. /**
  110897. * Number of Simultaneous lights allowed on the material.
  110898. */
  110899. protected _maxSimultaneousLights: number;
  110900. /**
  110901. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  110902. */
  110903. protected _invertNormalMapX: boolean;
  110904. /**
  110905. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  110906. */
  110907. protected _invertNormalMapY: boolean;
  110908. /**
  110909. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110910. */
  110911. protected _twoSidedLighting: boolean;
  110912. /**
  110913. * Defines the alpha limits in alpha test mode.
  110914. */
  110915. protected _alphaCutOff: number;
  110916. /**
  110917. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  110918. */
  110919. protected _forceAlphaTest: boolean;
  110920. /**
  110921. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  110922. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  110923. */
  110924. protected _useAlphaFresnel: boolean;
  110925. /**
  110926. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  110927. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  110928. */
  110929. protected _useLinearAlphaFresnel: boolean;
  110930. /**
  110931. * The transparency mode of the material.
  110932. */
  110933. protected _transparencyMode: Nullable<number>;
  110934. /**
  110935. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  110936. * from cos thetav and roughness:
  110937. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  110938. */
  110939. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  110940. /**
  110941. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  110942. */
  110943. protected _forceIrradianceInFragment: boolean;
  110944. /**
  110945. * Force normal to face away from face.
  110946. */
  110947. protected _forceNormalForward: boolean;
  110948. /**
  110949. * Enables specular anti aliasing in the PBR shader.
  110950. * It will both interacts on the Geometry for analytical and IBL lighting.
  110951. * It also prefilter the roughness map based on the bump values.
  110952. */
  110953. protected _enableSpecularAntiAliasing: boolean;
  110954. /**
  110955. * Default configuration related to image processing available in the PBR Material.
  110956. */
  110957. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110958. /**
  110959. * Keep track of the image processing observer to allow dispose and replace.
  110960. */
  110961. private _imageProcessingObserver;
  110962. /**
  110963. * Attaches a new image processing configuration to the PBR Material.
  110964. * @param configuration
  110965. */
  110966. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110967. /**
  110968. * Stores the available render targets.
  110969. */
  110970. private _renderTargets;
  110971. /**
  110972. * Sets the global ambient color for the material used in lighting calculations.
  110973. */
  110974. private _globalAmbientColor;
  110975. /**
  110976. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  110977. */
  110978. private _useLogarithmicDepth;
  110979. /**
  110980. * If set to true, no lighting calculations will be applied.
  110981. */
  110982. private _unlit;
  110983. private _debugMode;
  110984. /**
  110985. * @hidden
  110986. * This is reserved for the inspector.
  110987. * Defines the material debug mode.
  110988. * It helps seeing only some components of the material while troubleshooting.
  110989. */
  110990. debugMode: number;
  110991. /**
  110992. * @hidden
  110993. * This is reserved for the inspector.
  110994. * Specify from where on screen the debug mode should start.
  110995. * The value goes from -1 (full screen) to 1 (not visible)
  110996. * It helps with side by side comparison against the final render
  110997. * This defaults to -1
  110998. */
  110999. private debugLimit;
  111000. /**
  111001. * @hidden
  111002. * This is reserved for the inspector.
  111003. * As the default viewing range might not be enough (if the ambient is really small for instance)
  111004. * You can use the factor to better multiply the final value.
  111005. */
  111006. private debugFactor;
  111007. /**
  111008. * Defines the clear coat layer parameters for the material.
  111009. */
  111010. readonly clearCoat: PBRClearCoatConfiguration;
  111011. /**
  111012. * Defines the anisotropic parameters for the material.
  111013. */
  111014. readonly anisotropy: PBRAnisotropicConfiguration;
  111015. /**
  111016. * Defines the BRDF parameters for the material.
  111017. */
  111018. readonly brdf: PBRBRDFConfiguration;
  111019. /**
  111020. * Defines the Sheen parameters for the material.
  111021. */
  111022. readonly sheen: PBRSheenConfiguration;
  111023. /**
  111024. * Defines the SubSurface parameters for the material.
  111025. */
  111026. readonly subSurface: PBRSubSurfaceConfiguration;
  111027. /**
  111028. * Custom callback helping to override the default shader used in the material.
  111029. */
  111030. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  111031. /**
  111032. * Instantiates a new PBRMaterial instance.
  111033. *
  111034. * @param name The material name
  111035. * @param scene The scene the material will be use in.
  111036. */
  111037. constructor(name: string, scene: Scene);
  111038. /**
  111039. * Gets a boolean indicating that current material needs to register RTT
  111040. */
  111041. readonly hasRenderTargetTextures: boolean;
  111042. /**
  111043. * Gets the name of the material class.
  111044. */
  111045. getClassName(): string;
  111046. /**
  111047. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  111048. */
  111049. /**
  111050. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  111051. */
  111052. useLogarithmicDepth: boolean;
  111053. /**
  111054. * Gets the current transparency mode.
  111055. */
  111056. /**
  111057. * Sets the transparency mode of the material.
  111058. *
  111059. * | Value | Type | Description |
  111060. * | ----- | ----------------------------------- | ----------- |
  111061. * | 0 | OPAQUE | |
  111062. * | 1 | ALPHATEST | |
  111063. * | 2 | ALPHABLEND | |
  111064. * | 3 | ALPHATESTANDBLEND | |
  111065. *
  111066. */
  111067. transparencyMode: Nullable<number>;
  111068. /**
  111069. * Returns true if alpha blending should be disabled.
  111070. */
  111071. private readonly _disableAlphaBlending;
  111072. /**
  111073. * Specifies whether or not this material should be rendered in alpha blend mode.
  111074. */
  111075. needAlphaBlending(): boolean;
  111076. /**
  111077. * Specifies if the mesh will require alpha blending.
  111078. * @param mesh - BJS mesh.
  111079. */
  111080. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  111081. /**
  111082. * Specifies whether or not this material should be rendered in alpha test mode.
  111083. */
  111084. needAlphaTesting(): boolean;
  111085. /**
  111086. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  111087. */
  111088. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  111089. /**
  111090. * Gets the texture used for the alpha test.
  111091. */
  111092. getAlphaTestTexture(): Nullable<BaseTexture>;
  111093. /**
  111094. * Specifies that the submesh is ready to be used.
  111095. * @param mesh - BJS mesh.
  111096. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  111097. * @param useInstances - Specifies that instances should be used.
  111098. * @returns - boolean indicating that the submesh is ready or not.
  111099. */
  111100. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  111101. /**
  111102. * Specifies if the material uses metallic roughness workflow.
  111103. * @returns boolean specifiying if the material uses metallic roughness workflow.
  111104. */
  111105. isMetallicWorkflow(): boolean;
  111106. private _prepareEffect;
  111107. private _prepareDefines;
  111108. /**
  111109. * Force shader compilation
  111110. */
  111111. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<{
  111112. clipPlane: boolean;
  111113. }>): void;
  111114. /**
  111115. * Initializes the uniform buffer layout for the shader.
  111116. */
  111117. buildUniformLayout(): void;
  111118. /**
  111119. * Unbinds the material from the mesh
  111120. */
  111121. unbind(): void;
  111122. /**
  111123. * Binds the submesh data.
  111124. * @param world - The world matrix.
  111125. * @param mesh - The BJS mesh.
  111126. * @param subMesh - A submesh of the BJS mesh.
  111127. */
  111128. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  111129. /**
  111130. * Returns the animatable textures.
  111131. * @returns - Array of animatable textures.
  111132. */
  111133. getAnimatables(): IAnimatable[];
  111134. /**
  111135. * Returns the texture used for reflections.
  111136. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  111137. */
  111138. private _getReflectionTexture;
  111139. /**
  111140. * Returns an array of the actively used textures.
  111141. * @returns - Array of BaseTextures
  111142. */
  111143. getActiveTextures(): BaseTexture[];
  111144. /**
  111145. * Checks to see if a texture is used in the material.
  111146. * @param texture - Base texture to use.
  111147. * @returns - Boolean specifying if a texture is used in the material.
  111148. */
  111149. hasTexture(texture: BaseTexture): boolean;
  111150. /**
  111151. * Disposes the resources of the material.
  111152. * @param forceDisposeEffect - Forces the disposal of effects.
  111153. * @param forceDisposeTextures - Forces the disposal of all textures.
  111154. */
  111155. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  111156. }
  111157. }
  111158. declare module BABYLON {
  111159. /**
  111160. * The Physically based material of BJS.
  111161. *
  111162. * This offers the main features of a standard PBR material.
  111163. * For more information, please refer to the documentation :
  111164. * https://doc.babylonjs.com/how_to/physically_based_rendering
  111165. */
  111166. export class PBRMaterial extends PBRBaseMaterial {
  111167. /**
  111168. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  111169. */
  111170. static readonly PBRMATERIAL_OPAQUE: number;
  111171. /**
  111172. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  111173. */
  111174. static readonly PBRMATERIAL_ALPHATEST: number;
  111175. /**
  111176. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  111177. */
  111178. static readonly PBRMATERIAL_ALPHABLEND: number;
  111179. /**
  111180. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  111181. * They are also discarded below the alpha cutoff threshold to improve performances.
  111182. */
  111183. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  111184. /**
  111185. * Defines the default value of how much AO map is occluding the analytical lights
  111186. * (point spot...).
  111187. */
  111188. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  111189. /**
  111190. * Intensity of the direct lights e.g. the four lights available in your scene.
  111191. * This impacts both the direct diffuse and specular highlights.
  111192. */
  111193. directIntensity: number;
  111194. /**
  111195. * Intensity of the emissive part of the material.
  111196. * This helps controlling the emissive effect without modifying the emissive color.
  111197. */
  111198. emissiveIntensity: number;
  111199. /**
  111200. * Intensity of the environment e.g. how much the environment will light the object
  111201. * either through harmonics for rough material or through the refelction for shiny ones.
  111202. */
  111203. environmentIntensity: number;
  111204. /**
  111205. * This is a special control allowing the reduction of the specular highlights coming from the
  111206. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  111207. */
  111208. specularIntensity: number;
  111209. /**
  111210. * Debug Control allowing disabling the bump map on this material.
  111211. */
  111212. disableBumpMap: boolean;
  111213. /**
  111214. * AKA Diffuse Texture in standard nomenclature.
  111215. */
  111216. albedoTexture: BaseTexture;
  111217. /**
  111218. * AKA Occlusion Texture in other nomenclature.
  111219. */
  111220. ambientTexture: BaseTexture;
  111221. /**
  111222. * AKA Occlusion Texture Intensity in other nomenclature.
  111223. */
  111224. ambientTextureStrength: number;
  111225. /**
  111226. * Defines how much the AO map is occluding the analytical lights (point spot...).
  111227. * 1 means it completely occludes it
  111228. * 0 mean it has no impact
  111229. */
  111230. ambientTextureImpactOnAnalyticalLights: number;
  111231. /**
  111232. * Stores the alpha values in a texture.
  111233. */
  111234. opacityTexture: BaseTexture;
  111235. /**
  111236. * Stores the reflection values in a texture.
  111237. */
  111238. reflectionTexture: Nullable<BaseTexture>;
  111239. /**
  111240. * Stores the emissive values in a texture.
  111241. */
  111242. emissiveTexture: BaseTexture;
  111243. /**
  111244. * AKA Specular texture in other nomenclature.
  111245. */
  111246. reflectivityTexture: BaseTexture;
  111247. /**
  111248. * Used to switch from specular/glossiness to metallic/roughness workflow.
  111249. */
  111250. metallicTexture: BaseTexture;
  111251. /**
  111252. * Specifies the metallic scalar of the metallic/roughness workflow.
  111253. * Can also be used to scale the metalness values of the metallic texture.
  111254. */
  111255. metallic: Nullable<number>;
  111256. /**
  111257. * Specifies the roughness scalar of the metallic/roughness workflow.
  111258. * Can also be used to scale the roughness values of the metallic texture.
  111259. */
  111260. roughness: Nullable<number>;
  111261. /**
  111262. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  111263. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  111264. */
  111265. microSurfaceTexture: BaseTexture;
  111266. /**
  111267. * Stores surface normal data used to displace a mesh in a texture.
  111268. */
  111269. bumpTexture: BaseTexture;
  111270. /**
  111271. * Stores the pre-calculated light information of a mesh in a texture.
  111272. */
  111273. lightmapTexture: BaseTexture;
  111274. /**
  111275. * Stores the refracted light information in a texture.
  111276. */
  111277. refractionTexture: Nullable<BaseTexture>;
  111278. /**
  111279. * The color of a material in ambient lighting.
  111280. */
  111281. ambientColor: Color3;
  111282. /**
  111283. * AKA Diffuse Color in other nomenclature.
  111284. */
  111285. albedoColor: Color3;
  111286. /**
  111287. * AKA Specular Color in other nomenclature.
  111288. */
  111289. reflectivityColor: Color3;
  111290. /**
  111291. * The color reflected from the material.
  111292. */
  111293. reflectionColor: Color3;
  111294. /**
  111295. * The color emitted from the material.
  111296. */
  111297. emissiveColor: Color3;
  111298. /**
  111299. * AKA Glossiness in other nomenclature.
  111300. */
  111301. microSurface: number;
  111302. /**
  111303. * source material index of refraction (IOR)' / 'destination material IOR.
  111304. */
  111305. indexOfRefraction: number;
  111306. /**
  111307. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  111308. */
  111309. invertRefractionY: boolean;
  111310. /**
  111311. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  111312. * Materials half opaque for instance using refraction could benefit from this control.
  111313. */
  111314. linkRefractionWithTransparency: boolean;
  111315. /**
  111316. * If true, the light map contains occlusion information instead of lighting info.
  111317. */
  111318. useLightmapAsShadowmap: boolean;
  111319. /**
  111320. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  111321. */
  111322. useAlphaFromAlbedoTexture: boolean;
  111323. /**
  111324. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  111325. */
  111326. forceAlphaTest: boolean;
  111327. /**
  111328. * Defines the alpha limits in alpha test mode.
  111329. */
  111330. alphaCutOff: number;
  111331. /**
  111332. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  111333. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  111334. */
  111335. useSpecularOverAlpha: boolean;
  111336. /**
  111337. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  111338. */
  111339. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  111340. /**
  111341. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  111342. */
  111343. useRoughnessFromMetallicTextureAlpha: boolean;
  111344. /**
  111345. * Specifies if the metallic texture contains the roughness information in its green channel.
  111346. */
  111347. useRoughnessFromMetallicTextureGreen: boolean;
  111348. /**
  111349. * Specifies if the metallic texture contains the metallness information in its blue channel.
  111350. */
  111351. useMetallnessFromMetallicTextureBlue: boolean;
  111352. /**
  111353. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  111354. */
  111355. useAmbientOcclusionFromMetallicTextureRed: boolean;
  111356. /**
  111357. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  111358. */
  111359. useAmbientInGrayScale: boolean;
  111360. /**
  111361. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  111362. * The material will try to infer what glossiness each pixel should be.
  111363. */
  111364. useAutoMicroSurfaceFromReflectivityMap: boolean;
  111365. /**
  111366. * BJS is using an harcoded light falloff based on a manually sets up range.
  111367. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  111368. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  111369. */
  111370. /**
  111371. * BJS is using an harcoded light falloff based on a manually sets up range.
  111372. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  111373. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  111374. */
  111375. usePhysicalLightFalloff: boolean;
  111376. /**
  111377. * In order to support the falloff compatibility with gltf, a special mode has been added
  111378. * to reproduce the gltf light falloff.
  111379. */
  111380. /**
  111381. * In order to support the falloff compatibility with gltf, a special mode has been added
  111382. * to reproduce the gltf light falloff.
  111383. */
  111384. useGLTFLightFalloff: boolean;
  111385. /**
  111386. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  111387. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  111388. */
  111389. useRadianceOverAlpha: boolean;
  111390. /**
  111391. * Allows using an object space normal map (instead of tangent space).
  111392. */
  111393. useObjectSpaceNormalMap: boolean;
  111394. /**
  111395. * Allows using the bump map in parallax mode.
  111396. */
  111397. useParallax: boolean;
  111398. /**
  111399. * Allows using the bump map in parallax occlusion mode.
  111400. */
  111401. useParallaxOcclusion: boolean;
  111402. /**
  111403. * Controls the scale bias of the parallax mode.
  111404. */
  111405. parallaxScaleBias: number;
  111406. /**
  111407. * If sets to true, disables all the lights affecting the material.
  111408. */
  111409. disableLighting: boolean;
  111410. /**
  111411. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  111412. */
  111413. forceIrradianceInFragment: boolean;
  111414. /**
  111415. * Number of Simultaneous lights allowed on the material.
  111416. */
  111417. maxSimultaneousLights: number;
  111418. /**
  111419. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  111420. */
  111421. invertNormalMapX: boolean;
  111422. /**
  111423. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  111424. */
  111425. invertNormalMapY: boolean;
  111426. /**
  111427. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  111428. */
  111429. twoSidedLighting: boolean;
  111430. /**
  111431. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  111432. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  111433. */
  111434. useAlphaFresnel: boolean;
  111435. /**
  111436. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  111437. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  111438. */
  111439. useLinearAlphaFresnel: boolean;
  111440. /**
  111441. * Let user defines the brdf lookup texture used for IBL.
  111442. * A default 8bit version is embedded but you could point at :
  111443. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  111444. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  111445. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  111446. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  111447. */
  111448. environmentBRDFTexture: Nullable<BaseTexture>;
  111449. /**
  111450. * Force normal to face away from face.
  111451. */
  111452. forceNormalForward: boolean;
  111453. /**
  111454. * Enables specular anti aliasing in the PBR shader.
  111455. * It will both interacts on the Geometry for analytical and IBL lighting.
  111456. * It also prefilter the roughness map based on the bump values.
  111457. */
  111458. enableSpecularAntiAliasing: boolean;
  111459. /**
  111460. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  111461. * makes the reflect vector face the model (under horizon).
  111462. */
  111463. useHorizonOcclusion: boolean;
  111464. /**
  111465. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  111466. * too much the area relying on ambient texture to define their ambient occlusion.
  111467. */
  111468. useRadianceOcclusion: boolean;
  111469. /**
  111470. * If set to true, no lighting calculations will be applied.
  111471. */
  111472. unlit: boolean;
  111473. /**
  111474. * Gets the image processing configuration used either in this material.
  111475. */
  111476. /**
  111477. * Sets the Default image processing configuration used either in the this material.
  111478. *
  111479. * If sets to null, the scene one is in use.
  111480. */
  111481. imageProcessingConfiguration: ImageProcessingConfiguration;
  111482. /**
  111483. * Gets wether the color curves effect is enabled.
  111484. */
  111485. /**
  111486. * Sets wether the color curves effect is enabled.
  111487. */
  111488. cameraColorCurvesEnabled: boolean;
  111489. /**
  111490. * Gets wether the color grading effect is enabled.
  111491. */
  111492. /**
  111493. * Gets wether the color grading effect is enabled.
  111494. */
  111495. cameraColorGradingEnabled: boolean;
  111496. /**
  111497. * Gets wether tonemapping is enabled or not.
  111498. */
  111499. /**
  111500. * Sets wether tonemapping is enabled or not
  111501. */
  111502. cameraToneMappingEnabled: boolean;
  111503. /**
  111504. * The camera exposure used on this material.
  111505. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  111506. * This corresponds to a photographic exposure.
  111507. */
  111508. /**
  111509. * The camera exposure used on this material.
  111510. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  111511. * This corresponds to a photographic exposure.
  111512. */
  111513. cameraExposure: number;
  111514. /**
  111515. * Gets The camera contrast used on this material.
  111516. */
  111517. /**
  111518. * Sets The camera contrast used on this material.
  111519. */
  111520. cameraContrast: number;
  111521. /**
  111522. * Gets the Color Grading 2D Lookup Texture.
  111523. */
  111524. /**
  111525. * Sets the Color Grading 2D Lookup Texture.
  111526. */
  111527. cameraColorGradingTexture: Nullable<BaseTexture>;
  111528. /**
  111529. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111530. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111531. * 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;
  111532. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111533. */
  111534. /**
  111535. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111536. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111537. * 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;
  111538. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111539. */
  111540. cameraColorCurves: Nullable<ColorCurves>;
  111541. /**
  111542. * Instantiates a new PBRMaterial instance.
  111543. *
  111544. * @param name The material name
  111545. * @param scene The scene the material will be use in.
  111546. */
  111547. constructor(name: string, scene: Scene);
  111548. /**
  111549. * Returns the name of this material class.
  111550. */
  111551. getClassName(): string;
  111552. /**
  111553. * Makes a duplicate of the current material.
  111554. * @param name - name to use for the new material.
  111555. */
  111556. clone(name: string): PBRMaterial;
  111557. /**
  111558. * Serializes this PBR Material.
  111559. * @returns - An object with the serialized material.
  111560. */
  111561. serialize(): any;
  111562. /**
  111563. * Parses a PBR Material from a serialized object.
  111564. * @param source - Serialized object.
  111565. * @param scene - BJS scene instance.
  111566. * @param rootUrl - url for the scene object
  111567. * @returns - PBRMaterial
  111568. */
  111569. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  111570. }
  111571. }
  111572. declare module BABYLON {
  111573. /**
  111574. * Direct draw surface info
  111575. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  111576. */
  111577. export interface DDSInfo {
  111578. /**
  111579. * Width of the texture
  111580. */
  111581. width: number;
  111582. /**
  111583. * Width of the texture
  111584. */
  111585. height: number;
  111586. /**
  111587. * Number of Mipmaps for the texture
  111588. * @see https://en.wikipedia.org/wiki/Mipmap
  111589. */
  111590. mipmapCount: number;
  111591. /**
  111592. * If the textures format is a known fourCC format
  111593. * @see https://www.fourcc.org/
  111594. */
  111595. isFourCC: boolean;
  111596. /**
  111597. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  111598. */
  111599. isRGB: boolean;
  111600. /**
  111601. * If the texture is a lumincance format
  111602. */
  111603. isLuminance: boolean;
  111604. /**
  111605. * If this is a cube texture
  111606. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  111607. */
  111608. isCube: boolean;
  111609. /**
  111610. * If the texture is a compressed format eg. FOURCC_DXT1
  111611. */
  111612. isCompressed: boolean;
  111613. /**
  111614. * The dxgiFormat of the texture
  111615. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  111616. */
  111617. dxgiFormat: number;
  111618. /**
  111619. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  111620. */
  111621. textureType: number;
  111622. /**
  111623. * Sphericle polynomial created for the dds texture
  111624. */
  111625. sphericalPolynomial?: SphericalPolynomial;
  111626. }
  111627. /**
  111628. * Class used to provide DDS decompression tools
  111629. */
  111630. export class DDSTools {
  111631. /**
  111632. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  111633. */
  111634. static StoreLODInAlphaChannel: boolean;
  111635. /**
  111636. * Gets DDS information from an array buffer
  111637. * @param arrayBuffer defines the array buffer to read data from
  111638. * @returns the DDS information
  111639. */
  111640. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  111641. private static _FloatView;
  111642. private static _Int32View;
  111643. private static _ToHalfFloat;
  111644. private static _FromHalfFloat;
  111645. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  111646. private static _GetHalfFloatRGBAArrayBuffer;
  111647. private static _GetFloatRGBAArrayBuffer;
  111648. private static _GetFloatAsUIntRGBAArrayBuffer;
  111649. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  111650. private static _GetRGBAArrayBuffer;
  111651. private static _ExtractLongWordOrder;
  111652. private static _GetRGBArrayBuffer;
  111653. private static _GetLuminanceArrayBuffer;
  111654. /**
  111655. * Uploads DDS Levels to a Babylon Texture
  111656. * @hidden
  111657. */
  111658. static UploadDDSLevels(engine: Engine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  111659. }
  111660. interface Engine {
  111661. /**
  111662. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  111663. * @param rootUrl defines the url where the file to load is located
  111664. * @param scene defines the current scene
  111665. * @param lodScale defines scale to apply to the mip map selection
  111666. * @param lodOffset defines offset to apply to the mip map selection
  111667. * @param onLoad defines an optional callback raised when the texture is loaded
  111668. * @param onError defines an optional callback raised if there is an issue to load the texture
  111669. * @param format defines the format of the data
  111670. * @param forcedExtension defines the extension to use to pick the right loader
  111671. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  111672. * @returns the cube texture as an InternalTexture
  111673. */
  111674. 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;
  111675. }
  111676. }
  111677. declare module BABYLON {
  111678. /**
  111679. * Implementation of the DDS Texture Loader.
  111680. * @hidden
  111681. */
  111682. export class _DDSTextureLoader implements IInternalTextureLoader {
  111683. /**
  111684. * Defines wether the loader supports cascade loading the different faces.
  111685. */
  111686. readonly supportCascades: boolean;
  111687. /**
  111688. * This returns if the loader support the current file information.
  111689. * @param extension defines the file extension of the file being loaded
  111690. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111691. * @param fallback defines the fallback internal texture if any
  111692. * @param isBase64 defines whether the texture is encoded as a base64
  111693. * @param isBuffer defines whether the texture data are stored as a buffer
  111694. * @returns true if the loader can load the specified file
  111695. */
  111696. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  111697. /**
  111698. * Transform the url before loading if required.
  111699. * @param rootUrl the url of the texture
  111700. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111701. * @returns the transformed texture
  111702. */
  111703. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  111704. /**
  111705. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  111706. * @param rootUrl the url of the texture
  111707. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111708. * @returns the fallback texture
  111709. */
  111710. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  111711. /**
  111712. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  111713. * @param data contains the texture data
  111714. * @param texture defines the BabylonJS internal texture
  111715. * @param createPolynomials will be true if polynomials have been requested
  111716. * @param onLoad defines the callback to trigger once the texture is ready
  111717. * @param onError defines the callback to trigger in case of error
  111718. */
  111719. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  111720. /**
  111721. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  111722. * @param data contains the texture data
  111723. * @param texture defines the BabylonJS internal texture
  111724. * @param callback defines the method to call once ready to upload
  111725. */
  111726. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  111727. }
  111728. }
  111729. declare module BABYLON {
  111730. /** @hidden */
  111731. export var rgbdEncodePixelShader: {
  111732. name: string;
  111733. shader: string;
  111734. };
  111735. }
  111736. declare module BABYLON {
  111737. /**
  111738. * Raw texture data and descriptor sufficient for WebGL texture upload
  111739. */
  111740. export interface EnvironmentTextureInfo {
  111741. /**
  111742. * Version of the environment map
  111743. */
  111744. version: number;
  111745. /**
  111746. * Width of image
  111747. */
  111748. width: number;
  111749. /**
  111750. * Irradiance information stored in the file.
  111751. */
  111752. irradiance: any;
  111753. /**
  111754. * Specular information stored in the file.
  111755. */
  111756. specular: any;
  111757. }
  111758. /**
  111759. * Sets of helpers addressing the serialization and deserialization of environment texture
  111760. * stored in a BabylonJS env file.
  111761. * Those files are usually stored as .env files.
  111762. */
  111763. export class EnvironmentTextureTools {
  111764. /**
  111765. * Magic number identifying the env file.
  111766. */
  111767. private static _MagicBytes;
  111768. /**
  111769. * Gets the environment info from an env file.
  111770. * @param data The array buffer containing the .env bytes.
  111771. * @returns the environment file info (the json header) if successfully parsed.
  111772. */
  111773. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  111774. /**
  111775. * Creates an environment texture from a loaded cube texture.
  111776. * @param texture defines the cube texture to convert in env file
  111777. * @return a promise containing the environment data if succesfull.
  111778. */
  111779. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  111780. /**
  111781. * Creates a JSON representation of the spherical data.
  111782. * @param texture defines the texture containing the polynomials
  111783. * @return the JSON representation of the spherical info
  111784. */
  111785. private static _CreateEnvTextureIrradiance;
  111786. /**
  111787. * Uploads the texture info contained in the env file to the GPU.
  111788. * @param texture defines the internal texture to upload to
  111789. * @param arrayBuffer defines the buffer cotaining the data to load
  111790. * @param info defines the texture info retrieved through the GetEnvInfo method
  111791. * @returns a promise
  111792. */
  111793. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  111794. /**
  111795. * Uploads the levels of image data to the GPU.
  111796. * @param texture defines the internal texture to upload to
  111797. * @param imageData defines the array buffer views of image data [mipmap][face]
  111798. * @returns a promise
  111799. */
  111800. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  111801. /**
  111802. * Uploads spherical polynomials information to the texture.
  111803. * @param texture defines the texture we are trying to upload the information to
  111804. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  111805. */
  111806. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  111807. /** @hidden */
  111808. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  111809. }
  111810. }
  111811. declare module BABYLON {
  111812. /**
  111813. * Implementation of the ENV Texture Loader.
  111814. * @hidden
  111815. */
  111816. export class _ENVTextureLoader implements IInternalTextureLoader {
  111817. /**
  111818. * Defines wether the loader supports cascade loading the different faces.
  111819. */
  111820. readonly supportCascades: boolean;
  111821. /**
  111822. * This returns if the loader support the current file information.
  111823. * @param extension defines the file extension of the file being loaded
  111824. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111825. * @param fallback defines the fallback internal texture if any
  111826. * @param isBase64 defines whether the texture is encoded as a base64
  111827. * @param isBuffer defines whether the texture data are stored as a buffer
  111828. * @returns true if the loader can load the specified file
  111829. */
  111830. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  111831. /**
  111832. * Transform the url before loading if required.
  111833. * @param rootUrl the url of the texture
  111834. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111835. * @returns the transformed texture
  111836. */
  111837. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  111838. /**
  111839. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  111840. * @param rootUrl the url of the texture
  111841. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111842. * @returns the fallback texture
  111843. */
  111844. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  111845. /**
  111846. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  111847. * @param data contains the texture data
  111848. * @param texture defines the BabylonJS internal texture
  111849. * @param createPolynomials will be true if polynomials have been requested
  111850. * @param onLoad defines the callback to trigger once the texture is ready
  111851. * @param onError defines the callback to trigger in case of error
  111852. */
  111853. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  111854. /**
  111855. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  111856. * @param data contains the texture data
  111857. * @param texture defines the BabylonJS internal texture
  111858. * @param callback defines the method to call once ready to upload
  111859. */
  111860. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  111861. }
  111862. }
  111863. declare module BABYLON {
  111864. /**
  111865. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  111866. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  111867. */
  111868. export class KhronosTextureContainer {
  111869. /** contents of the KTX container file */
  111870. arrayBuffer: any;
  111871. private static HEADER_LEN;
  111872. private static COMPRESSED_2D;
  111873. private static COMPRESSED_3D;
  111874. private static TEX_2D;
  111875. private static TEX_3D;
  111876. /**
  111877. * Gets the openGL type
  111878. */
  111879. glType: number;
  111880. /**
  111881. * Gets the openGL type size
  111882. */
  111883. glTypeSize: number;
  111884. /**
  111885. * Gets the openGL format
  111886. */
  111887. glFormat: number;
  111888. /**
  111889. * Gets the openGL internal format
  111890. */
  111891. glInternalFormat: number;
  111892. /**
  111893. * Gets the base internal format
  111894. */
  111895. glBaseInternalFormat: number;
  111896. /**
  111897. * Gets image width in pixel
  111898. */
  111899. pixelWidth: number;
  111900. /**
  111901. * Gets image height in pixel
  111902. */
  111903. pixelHeight: number;
  111904. /**
  111905. * Gets image depth in pixels
  111906. */
  111907. pixelDepth: number;
  111908. /**
  111909. * Gets the number of array elements
  111910. */
  111911. numberOfArrayElements: number;
  111912. /**
  111913. * Gets the number of faces
  111914. */
  111915. numberOfFaces: number;
  111916. /**
  111917. * Gets the number of mipmap levels
  111918. */
  111919. numberOfMipmapLevels: number;
  111920. /**
  111921. * Gets the bytes of key value data
  111922. */
  111923. bytesOfKeyValueData: number;
  111924. /**
  111925. * Gets the load type
  111926. */
  111927. loadType: number;
  111928. /**
  111929. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  111930. */
  111931. isInvalid: boolean;
  111932. /**
  111933. * Creates a new KhronosTextureContainer
  111934. * @param arrayBuffer contents of the KTX container file
  111935. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  111936. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  111937. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  111938. */
  111939. constructor(
  111940. /** contents of the KTX container file */
  111941. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  111942. /**
  111943. * Uploads KTX content to a Babylon Texture.
  111944. * It is assumed that the texture has already been created & is currently bound
  111945. * @hidden
  111946. */
  111947. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  111948. private _upload2DCompressedLevels;
  111949. }
  111950. }
  111951. declare module BABYLON {
  111952. /**
  111953. * Implementation of the KTX Texture Loader.
  111954. * @hidden
  111955. */
  111956. export class _KTXTextureLoader implements IInternalTextureLoader {
  111957. /**
  111958. * Defines wether the loader supports cascade loading the different faces.
  111959. */
  111960. readonly supportCascades: boolean;
  111961. /**
  111962. * This returns if the loader support the current file information.
  111963. * @param extension defines the file extension of the file being loaded
  111964. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111965. * @param fallback defines the fallback internal texture if any
  111966. * @param isBase64 defines whether the texture is encoded as a base64
  111967. * @param isBuffer defines whether the texture data are stored as a buffer
  111968. * @returns true if the loader can load the specified file
  111969. */
  111970. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  111971. /**
  111972. * Transform the url before loading if required.
  111973. * @param rootUrl the url of the texture
  111974. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111975. * @returns the transformed texture
  111976. */
  111977. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  111978. /**
  111979. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  111980. * @param rootUrl the url of the texture
  111981. * @param textureFormatInUse defines the current compressed format in use iun the engine
  111982. * @returns the fallback texture
  111983. */
  111984. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  111985. /**
  111986. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  111987. * @param data contains the texture data
  111988. * @param texture defines the BabylonJS internal texture
  111989. * @param createPolynomials will be true if polynomials have been requested
  111990. * @param onLoad defines the callback to trigger once the texture is ready
  111991. * @param onError defines the callback to trigger in case of error
  111992. */
  111993. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  111994. /**
  111995. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  111996. * @param data contains the texture data
  111997. * @param texture defines the BabylonJS internal texture
  111998. * @param callback defines the method to call once ready to upload
  111999. */
  112000. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  112001. }
  112002. }
  112003. declare module BABYLON {
  112004. /**
  112005. * Options for the default xr helper
  112006. */
  112007. export class WebXRDefaultExperienceOptions {
  112008. /**
  112009. * Floor meshes that should be used for teleporting
  112010. */
  112011. floorMeshes: Array<AbstractMesh>;
  112012. }
  112013. /**
  112014. * Default experience which provides a similar setup to the previous webVRExperience
  112015. */
  112016. export class WebXRDefaultExperience {
  112017. /**
  112018. * Base experience
  112019. */
  112020. baseExperience: WebXRExperienceHelper;
  112021. /**
  112022. * Input experience extension
  112023. */
  112024. input: WebXRInput;
  112025. /**
  112026. * Loads the controller models
  112027. */
  112028. controllerModelLoader: WebXRControllerModelLoader;
  112029. /**
  112030. * Enables laser pointer and selection
  112031. */
  112032. pointerSelection: WebXRControllerPointerSelection;
  112033. /**
  112034. * Enables teleportation
  112035. */
  112036. teleportation: WebXRControllerTeleportation;
  112037. /**
  112038. * Enables ui for enetering/exiting xr
  112039. */
  112040. enterExitUI: WebXREnterExitUI;
  112041. /**
  112042. * Default output canvas xr should render to
  112043. */
  112044. outputCanvas: WebXRManagedOutputCanvas;
  112045. /**
  112046. * Creates the default xr experience
  112047. * @param scene scene
  112048. * @param options options for basic configuration
  112049. * @returns resulting WebXRDefaultExperience
  112050. */
  112051. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  112052. private constructor();
  112053. /**
  112054. * DIsposes of the experience helper
  112055. */
  112056. dispose(): void;
  112057. }
  112058. }
  112059. declare module BABYLON {
  112060. /** @hidden */
  112061. export var _forceSceneHelpersToBundle: boolean;
  112062. interface Scene {
  112063. /**
  112064. * Creates a default light for the scene.
  112065. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  112066. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  112067. */
  112068. createDefaultLight(replace?: boolean): void;
  112069. /**
  112070. * Creates a default camera for the scene.
  112071. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  112072. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  112073. * @param replace has default false, when true replaces the active camera in the scene
  112074. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  112075. */
  112076. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  112077. /**
  112078. * Creates a default camera and a default light.
  112079. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  112080. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  112081. * @param replace has the default false, when true replaces the active camera/light in the scene
  112082. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  112083. */
  112084. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  112085. /**
  112086. * Creates a new sky box
  112087. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  112088. * @param environmentTexture defines the texture to use as environment texture
  112089. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  112090. * @param scale defines the overall scale of the skybox
  112091. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  112092. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  112093. * @returns a new mesh holding the sky box
  112094. */
  112095. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  112096. /**
  112097. * Creates a new environment
  112098. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  112099. * @param options defines the options you can use to configure the environment
  112100. * @returns the new EnvironmentHelper
  112101. */
  112102. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  112103. /**
  112104. * Creates a new VREXperienceHelper
  112105. * @see http://doc.babylonjs.com/how_to/webvr_helper
  112106. * @param webVROptions defines the options used to create the new VREXperienceHelper
  112107. * @returns a new VREXperienceHelper
  112108. */
  112109. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  112110. /**
  112111. * Creates a new WebXRDefaultExperience
  112112. * @see http://doc.babylonjs.com/how_to/webxr
  112113. * @param options experience options
  112114. * @returns a promise for a new WebXRDefaultExperience
  112115. */
  112116. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  112117. }
  112118. }
  112119. declare module BABYLON {
  112120. /**
  112121. * Display a 360 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  112122. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  112123. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  112124. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  112125. */
  112126. export class VideoDome extends TransformNode {
  112127. /**
  112128. * Define the video source as a Monoscopic panoramic 360 video.
  112129. */
  112130. static readonly MODE_MONOSCOPIC: number;
  112131. /**
  112132. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  112133. */
  112134. static readonly MODE_TOPBOTTOM: number;
  112135. /**
  112136. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  112137. */
  112138. static readonly MODE_SIDEBYSIDE: number;
  112139. private _useDirectMapping;
  112140. /**
  112141. * The video texture being displayed on the sphere
  112142. */
  112143. protected _videoTexture: VideoTexture;
  112144. /**
  112145. * Gets the video texture being displayed on the sphere
  112146. */
  112147. readonly videoTexture: VideoTexture;
  112148. /**
  112149. * The skybox material
  112150. */
  112151. protected _material: BackgroundMaterial;
  112152. /**
  112153. * The surface used for the skybox
  112154. */
  112155. protected _mesh: Mesh;
  112156. /**
  112157. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  112158. * Also see the options.resolution property.
  112159. */
  112160. fovMultiplier: number;
  112161. private _videoMode;
  112162. /**
  112163. * Gets or set the current video mode for the video. It can be:
  112164. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  112165. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  112166. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  112167. */
  112168. videoMode: number;
  112169. /**
  112170. * Oberserver used in Stereoscopic VR Mode.
  112171. */
  112172. private _onBeforeCameraRenderObserver;
  112173. /**
  112174. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  112175. * @param name Element's name, child elements will append suffixes for their own names.
  112176. * @param urlsOrVideo defines the url(s) or the video element to use
  112177. * @param options An object containing optional or exposed sub element properties
  112178. */
  112179. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  112180. resolution?: number;
  112181. clickToPlay?: boolean;
  112182. autoPlay?: boolean;
  112183. loop?: boolean;
  112184. size?: number;
  112185. poster?: string;
  112186. faceForward?: boolean;
  112187. useDirectMapping?: boolean;
  112188. }, scene: Scene);
  112189. private _changeVideoMode;
  112190. /**
  112191. * Releases resources associated with this node.
  112192. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112193. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112194. */
  112195. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112196. }
  112197. }
  112198. declare module BABYLON {
  112199. /**
  112200. * This class can be used to get instrumentation data from a Babylon engine
  112201. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  112202. */
  112203. export class EngineInstrumentation implements IDisposable {
  112204. /**
  112205. * Define the instrumented engine.
  112206. */
  112207. engine: Engine;
  112208. private _captureGPUFrameTime;
  112209. private _gpuFrameTimeToken;
  112210. private _gpuFrameTime;
  112211. private _captureShaderCompilationTime;
  112212. private _shaderCompilationTime;
  112213. private _onBeginFrameObserver;
  112214. private _onEndFrameObserver;
  112215. private _onBeforeShaderCompilationObserver;
  112216. private _onAfterShaderCompilationObserver;
  112217. /**
  112218. * Gets the perf counter used for GPU frame time
  112219. */
  112220. readonly gpuFrameTimeCounter: PerfCounter;
  112221. /**
  112222. * Gets the GPU frame time capture status
  112223. */
  112224. /**
  112225. * Enable or disable the GPU frame time capture
  112226. */
  112227. captureGPUFrameTime: boolean;
  112228. /**
  112229. * Gets the perf counter used for shader compilation time
  112230. */
  112231. readonly shaderCompilationTimeCounter: PerfCounter;
  112232. /**
  112233. * Gets the shader compilation time capture status
  112234. */
  112235. /**
  112236. * Enable or disable the shader compilation time capture
  112237. */
  112238. captureShaderCompilationTime: boolean;
  112239. /**
  112240. * Instantiates a new engine instrumentation.
  112241. * This class can be used to get instrumentation data from a Babylon engine
  112242. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  112243. * @param engine Defines the engine to instrument
  112244. */
  112245. constructor(
  112246. /**
  112247. * Define the instrumented engine.
  112248. */
  112249. engine: Engine);
  112250. /**
  112251. * Dispose and release associated resources.
  112252. */
  112253. dispose(): void;
  112254. }
  112255. }
  112256. declare module BABYLON {
  112257. /**
  112258. * This class can be used to get instrumentation data from a Babylon engine
  112259. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  112260. */
  112261. export class SceneInstrumentation implements IDisposable {
  112262. /**
  112263. * Defines the scene to instrument
  112264. */
  112265. scene: Scene;
  112266. private _captureActiveMeshesEvaluationTime;
  112267. private _activeMeshesEvaluationTime;
  112268. private _captureRenderTargetsRenderTime;
  112269. private _renderTargetsRenderTime;
  112270. private _captureFrameTime;
  112271. private _frameTime;
  112272. private _captureRenderTime;
  112273. private _renderTime;
  112274. private _captureInterFrameTime;
  112275. private _interFrameTime;
  112276. private _captureParticlesRenderTime;
  112277. private _particlesRenderTime;
  112278. private _captureSpritesRenderTime;
  112279. private _spritesRenderTime;
  112280. private _capturePhysicsTime;
  112281. private _physicsTime;
  112282. private _captureAnimationsTime;
  112283. private _animationsTime;
  112284. private _captureCameraRenderTime;
  112285. private _cameraRenderTime;
  112286. private _onBeforeActiveMeshesEvaluationObserver;
  112287. private _onAfterActiveMeshesEvaluationObserver;
  112288. private _onBeforeRenderTargetsRenderObserver;
  112289. private _onAfterRenderTargetsRenderObserver;
  112290. private _onAfterRenderObserver;
  112291. private _onBeforeDrawPhaseObserver;
  112292. private _onAfterDrawPhaseObserver;
  112293. private _onBeforeAnimationsObserver;
  112294. private _onBeforeParticlesRenderingObserver;
  112295. private _onAfterParticlesRenderingObserver;
  112296. private _onBeforeSpritesRenderingObserver;
  112297. private _onAfterSpritesRenderingObserver;
  112298. private _onBeforePhysicsObserver;
  112299. private _onAfterPhysicsObserver;
  112300. private _onAfterAnimationsObserver;
  112301. private _onBeforeCameraRenderObserver;
  112302. private _onAfterCameraRenderObserver;
  112303. /**
  112304. * Gets the perf counter used for active meshes evaluation time
  112305. */
  112306. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  112307. /**
  112308. * Gets the active meshes evaluation time capture status
  112309. */
  112310. /**
  112311. * Enable or disable the active meshes evaluation time capture
  112312. */
  112313. captureActiveMeshesEvaluationTime: boolean;
  112314. /**
  112315. * Gets the perf counter used for render targets render time
  112316. */
  112317. readonly renderTargetsRenderTimeCounter: PerfCounter;
  112318. /**
  112319. * Gets the render targets render time capture status
  112320. */
  112321. /**
  112322. * Enable or disable the render targets render time capture
  112323. */
  112324. captureRenderTargetsRenderTime: boolean;
  112325. /**
  112326. * Gets the perf counter used for particles render time
  112327. */
  112328. readonly particlesRenderTimeCounter: PerfCounter;
  112329. /**
  112330. * Gets the particles render time capture status
  112331. */
  112332. /**
  112333. * Enable or disable the particles render time capture
  112334. */
  112335. captureParticlesRenderTime: boolean;
  112336. /**
  112337. * Gets the perf counter used for sprites render time
  112338. */
  112339. readonly spritesRenderTimeCounter: PerfCounter;
  112340. /**
  112341. * Gets the sprites render time capture status
  112342. */
  112343. /**
  112344. * Enable or disable the sprites render time capture
  112345. */
  112346. captureSpritesRenderTime: boolean;
  112347. /**
  112348. * Gets the perf counter used for physics time
  112349. */
  112350. readonly physicsTimeCounter: PerfCounter;
  112351. /**
  112352. * Gets the physics time capture status
  112353. */
  112354. /**
  112355. * Enable or disable the physics time capture
  112356. */
  112357. capturePhysicsTime: boolean;
  112358. /**
  112359. * Gets the perf counter used for animations time
  112360. */
  112361. readonly animationsTimeCounter: PerfCounter;
  112362. /**
  112363. * Gets the animations time capture status
  112364. */
  112365. /**
  112366. * Enable or disable the animations time capture
  112367. */
  112368. captureAnimationsTime: boolean;
  112369. /**
  112370. * Gets the perf counter used for frame time capture
  112371. */
  112372. readonly frameTimeCounter: PerfCounter;
  112373. /**
  112374. * Gets the frame time capture status
  112375. */
  112376. /**
  112377. * Enable or disable the frame time capture
  112378. */
  112379. captureFrameTime: boolean;
  112380. /**
  112381. * Gets the perf counter used for inter-frames time capture
  112382. */
  112383. readonly interFrameTimeCounter: PerfCounter;
  112384. /**
  112385. * Gets the inter-frames time capture status
  112386. */
  112387. /**
  112388. * Enable or disable the inter-frames time capture
  112389. */
  112390. captureInterFrameTime: boolean;
  112391. /**
  112392. * Gets the perf counter used for render time capture
  112393. */
  112394. readonly renderTimeCounter: PerfCounter;
  112395. /**
  112396. * Gets the render time capture status
  112397. */
  112398. /**
  112399. * Enable or disable the render time capture
  112400. */
  112401. captureRenderTime: boolean;
  112402. /**
  112403. * Gets the perf counter used for camera render time capture
  112404. */
  112405. readonly cameraRenderTimeCounter: PerfCounter;
  112406. /**
  112407. * Gets the camera render time capture status
  112408. */
  112409. /**
  112410. * Enable or disable the camera render time capture
  112411. */
  112412. captureCameraRenderTime: boolean;
  112413. /**
  112414. * Gets the perf counter used for draw calls
  112415. */
  112416. readonly drawCallsCounter: PerfCounter;
  112417. /**
  112418. * Instantiates a new scene instrumentation.
  112419. * This class can be used to get instrumentation data from a Babylon engine
  112420. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  112421. * @param scene Defines the scene to instrument
  112422. */
  112423. constructor(
  112424. /**
  112425. * Defines the scene to instrument
  112426. */
  112427. scene: Scene);
  112428. /**
  112429. * Dispose and release associated resources.
  112430. */
  112431. dispose(): void;
  112432. }
  112433. }
  112434. declare module BABYLON {
  112435. /** @hidden */
  112436. export var glowMapGenerationPixelShader: {
  112437. name: string;
  112438. shader: string;
  112439. };
  112440. }
  112441. declare module BABYLON {
  112442. /** @hidden */
  112443. export var glowMapGenerationVertexShader: {
  112444. name: string;
  112445. shader: string;
  112446. };
  112447. }
  112448. declare module BABYLON {
  112449. /**
  112450. * Effect layer options. This helps customizing the behaviour
  112451. * of the effect layer.
  112452. */
  112453. export interface IEffectLayerOptions {
  112454. /**
  112455. * Multiplication factor apply to the canvas size to compute the render target size
  112456. * used to generated the objects (the smaller the faster).
  112457. */
  112458. mainTextureRatio: number;
  112459. /**
  112460. * Enforces a fixed size texture to ensure effect stability across devices.
  112461. */
  112462. mainTextureFixedSize?: number;
  112463. /**
  112464. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  112465. */
  112466. alphaBlendingMode: number;
  112467. /**
  112468. * The camera attached to the layer.
  112469. */
  112470. camera: Nullable<Camera>;
  112471. /**
  112472. * The rendering group to draw the layer in.
  112473. */
  112474. renderingGroupId: number;
  112475. }
  112476. /**
  112477. * The effect layer Helps adding post process effect blended with the main pass.
  112478. *
  112479. * This can be for instance use to generate glow or higlight effects on the scene.
  112480. *
  112481. * The effect layer class can not be used directly and is intented to inherited from to be
  112482. * customized per effects.
  112483. */
  112484. export abstract class EffectLayer {
  112485. private _vertexBuffers;
  112486. private _indexBuffer;
  112487. private _cachedDefines;
  112488. private _effectLayerMapGenerationEffect;
  112489. private _effectLayerOptions;
  112490. private _mergeEffect;
  112491. protected _scene: Scene;
  112492. protected _engine: Engine;
  112493. protected _maxSize: number;
  112494. protected _mainTextureDesiredSize: ISize;
  112495. protected _mainTexture: RenderTargetTexture;
  112496. protected _shouldRender: boolean;
  112497. protected _postProcesses: PostProcess[];
  112498. protected _textures: BaseTexture[];
  112499. protected _emissiveTextureAndColor: {
  112500. texture: Nullable<BaseTexture>;
  112501. color: Color4;
  112502. };
  112503. /**
  112504. * The name of the layer
  112505. */
  112506. name: string;
  112507. /**
  112508. * The clear color of the texture used to generate the glow map.
  112509. */
  112510. neutralColor: Color4;
  112511. /**
  112512. * Specifies wether the highlight layer is enabled or not.
  112513. */
  112514. isEnabled: boolean;
  112515. /**
  112516. * Gets the camera attached to the layer.
  112517. */
  112518. readonly camera: Nullable<Camera>;
  112519. /**
  112520. * Gets the rendering group id the layer should render in.
  112521. */
  112522. renderingGroupId: number;
  112523. /**
  112524. * An event triggered when the effect layer has been disposed.
  112525. */
  112526. onDisposeObservable: Observable<EffectLayer>;
  112527. /**
  112528. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  112529. */
  112530. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  112531. /**
  112532. * An event triggered when the generated texture is being merged in the scene.
  112533. */
  112534. onBeforeComposeObservable: Observable<EffectLayer>;
  112535. /**
  112536. * An event triggered when the generated texture has been merged in the scene.
  112537. */
  112538. onAfterComposeObservable: Observable<EffectLayer>;
  112539. /**
  112540. * An event triggered when the efffect layer changes its size.
  112541. */
  112542. onSizeChangedObservable: Observable<EffectLayer>;
  112543. /** @hidden */
  112544. static _SceneComponentInitialization: (scene: Scene) => void;
  112545. /**
  112546. * Instantiates a new effect Layer and references it in the scene.
  112547. * @param name The name of the layer
  112548. * @param scene The scene to use the layer in
  112549. */
  112550. constructor(
  112551. /** The Friendly of the effect in the scene */
  112552. name: string, scene: Scene);
  112553. /**
  112554. * Get the effect name of the layer.
  112555. * @return The effect name
  112556. */
  112557. abstract getEffectName(): string;
  112558. /**
  112559. * Checks for the readiness of the element composing the layer.
  112560. * @param subMesh the mesh to check for
  112561. * @param useInstances specify wether or not to use instances to render the mesh
  112562. * @return true if ready otherwise, false
  112563. */
  112564. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  112565. /**
  112566. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  112567. * @returns true if the effect requires stencil during the main canvas render pass.
  112568. */
  112569. abstract needStencil(): boolean;
  112570. /**
  112571. * Create the merge effect. This is the shader use to blit the information back
  112572. * to the main canvas at the end of the scene rendering.
  112573. * @returns The effect containing the shader used to merge the effect on the main canvas
  112574. */
  112575. protected abstract _createMergeEffect(): Effect;
  112576. /**
  112577. * Creates the render target textures and post processes used in the effect layer.
  112578. */
  112579. protected abstract _createTextureAndPostProcesses(): void;
  112580. /**
  112581. * Implementation specific of rendering the generating effect on the main canvas.
  112582. * @param effect The effect used to render through
  112583. */
  112584. protected abstract _internalRender(effect: Effect): void;
  112585. /**
  112586. * Sets the required values for both the emissive texture and and the main color.
  112587. */
  112588. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  112589. /**
  112590. * Free any resources and references associated to a mesh.
  112591. * Internal use
  112592. * @param mesh The mesh to free.
  112593. */
  112594. abstract _disposeMesh(mesh: Mesh): void;
  112595. /**
  112596. * Serializes this layer (Glow or Highlight for example)
  112597. * @returns a serialized layer object
  112598. */
  112599. abstract serialize?(): any;
  112600. /**
  112601. * Initializes the effect layer with the required options.
  112602. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  112603. */
  112604. protected _init(options: Partial<IEffectLayerOptions>): void;
  112605. /**
  112606. * Generates the index buffer of the full screen quad blending to the main canvas.
  112607. */
  112608. private _generateIndexBuffer;
  112609. /**
  112610. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  112611. */
  112612. private _generateVertexBuffer;
  112613. /**
  112614. * Sets the main texture desired size which is the closest power of two
  112615. * of the engine canvas size.
  112616. */
  112617. private _setMainTextureSize;
  112618. /**
  112619. * Creates the main texture for the effect layer.
  112620. */
  112621. protected _createMainTexture(): void;
  112622. /**
  112623. * Adds specific effects defines.
  112624. * @param defines The defines to add specifics to.
  112625. */
  112626. protected _addCustomEffectDefines(defines: string[]): void;
  112627. /**
  112628. * Checks for the readiness of the element composing the layer.
  112629. * @param subMesh the mesh to check for
  112630. * @param useInstances specify wether or not to use instances to render the mesh
  112631. * @param emissiveTexture the associated emissive texture used to generate the glow
  112632. * @return true if ready otherwise, false
  112633. */
  112634. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  112635. /**
  112636. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  112637. */
  112638. render(): void;
  112639. /**
  112640. * Determine if a given mesh will be used in the current effect.
  112641. * @param mesh mesh to test
  112642. * @returns true if the mesh will be used
  112643. */
  112644. hasMesh(mesh: AbstractMesh): boolean;
  112645. /**
  112646. * Returns true if the layer contains information to display, otherwise false.
  112647. * @returns true if the glow layer should be rendered
  112648. */
  112649. shouldRender(): boolean;
  112650. /**
  112651. * Returns true if the mesh should render, otherwise false.
  112652. * @param mesh The mesh to render
  112653. * @returns true if it should render otherwise false
  112654. */
  112655. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  112656. /**
  112657. * Returns true if the mesh can be rendered, otherwise false.
  112658. * @param mesh The mesh to render
  112659. * @param material The material used on the mesh
  112660. * @returns true if it can be rendered otherwise false
  112661. */
  112662. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  112663. /**
  112664. * Returns true if the mesh should render, otherwise false.
  112665. * @param mesh The mesh to render
  112666. * @returns true if it should render otherwise false
  112667. */
  112668. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  112669. /**
  112670. * Renders the submesh passed in parameter to the generation map.
  112671. */
  112672. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  112673. /**
  112674. * Rebuild the required buffers.
  112675. * @hidden Internal use only.
  112676. */
  112677. _rebuild(): void;
  112678. /**
  112679. * Dispose only the render target textures and post process.
  112680. */
  112681. private _disposeTextureAndPostProcesses;
  112682. /**
  112683. * Dispose the highlight layer and free resources.
  112684. */
  112685. dispose(): void;
  112686. /**
  112687. * Gets the class name of the effect layer
  112688. * @returns the string with the class name of the effect layer
  112689. */
  112690. getClassName(): string;
  112691. /**
  112692. * Creates an effect layer from parsed effect layer data
  112693. * @param parsedEffectLayer defines effect layer data
  112694. * @param scene defines the current scene
  112695. * @param rootUrl defines the root URL containing the effect layer information
  112696. * @returns a parsed effect Layer
  112697. */
  112698. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  112699. }
  112700. }
  112701. declare module BABYLON {
  112702. interface AbstractScene {
  112703. /**
  112704. * The list of effect layers (highlights/glow) added to the scene
  112705. * @see http://doc.babylonjs.com/how_to/highlight_layer
  112706. * @see http://doc.babylonjs.com/how_to/glow_layer
  112707. */
  112708. effectLayers: Array<EffectLayer>;
  112709. /**
  112710. * Removes the given effect layer from this scene.
  112711. * @param toRemove defines the effect layer to remove
  112712. * @returns the index of the removed effect layer
  112713. */
  112714. removeEffectLayer(toRemove: EffectLayer): number;
  112715. /**
  112716. * Adds the given effect layer to this scene
  112717. * @param newEffectLayer defines the effect layer to add
  112718. */
  112719. addEffectLayer(newEffectLayer: EffectLayer): void;
  112720. }
  112721. /**
  112722. * Defines the layer scene component responsible to manage any effect layers
  112723. * in a given scene.
  112724. */
  112725. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  112726. /**
  112727. * The component name helpfull to identify the component in the list of scene components.
  112728. */
  112729. readonly name: string;
  112730. /**
  112731. * The scene the component belongs to.
  112732. */
  112733. scene: Scene;
  112734. private _engine;
  112735. private _renderEffects;
  112736. private _needStencil;
  112737. private _previousStencilState;
  112738. /**
  112739. * Creates a new instance of the component for the given scene
  112740. * @param scene Defines the scene to register the component in
  112741. */
  112742. constructor(scene: Scene);
  112743. /**
  112744. * Registers the component in a given scene
  112745. */
  112746. register(): void;
  112747. /**
  112748. * Rebuilds the elements related to this component in case of
  112749. * context lost for instance.
  112750. */
  112751. rebuild(): void;
  112752. /**
  112753. * Serializes the component data to the specified json object
  112754. * @param serializationObject The object to serialize to
  112755. */
  112756. serialize(serializationObject: any): void;
  112757. /**
  112758. * Adds all the elements from the container to the scene
  112759. * @param container the container holding the elements
  112760. */
  112761. addFromContainer(container: AbstractScene): void;
  112762. /**
  112763. * Removes all the elements in the container from the scene
  112764. * @param container contains the elements to remove
  112765. * @param dispose if the removed element should be disposed (default: false)
  112766. */
  112767. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  112768. /**
  112769. * Disposes the component and the associated ressources.
  112770. */
  112771. dispose(): void;
  112772. private _isReadyForMesh;
  112773. private _renderMainTexture;
  112774. private _setStencil;
  112775. private _setStencilBack;
  112776. private _draw;
  112777. private _drawCamera;
  112778. private _drawRenderingGroup;
  112779. }
  112780. }
  112781. declare module BABYLON {
  112782. /** @hidden */
  112783. export var glowMapMergePixelShader: {
  112784. name: string;
  112785. shader: string;
  112786. };
  112787. }
  112788. declare module BABYLON {
  112789. /** @hidden */
  112790. export var glowMapMergeVertexShader: {
  112791. name: string;
  112792. shader: string;
  112793. };
  112794. }
  112795. declare module BABYLON {
  112796. interface AbstractScene {
  112797. /**
  112798. * Return a the first highlight layer of the scene with a given name.
  112799. * @param name The name of the highlight layer to look for.
  112800. * @return The highlight layer if found otherwise null.
  112801. */
  112802. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  112803. }
  112804. /**
  112805. * Glow layer options. This helps customizing the behaviour
  112806. * of the glow layer.
  112807. */
  112808. export interface IGlowLayerOptions {
  112809. /**
  112810. * Multiplication factor apply to the canvas size to compute the render target size
  112811. * used to generated the glowing objects (the smaller the faster).
  112812. */
  112813. mainTextureRatio: number;
  112814. /**
  112815. * Enforces a fixed size texture to ensure resize independant blur.
  112816. */
  112817. mainTextureFixedSize?: number;
  112818. /**
  112819. * How big is the kernel of the blur texture.
  112820. */
  112821. blurKernelSize: number;
  112822. /**
  112823. * The camera attached to the layer.
  112824. */
  112825. camera: Nullable<Camera>;
  112826. /**
  112827. * Enable MSAA by chosing the number of samples.
  112828. */
  112829. mainTextureSamples?: number;
  112830. /**
  112831. * The rendering group to draw the layer in.
  112832. */
  112833. renderingGroupId: number;
  112834. }
  112835. /**
  112836. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  112837. *
  112838. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  112839. * glowy meshes to your scene.
  112840. *
  112841. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  112842. */
  112843. export class GlowLayer extends EffectLayer {
  112844. /**
  112845. * Effect Name of the layer.
  112846. */
  112847. static readonly EffectName: string;
  112848. /**
  112849. * The default blur kernel size used for the glow.
  112850. */
  112851. static DefaultBlurKernelSize: number;
  112852. /**
  112853. * The default texture size ratio used for the glow.
  112854. */
  112855. static DefaultTextureRatio: number;
  112856. /**
  112857. * Sets the kernel size of the blur.
  112858. */
  112859. /**
  112860. * Gets the kernel size of the blur.
  112861. */
  112862. blurKernelSize: number;
  112863. /**
  112864. * Sets the glow intensity.
  112865. */
  112866. /**
  112867. * Gets the glow intensity.
  112868. */
  112869. intensity: number;
  112870. private _options;
  112871. private _intensity;
  112872. private _horizontalBlurPostprocess1;
  112873. private _verticalBlurPostprocess1;
  112874. private _horizontalBlurPostprocess2;
  112875. private _verticalBlurPostprocess2;
  112876. private _blurTexture1;
  112877. private _blurTexture2;
  112878. private _postProcesses1;
  112879. private _postProcesses2;
  112880. private _includedOnlyMeshes;
  112881. private _excludedMeshes;
  112882. /**
  112883. * Callback used to let the user override the color selection on a per mesh basis
  112884. */
  112885. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  112886. /**
  112887. * Callback used to let the user override the texture selection on a per mesh basis
  112888. */
  112889. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  112890. /**
  112891. * Instantiates a new glow Layer and references it to the scene.
  112892. * @param name The name of the layer
  112893. * @param scene The scene to use the layer in
  112894. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  112895. */
  112896. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  112897. /**
  112898. * Get the effect name of the layer.
  112899. * @return The effect name
  112900. */
  112901. getEffectName(): string;
  112902. /**
  112903. * Create the merge effect. This is the shader use to blit the information back
  112904. * to the main canvas at the end of the scene rendering.
  112905. */
  112906. protected _createMergeEffect(): Effect;
  112907. /**
  112908. * Creates the render target textures and post processes used in the glow layer.
  112909. */
  112910. protected _createTextureAndPostProcesses(): void;
  112911. /**
  112912. * Checks for the readiness of the element composing the layer.
  112913. * @param subMesh the mesh to check for
  112914. * @param useInstances specify wether or not to use instances to render the mesh
  112915. * @param emissiveTexture the associated emissive texture used to generate the glow
  112916. * @return true if ready otherwise, false
  112917. */
  112918. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  112919. /**
  112920. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  112921. */
  112922. needStencil(): boolean;
  112923. /**
  112924. * Returns true if the mesh can be rendered, otherwise false.
  112925. * @param mesh The mesh to render
  112926. * @param material The material used on the mesh
  112927. * @returns true if it can be rendered otherwise false
  112928. */
  112929. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  112930. /**
  112931. * Implementation specific of rendering the generating effect on the main canvas.
  112932. * @param effect The effect used to render through
  112933. */
  112934. protected _internalRender(effect: Effect): void;
  112935. /**
  112936. * Sets the required values for both the emissive texture and and the main color.
  112937. */
  112938. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  112939. /**
  112940. * Returns true if the mesh should render, otherwise false.
  112941. * @param mesh The mesh to render
  112942. * @returns true if it should render otherwise false
  112943. */
  112944. protected _shouldRenderMesh(mesh: Mesh): boolean;
  112945. /**
  112946. * Adds specific effects defines.
  112947. * @param defines The defines to add specifics to.
  112948. */
  112949. protected _addCustomEffectDefines(defines: string[]): void;
  112950. /**
  112951. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  112952. * @param mesh The mesh to exclude from the glow layer
  112953. */
  112954. addExcludedMesh(mesh: Mesh): void;
  112955. /**
  112956. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  112957. * @param mesh The mesh to remove
  112958. */
  112959. removeExcludedMesh(mesh: Mesh): void;
  112960. /**
  112961. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  112962. * @param mesh The mesh to include in the glow layer
  112963. */
  112964. addIncludedOnlyMesh(mesh: Mesh): void;
  112965. /**
  112966. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  112967. * @param mesh The mesh to remove
  112968. */
  112969. removeIncludedOnlyMesh(mesh: Mesh): void;
  112970. /**
  112971. * Determine if a given mesh will be used in the glow layer
  112972. * @param mesh The mesh to test
  112973. * @returns true if the mesh will be highlighted by the current glow layer
  112974. */
  112975. hasMesh(mesh: AbstractMesh): boolean;
  112976. /**
  112977. * Free any resources and references associated to a mesh.
  112978. * Internal use
  112979. * @param mesh The mesh to free.
  112980. * @hidden
  112981. */
  112982. _disposeMesh(mesh: Mesh): void;
  112983. /**
  112984. * Gets the class name of the effect layer
  112985. * @returns the string with the class name of the effect layer
  112986. */
  112987. getClassName(): string;
  112988. /**
  112989. * Serializes this glow layer
  112990. * @returns a serialized glow layer object
  112991. */
  112992. serialize(): any;
  112993. /**
  112994. * Creates a Glow Layer from parsed glow layer data
  112995. * @param parsedGlowLayer defines glow layer data
  112996. * @param scene defines the current scene
  112997. * @param rootUrl defines the root URL containing the glow layer information
  112998. * @returns a parsed Glow Layer
  112999. */
  113000. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  113001. }
  113002. }
  113003. declare module BABYLON {
  113004. /** @hidden */
  113005. export var glowBlurPostProcessPixelShader: {
  113006. name: string;
  113007. shader: string;
  113008. };
  113009. }
  113010. declare module BABYLON {
  113011. interface AbstractScene {
  113012. /**
  113013. * Return a the first highlight layer of the scene with a given name.
  113014. * @param name The name of the highlight layer to look for.
  113015. * @return The highlight layer if found otherwise null.
  113016. */
  113017. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  113018. }
  113019. /**
  113020. * Highlight layer options. This helps customizing the behaviour
  113021. * of the highlight layer.
  113022. */
  113023. export interface IHighlightLayerOptions {
  113024. /**
  113025. * Multiplication factor apply to the canvas size to compute the render target size
  113026. * used to generated the glowing objects (the smaller the faster).
  113027. */
  113028. mainTextureRatio: number;
  113029. /**
  113030. * Enforces a fixed size texture to ensure resize independant blur.
  113031. */
  113032. mainTextureFixedSize?: number;
  113033. /**
  113034. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  113035. * of the picture to blur (the smaller the faster).
  113036. */
  113037. blurTextureSizeRatio: number;
  113038. /**
  113039. * How big in texel of the blur texture is the vertical blur.
  113040. */
  113041. blurVerticalSize: number;
  113042. /**
  113043. * How big in texel of the blur texture is the horizontal blur.
  113044. */
  113045. blurHorizontalSize: number;
  113046. /**
  113047. * Alpha blending mode used to apply the blur. Default is combine.
  113048. */
  113049. alphaBlendingMode: number;
  113050. /**
  113051. * The camera attached to the layer.
  113052. */
  113053. camera: Nullable<Camera>;
  113054. /**
  113055. * Should we display highlight as a solid stroke?
  113056. */
  113057. isStroke?: boolean;
  113058. /**
  113059. * The rendering group to draw the layer in.
  113060. */
  113061. renderingGroupId: number;
  113062. }
  113063. /**
  113064. * The highlight layer Helps adding a glow effect around a mesh.
  113065. *
  113066. * Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove
  113067. * glowy meshes to your scene.
  113068. *
  113069. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  113070. */
  113071. export class HighlightLayer extends EffectLayer {
  113072. name: string;
  113073. /**
  113074. * Effect Name of the highlight layer.
  113075. */
  113076. static readonly EffectName: string;
  113077. /**
  113078. * The neutral color used during the preparation of the glow effect.
  113079. * This is black by default as the blend operation is a blend operation.
  113080. */
  113081. static NeutralColor: Color4;
  113082. /**
  113083. * Stencil value used for glowing meshes.
  113084. */
  113085. static GlowingMeshStencilReference: number;
  113086. /**
  113087. * Stencil value used for the other meshes in the scene.
  113088. */
  113089. static NormalMeshStencilReference: number;
  113090. /**
  113091. * Specifies whether or not the inner glow is ACTIVE in the layer.
  113092. */
  113093. innerGlow: boolean;
  113094. /**
  113095. * Specifies whether or not the outer glow is ACTIVE in the layer.
  113096. */
  113097. outerGlow: boolean;
  113098. /**
  113099. * Specifies the horizontal size of the blur.
  113100. */
  113101. /**
  113102. * Gets the horizontal size of the blur.
  113103. */
  113104. blurHorizontalSize: number;
  113105. /**
  113106. * Specifies the vertical size of the blur.
  113107. */
  113108. /**
  113109. * Gets the vertical size of the blur.
  113110. */
  113111. blurVerticalSize: number;
  113112. /**
  113113. * An event triggered when the highlight layer is being blurred.
  113114. */
  113115. onBeforeBlurObservable: Observable<HighlightLayer>;
  113116. /**
  113117. * An event triggered when the highlight layer has been blurred.
  113118. */
  113119. onAfterBlurObservable: Observable<HighlightLayer>;
  113120. private _instanceGlowingMeshStencilReference;
  113121. private _options;
  113122. private _downSamplePostprocess;
  113123. private _horizontalBlurPostprocess;
  113124. private _verticalBlurPostprocess;
  113125. private _blurTexture;
  113126. private _meshes;
  113127. private _excludedMeshes;
  113128. /**
  113129. * Instantiates a new highlight Layer and references it to the scene..
  113130. * @param name The name of the layer
  113131. * @param scene The scene to use the layer in
  113132. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  113133. */
  113134. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  113135. /**
  113136. * Get the effect name of the layer.
  113137. * @return The effect name
  113138. */
  113139. getEffectName(): string;
  113140. /**
  113141. * Create the merge effect. This is the shader use to blit the information back
  113142. * to the main canvas at the end of the scene rendering.
  113143. */
  113144. protected _createMergeEffect(): Effect;
  113145. /**
  113146. * Creates the render target textures and post processes used in the highlight layer.
  113147. */
  113148. protected _createTextureAndPostProcesses(): void;
  113149. /**
  113150. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  113151. */
  113152. needStencil(): boolean;
  113153. /**
  113154. * Checks for the readiness of the element composing the layer.
  113155. * @param subMesh the mesh to check for
  113156. * @param useInstances specify wether or not to use instances to render the mesh
  113157. * @param emissiveTexture the associated emissive texture used to generate the glow
  113158. * @return true if ready otherwise, false
  113159. */
  113160. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  113161. /**
  113162. * Implementation specific of rendering the generating effect on the main canvas.
  113163. * @param effect The effect used to render through
  113164. */
  113165. protected _internalRender(effect: Effect): void;
  113166. /**
  113167. * Returns true if the layer contains information to display, otherwise false.
  113168. */
  113169. shouldRender(): boolean;
  113170. /**
  113171. * Returns true if the mesh should render, otherwise false.
  113172. * @param mesh The mesh to render
  113173. * @returns true if it should render otherwise false
  113174. */
  113175. protected _shouldRenderMesh(mesh: Mesh): boolean;
  113176. /**
  113177. * Sets the required values for both the emissive texture and and the main color.
  113178. */
  113179. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  113180. /**
  113181. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  113182. * @param mesh The mesh to exclude from the highlight layer
  113183. */
  113184. addExcludedMesh(mesh: Mesh): void;
  113185. /**
  113186. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  113187. * @param mesh The mesh to highlight
  113188. */
  113189. removeExcludedMesh(mesh: Mesh): void;
  113190. /**
  113191. * Determine if a given mesh will be highlighted by the current HighlightLayer
  113192. * @param mesh mesh to test
  113193. * @returns true if the mesh will be highlighted by the current HighlightLayer
  113194. */
  113195. hasMesh(mesh: AbstractMesh): boolean;
  113196. /**
  113197. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  113198. * @param mesh The mesh to highlight
  113199. * @param color The color of the highlight
  113200. * @param glowEmissiveOnly Extract the glow from the emissive texture
  113201. */
  113202. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  113203. /**
  113204. * Remove a mesh from the highlight layer in order to make it stop glowing.
  113205. * @param mesh The mesh to highlight
  113206. */
  113207. removeMesh(mesh: Mesh): void;
  113208. /**
  113209. * Force the stencil to the normal expected value for none glowing parts
  113210. */
  113211. private _defaultStencilReference;
  113212. /**
  113213. * Free any resources and references associated to a mesh.
  113214. * Internal use
  113215. * @param mesh The mesh to free.
  113216. * @hidden
  113217. */
  113218. _disposeMesh(mesh: Mesh): void;
  113219. /**
  113220. * Dispose the highlight layer and free resources.
  113221. */
  113222. dispose(): void;
  113223. /**
  113224. * Gets the class name of the effect layer
  113225. * @returns the string with the class name of the effect layer
  113226. */
  113227. getClassName(): string;
  113228. /**
  113229. * Serializes this Highlight layer
  113230. * @returns a serialized Highlight layer object
  113231. */
  113232. serialize(): any;
  113233. /**
  113234. * Creates a Highlight layer from parsed Highlight layer data
  113235. * @param parsedHightlightLayer defines the Highlight layer data
  113236. * @param scene defines the current scene
  113237. * @param rootUrl defines the root URL containing the Highlight layer information
  113238. * @returns a parsed Highlight layer
  113239. */
  113240. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  113241. }
  113242. }
  113243. declare module BABYLON {
  113244. interface AbstractScene {
  113245. /**
  113246. * The list of layers (background and foreground) of the scene
  113247. */
  113248. layers: Array<Layer>;
  113249. }
  113250. /**
  113251. * Defines the layer scene component responsible to manage any layers
  113252. * in a given scene.
  113253. */
  113254. export class LayerSceneComponent implements ISceneComponent {
  113255. /**
  113256. * The component name helpfull to identify the component in the list of scene components.
  113257. */
  113258. readonly name: string;
  113259. /**
  113260. * The scene the component belongs to.
  113261. */
  113262. scene: Scene;
  113263. private _engine;
  113264. /**
  113265. * Creates a new instance of the component for the given scene
  113266. * @param scene Defines the scene to register the component in
  113267. */
  113268. constructor(scene: Scene);
  113269. /**
  113270. * Registers the component in a given scene
  113271. */
  113272. register(): void;
  113273. /**
  113274. * Rebuilds the elements related to this component in case of
  113275. * context lost for instance.
  113276. */
  113277. rebuild(): void;
  113278. /**
  113279. * Disposes the component and the associated ressources.
  113280. */
  113281. dispose(): void;
  113282. private _draw;
  113283. private _drawCameraPredicate;
  113284. private _drawCameraBackground;
  113285. private _drawCameraForeground;
  113286. private _drawRenderTargetPredicate;
  113287. private _drawRenderTargetBackground;
  113288. private _drawRenderTargetForeground;
  113289. /**
  113290. * Adds all the elements from the container to the scene
  113291. * @param container the container holding the elements
  113292. */
  113293. addFromContainer(container: AbstractScene): void;
  113294. /**
  113295. * Removes all the elements in the container from the scene
  113296. * @param container contains the elements to remove
  113297. * @param dispose if the removed element should be disposed (default: false)
  113298. */
  113299. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  113300. }
  113301. }
  113302. declare module BABYLON {
  113303. /** @hidden */
  113304. export var layerPixelShader: {
  113305. name: string;
  113306. shader: string;
  113307. };
  113308. }
  113309. declare module BABYLON {
  113310. /** @hidden */
  113311. export var layerVertexShader: {
  113312. name: string;
  113313. shader: string;
  113314. };
  113315. }
  113316. declare module BABYLON {
  113317. /**
  113318. * This represents a full screen 2d layer.
  113319. * This can be useful to display a picture in the background of your scene for instance.
  113320. * @see https://www.babylonjs-playground.com/#08A2BS#1
  113321. */
  113322. export class Layer {
  113323. /**
  113324. * Define the name of the layer.
  113325. */
  113326. name: string;
  113327. /**
  113328. * Define the texture the layer should display.
  113329. */
  113330. texture: Nullable<Texture>;
  113331. /**
  113332. * Is the layer in background or foreground.
  113333. */
  113334. isBackground: boolean;
  113335. /**
  113336. * Define the color of the layer (instead of texture).
  113337. */
  113338. color: Color4;
  113339. /**
  113340. * Define the scale of the layer in order to zoom in out of the texture.
  113341. */
  113342. scale: Vector2;
  113343. /**
  113344. * Define an offset for the layer in order to shift the texture.
  113345. */
  113346. offset: Vector2;
  113347. /**
  113348. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  113349. */
  113350. alphaBlendingMode: number;
  113351. /**
  113352. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  113353. * Alpha test will not mix with the background color in case of transparency.
  113354. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  113355. */
  113356. alphaTest: boolean;
  113357. /**
  113358. * Define a mask to restrict the layer to only some of the scene cameras.
  113359. */
  113360. layerMask: number;
  113361. /**
  113362. * Define the list of render target the layer is visible into.
  113363. */
  113364. renderTargetTextures: RenderTargetTexture[];
  113365. /**
  113366. * Define if the layer is only used in renderTarget or if it also
  113367. * renders in the main frame buffer of the canvas.
  113368. */
  113369. renderOnlyInRenderTargetTextures: boolean;
  113370. private _scene;
  113371. private _vertexBuffers;
  113372. private _indexBuffer;
  113373. private _effect;
  113374. private _alphaTestEffect;
  113375. /**
  113376. * An event triggered when the layer is disposed.
  113377. */
  113378. onDisposeObservable: Observable<Layer>;
  113379. private _onDisposeObserver;
  113380. /**
  113381. * Back compatibility with callback before the onDisposeObservable existed.
  113382. * The set callback will be triggered when the layer has been disposed.
  113383. */
  113384. onDispose: () => void;
  113385. /**
  113386. * An event triggered before rendering the scene
  113387. */
  113388. onBeforeRenderObservable: Observable<Layer>;
  113389. private _onBeforeRenderObserver;
  113390. /**
  113391. * Back compatibility with callback before the onBeforeRenderObservable existed.
  113392. * The set callback will be triggered just before rendering the layer.
  113393. */
  113394. onBeforeRender: () => void;
  113395. /**
  113396. * An event triggered after rendering the scene
  113397. */
  113398. onAfterRenderObservable: Observable<Layer>;
  113399. private _onAfterRenderObserver;
  113400. /**
  113401. * Back compatibility with callback before the onAfterRenderObservable existed.
  113402. * The set callback will be triggered just after rendering the layer.
  113403. */
  113404. onAfterRender: () => void;
  113405. /**
  113406. * Instantiates a new layer.
  113407. * This represents a full screen 2d layer.
  113408. * This can be useful to display a picture in the background of your scene for instance.
  113409. * @see https://www.babylonjs-playground.com/#08A2BS#1
  113410. * @param name Define the name of the layer in the scene
  113411. * @param imgUrl Define the url of the texture to display in the layer
  113412. * @param scene Define the scene the layer belongs to
  113413. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  113414. * @param color Defines a color for the layer
  113415. */
  113416. constructor(
  113417. /**
  113418. * Define the name of the layer.
  113419. */
  113420. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  113421. private _createIndexBuffer;
  113422. /** @hidden */
  113423. _rebuild(): void;
  113424. /**
  113425. * Renders the layer in the scene.
  113426. */
  113427. render(): void;
  113428. /**
  113429. * Disposes and releases the associated ressources.
  113430. */
  113431. dispose(): void;
  113432. }
  113433. }
  113434. declare module BABYLON {
  113435. /** @hidden */
  113436. export var lensFlarePixelShader: {
  113437. name: string;
  113438. shader: string;
  113439. };
  113440. }
  113441. declare module BABYLON {
  113442. /** @hidden */
  113443. export var lensFlareVertexShader: {
  113444. name: string;
  113445. shader: string;
  113446. };
  113447. }
  113448. declare module BABYLON {
  113449. /**
  113450. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  113451. * It is usually composed of several `lensFlare`.
  113452. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  113453. */
  113454. export class LensFlareSystem {
  113455. /**
  113456. * Define the name of the lens flare system
  113457. */
  113458. name: string;
  113459. /**
  113460. * List of lens flares used in this system.
  113461. */
  113462. lensFlares: LensFlare[];
  113463. /**
  113464. * Define a limit from the border the lens flare can be visible.
  113465. */
  113466. borderLimit: number;
  113467. /**
  113468. * Define a viewport border we do not want to see the lens flare in.
  113469. */
  113470. viewportBorder: number;
  113471. /**
  113472. * Define a predicate which could limit the list of meshes able to occlude the effect.
  113473. */
  113474. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  113475. /**
  113476. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  113477. */
  113478. layerMask: number;
  113479. /**
  113480. * Define the id of the lens flare system in the scene.
  113481. * (equal to name by default)
  113482. */
  113483. id: string;
  113484. private _scene;
  113485. private _emitter;
  113486. private _vertexBuffers;
  113487. private _indexBuffer;
  113488. private _effect;
  113489. private _positionX;
  113490. private _positionY;
  113491. private _isEnabled;
  113492. /** @hidden */
  113493. static _SceneComponentInitialization: (scene: Scene) => void;
  113494. /**
  113495. * Instantiates a lens flare system.
  113496. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  113497. * It is usually composed of several `lensFlare`.
  113498. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  113499. * @param name Define the name of the lens flare system in the scene
  113500. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  113501. * @param scene Define the scene the lens flare system belongs to
  113502. */
  113503. constructor(
  113504. /**
  113505. * Define the name of the lens flare system
  113506. */
  113507. name: string, emitter: any, scene: Scene);
  113508. /**
  113509. * Define if the lens flare system is enabled.
  113510. */
  113511. isEnabled: boolean;
  113512. /**
  113513. * Get the scene the effects belongs to.
  113514. * @returns the scene holding the lens flare system
  113515. */
  113516. getScene(): Scene;
  113517. /**
  113518. * Get the emitter of the lens flare system.
  113519. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  113520. * @returns the emitter of the lens flare system
  113521. */
  113522. getEmitter(): any;
  113523. /**
  113524. * Set the emitter of the lens flare system.
  113525. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  113526. * @param newEmitter Define the new emitter of the system
  113527. */
  113528. setEmitter(newEmitter: any): void;
  113529. /**
  113530. * Get the lens flare system emitter position.
  113531. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  113532. * @returns the position
  113533. */
  113534. getEmitterPosition(): Vector3;
  113535. /**
  113536. * @hidden
  113537. */
  113538. computeEffectivePosition(globalViewport: Viewport): boolean;
  113539. /** @hidden */
  113540. _isVisible(): boolean;
  113541. /**
  113542. * @hidden
  113543. */
  113544. render(): boolean;
  113545. /**
  113546. * Dispose and release the lens flare with its associated resources.
  113547. */
  113548. dispose(): void;
  113549. /**
  113550. * Parse a lens flare system from a JSON repressentation
  113551. * @param parsedLensFlareSystem Define the JSON to parse
  113552. * @param scene Define the scene the parsed system should be instantiated in
  113553. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  113554. * @returns the parsed system
  113555. */
  113556. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  113557. /**
  113558. * Serialize the current Lens Flare System into a JSON representation.
  113559. * @returns the serialized JSON
  113560. */
  113561. serialize(): any;
  113562. }
  113563. }
  113564. declare module BABYLON {
  113565. /**
  113566. * This represents one of the lens effect in a `lensFlareSystem`.
  113567. * It controls one of the indiviual texture used in the effect.
  113568. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  113569. */
  113570. export class LensFlare {
  113571. /**
  113572. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  113573. */
  113574. size: number;
  113575. /**
  113576. * 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.
  113577. */
  113578. position: number;
  113579. /**
  113580. * Define the lens color.
  113581. */
  113582. color: Color3;
  113583. /**
  113584. * Define the lens texture.
  113585. */
  113586. texture: Nullable<Texture>;
  113587. /**
  113588. * Define the alpha mode to render this particular lens.
  113589. */
  113590. alphaMode: number;
  113591. private _system;
  113592. /**
  113593. * Creates a new Lens Flare.
  113594. * This represents one of the lens effect in a `lensFlareSystem`.
  113595. * It controls one of the indiviual texture used in the effect.
  113596. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  113597. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  113598. * @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.
  113599. * @param color Define the lens color
  113600. * @param imgUrl Define the lens texture url
  113601. * @param system Define the `lensFlareSystem` this flare is part of
  113602. * @returns The newly created Lens Flare
  113603. */
  113604. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  113605. /**
  113606. * Instantiates a new Lens Flare.
  113607. * This represents one of the lens effect in a `lensFlareSystem`.
  113608. * It controls one of the indiviual texture used in the effect.
  113609. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  113610. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  113611. * @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.
  113612. * @param color Define the lens color
  113613. * @param imgUrl Define the lens texture url
  113614. * @param system Define the `lensFlareSystem` this flare is part of
  113615. */
  113616. constructor(
  113617. /**
  113618. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  113619. */
  113620. size: number,
  113621. /**
  113622. * 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.
  113623. */
  113624. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  113625. /**
  113626. * Dispose and release the lens flare with its associated resources.
  113627. */
  113628. dispose(): void;
  113629. }
  113630. }
  113631. declare module BABYLON {
  113632. interface AbstractScene {
  113633. /**
  113634. * The list of lens flare system added to the scene
  113635. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  113636. */
  113637. lensFlareSystems: Array<LensFlareSystem>;
  113638. /**
  113639. * Removes the given lens flare system from this scene.
  113640. * @param toRemove The lens flare system to remove
  113641. * @returns The index of the removed lens flare system
  113642. */
  113643. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  113644. /**
  113645. * Adds the given lens flare system to this scene
  113646. * @param newLensFlareSystem The lens flare system to add
  113647. */
  113648. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  113649. /**
  113650. * Gets a lens flare system using its name
  113651. * @param name defines the name to look for
  113652. * @returns the lens flare system or null if not found
  113653. */
  113654. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  113655. /**
  113656. * Gets a lens flare system using its id
  113657. * @param id defines the id to look for
  113658. * @returns the lens flare system or null if not found
  113659. */
  113660. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  113661. }
  113662. /**
  113663. * Defines the lens flare scene component responsible to manage any lens flares
  113664. * in a given scene.
  113665. */
  113666. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  113667. /**
  113668. * The component name helpfull to identify the component in the list of scene components.
  113669. */
  113670. readonly name: string;
  113671. /**
  113672. * The scene the component belongs to.
  113673. */
  113674. scene: Scene;
  113675. /**
  113676. * Creates a new instance of the component for the given scene
  113677. * @param scene Defines the scene to register the component in
  113678. */
  113679. constructor(scene: Scene);
  113680. /**
  113681. * Registers the component in a given scene
  113682. */
  113683. register(): void;
  113684. /**
  113685. * Rebuilds the elements related to this component in case of
  113686. * context lost for instance.
  113687. */
  113688. rebuild(): void;
  113689. /**
  113690. * Adds all the elements from the container to the scene
  113691. * @param container the container holding the elements
  113692. */
  113693. addFromContainer(container: AbstractScene): void;
  113694. /**
  113695. * Removes all the elements in the container from the scene
  113696. * @param container contains the elements to remove
  113697. * @param dispose if the removed element should be disposed (default: false)
  113698. */
  113699. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  113700. /**
  113701. * Serializes the component data to the specified json object
  113702. * @param serializationObject The object to serialize to
  113703. */
  113704. serialize(serializationObject: any): void;
  113705. /**
  113706. * Disposes the component and the associated ressources.
  113707. */
  113708. dispose(): void;
  113709. private _draw;
  113710. }
  113711. }
  113712. declare module BABYLON {
  113713. /**
  113714. * Defines the shadow generator component responsible to manage any shadow generators
  113715. * in a given scene.
  113716. */
  113717. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  113718. /**
  113719. * The component name helpfull to identify the component in the list of scene components.
  113720. */
  113721. readonly name: string;
  113722. /**
  113723. * The scene the component belongs to.
  113724. */
  113725. scene: Scene;
  113726. /**
  113727. * Creates a new instance of the component for the given scene
  113728. * @param scene Defines the scene to register the component in
  113729. */
  113730. constructor(scene: Scene);
  113731. /**
  113732. * Registers the component in a given scene
  113733. */
  113734. register(): void;
  113735. /**
  113736. * Rebuilds the elements related to this component in case of
  113737. * context lost for instance.
  113738. */
  113739. rebuild(): void;
  113740. /**
  113741. * Serializes the component data to the specified json object
  113742. * @param serializationObject The object to serialize to
  113743. */
  113744. serialize(serializationObject: any): void;
  113745. /**
  113746. * Adds all the elements from the container to the scene
  113747. * @param container the container holding the elements
  113748. */
  113749. addFromContainer(container: AbstractScene): void;
  113750. /**
  113751. * Removes all the elements in the container from the scene
  113752. * @param container contains the elements to remove
  113753. * @param dispose if the removed element should be disposed (default: false)
  113754. */
  113755. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  113756. /**
  113757. * Rebuilds the elements related to this component in case of
  113758. * context lost for instance.
  113759. */
  113760. dispose(): void;
  113761. private _gatherRenderTargets;
  113762. }
  113763. }
  113764. declare module BABYLON {
  113765. /**
  113766. * A point light is a light defined by an unique point in world space.
  113767. * The light is emitted in every direction from this point.
  113768. * A good example of a point light is a standard light bulb.
  113769. * Documentation: https://doc.babylonjs.com/babylon101/lights
  113770. */
  113771. export class PointLight extends ShadowLight {
  113772. private _shadowAngle;
  113773. /**
  113774. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  113775. * This specifies what angle the shadow will use to be created.
  113776. *
  113777. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  113778. */
  113779. /**
  113780. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  113781. * This specifies what angle the shadow will use to be created.
  113782. *
  113783. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  113784. */
  113785. shadowAngle: number;
  113786. /**
  113787. * Gets the direction if it has been set.
  113788. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  113789. */
  113790. /**
  113791. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  113792. */
  113793. direction: Vector3;
  113794. /**
  113795. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  113796. * A PointLight emits the light in every direction.
  113797. * It can cast shadows.
  113798. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  113799. * ```javascript
  113800. * var pointLight = new PointLight("pl", camera.position, scene);
  113801. * ```
  113802. * Documentation : https://doc.babylonjs.com/babylon101/lights
  113803. * @param name The light friendly name
  113804. * @param position The position of the point light in the scene
  113805. * @param scene The scene the lights belongs to
  113806. */
  113807. constructor(name: string, position: Vector3, scene: Scene);
  113808. /**
  113809. * Returns the string "PointLight"
  113810. * @returns the class name
  113811. */
  113812. getClassName(): string;
  113813. /**
  113814. * Returns the integer 0.
  113815. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  113816. */
  113817. getTypeID(): number;
  113818. /**
  113819. * Specifies wether or not the shadowmap should be a cube texture.
  113820. * @returns true if the shadowmap needs to be a cube texture.
  113821. */
  113822. needCube(): boolean;
  113823. /**
  113824. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  113825. * @param faceIndex The index of the face we are computed the direction to generate shadow
  113826. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  113827. */
  113828. getShadowDirection(faceIndex?: number): Vector3;
  113829. /**
  113830. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  113831. * - fov = PI / 2
  113832. * - aspect ratio : 1.0
  113833. * - z-near and far equal to the active camera minZ and maxZ.
  113834. * Returns the PointLight.
  113835. */
  113836. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113837. protected _buildUniformLayout(): void;
  113838. /**
  113839. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  113840. * @param effect The effect to update
  113841. * @param lightIndex The index of the light in the effect to update
  113842. * @returns The point light
  113843. */
  113844. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  113845. /**
  113846. * Prepares the list of defines specific to the light type.
  113847. * @param defines the list of defines
  113848. * @param lightIndex defines the index of the light for the effect
  113849. */
  113850. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  113851. }
  113852. }
  113853. declare module BABYLON {
  113854. /**
  113855. * Header information of HDR texture files.
  113856. */
  113857. export interface HDRInfo {
  113858. /**
  113859. * The height of the texture in pixels.
  113860. */
  113861. height: number;
  113862. /**
  113863. * The width of the texture in pixels.
  113864. */
  113865. width: number;
  113866. /**
  113867. * The index of the beginning of the data in the binary file.
  113868. */
  113869. dataPosition: number;
  113870. }
  113871. /**
  113872. * This groups tools to convert HDR texture to native colors array.
  113873. */
  113874. export class HDRTools {
  113875. private static Ldexp;
  113876. private static Rgbe2float;
  113877. private static readStringLine;
  113878. /**
  113879. * Reads header information from an RGBE texture stored in a native array.
  113880. * More information on this format are available here:
  113881. * https://en.wikipedia.org/wiki/RGBE_image_format
  113882. *
  113883. * @param uint8array The binary file stored in native array.
  113884. * @return The header information.
  113885. */
  113886. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  113887. /**
  113888. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  113889. * This RGBE texture needs to store the information as a panorama.
  113890. *
  113891. * More information on this format are available here:
  113892. * https://en.wikipedia.org/wiki/RGBE_image_format
  113893. *
  113894. * @param buffer The binary file stored in an array buffer.
  113895. * @param size The expected size of the extracted cubemap.
  113896. * @return The Cube Map information.
  113897. */
  113898. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  113899. /**
  113900. * Returns the pixels data extracted from an RGBE texture.
  113901. * This pixels will be stored left to right up to down in the R G B order in one array.
  113902. *
  113903. * More information on this format are available here:
  113904. * https://en.wikipedia.org/wiki/RGBE_image_format
  113905. *
  113906. * @param uint8array The binary file stored in an array buffer.
  113907. * @param hdrInfo The header information of the file.
  113908. * @return The pixels data in RGB right to left up to down order.
  113909. */
  113910. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  113911. private static RGBE_ReadPixels_RLE;
  113912. }
  113913. }
  113914. declare module BABYLON {
  113915. /**
  113916. * This represents a texture coming from an HDR input.
  113917. *
  113918. * The only supported format is currently panorama picture stored in RGBE format.
  113919. * Example of such files can be found on HDRLib: http://hdrlib.com/
  113920. */
  113921. export class HDRCubeTexture extends BaseTexture {
  113922. private static _facesMapping;
  113923. private _generateHarmonics;
  113924. private _noMipmap;
  113925. private _textureMatrix;
  113926. private _size;
  113927. private _onLoad;
  113928. private _onError;
  113929. /**
  113930. * The texture URL.
  113931. */
  113932. url: string;
  113933. /**
  113934. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  113935. */
  113936. coordinatesMode: number;
  113937. protected _isBlocking: boolean;
  113938. /**
  113939. * Sets wether or not the texture is blocking during loading.
  113940. */
  113941. /**
  113942. * Gets wether or not the texture is blocking during loading.
  113943. */
  113944. isBlocking: boolean;
  113945. protected _rotationY: number;
  113946. /**
  113947. * Sets texture matrix rotation angle around Y axis in radians.
  113948. */
  113949. /**
  113950. * Gets texture matrix rotation angle around Y axis radians.
  113951. */
  113952. rotationY: number;
  113953. /**
  113954. * Gets or sets the center of the bounding box associated with the cube texture
  113955. * It must define where the camera used to render the texture was set
  113956. */
  113957. boundingBoxPosition: Vector3;
  113958. private _boundingBoxSize;
  113959. /**
  113960. * Gets or sets the size of the bounding box associated with the cube texture
  113961. * When defined, the cubemap will switch to local mode
  113962. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  113963. * @example https://www.babylonjs-playground.com/#RNASML
  113964. */
  113965. boundingBoxSize: Vector3;
  113966. /**
  113967. * Instantiates an HDRTexture from the following parameters.
  113968. *
  113969. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  113970. * @param scene The scene the texture will be used in
  113971. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  113972. * @param noMipmap Forces to not generate the mipmap if true
  113973. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  113974. * @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)
  113975. * @param reserved Reserved flag for internal use.
  113976. */
  113977. 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>);
  113978. /**
  113979. * Get the current class name of the texture useful for serialization or dynamic coding.
  113980. * @returns "HDRCubeTexture"
  113981. */
  113982. getClassName(): string;
  113983. /**
  113984. * Occurs when the file is raw .hdr file.
  113985. */
  113986. private loadTexture;
  113987. clone(): HDRCubeTexture;
  113988. delayLoad(): void;
  113989. /**
  113990. * Get the texture reflection matrix used to rotate/transform the reflection.
  113991. * @returns the reflection matrix
  113992. */
  113993. getReflectionTextureMatrix(): Matrix;
  113994. /**
  113995. * Set the texture reflection matrix used to rotate/transform the reflection.
  113996. * @param value Define the reflection matrix to set
  113997. */
  113998. setReflectionTextureMatrix(value: Matrix): void;
  113999. /**
  114000. * Parses a JSON representation of an HDR Texture in order to create the texture
  114001. * @param parsedTexture Define the JSON representation
  114002. * @param scene Define the scene the texture should be created in
  114003. * @param rootUrl Define the root url in case we need to load relative dependencies
  114004. * @returns the newly created texture after parsing
  114005. */
  114006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  114007. serialize(): any;
  114008. }
  114009. }
  114010. declare module BABYLON {
  114011. /**
  114012. * Class used to control physics engine
  114013. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  114014. */
  114015. export class PhysicsEngine implements IPhysicsEngine {
  114016. private _physicsPlugin;
  114017. /**
  114018. * Global value used to control the smallest number supported by the simulation
  114019. */
  114020. static Epsilon: number;
  114021. private _impostors;
  114022. private _joints;
  114023. /**
  114024. * Gets the gravity vector used by the simulation
  114025. */
  114026. gravity: Vector3;
  114027. /**
  114028. * Factory used to create the default physics plugin.
  114029. * @returns The default physics plugin
  114030. */
  114031. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  114032. /**
  114033. * Creates a new Physics Engine
  114034. * @param gravity defines the gravity vector used by the simulation
  114035. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  114036. */
  114037. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  114038. /**
  114039. * Sets the gravity vector used by the simulation
  114040. * @param gravity defines the gravity vector to use
  114041. */
  114042. setGravity(gravity: Vector3): void;
  114043. /**
  114044. * Set the time step of the physics engine.
  114045. * Default is 1/60.
  114046. * To slow it down, enter 1/600 for example.
  114047. * To speed it up, 1/30
  114048. * @param newTimeStep defines the new timestep to apply to this world.
  114049. */
  114050. setTimeStep(newTimeStep?: number): void;
  114051. /**
  114052. * Get the time step of the physics engine.
  114053. * @returns the current time step
  114054. */
  114055. getTimeStep(): number;
  114056. /**
  114057. * Release all resources
  114058. */
  114059. dispose(): void;
  114060. /**
  114061. * Gets the name of the current physics plugin
  114062. * @returns the name of the plugin
  114063. */
  114064. getPhysicsPluginName(): string;
  114065. /**
  114066. * Adding a new impostor for the impostor tracking.
  114067. * This will be done by the impostor itself.
  114068. * @param impostor the impostor to add
  114069. */
  114070. addImpostor(impostor: PhysicsImpostor): void;
  114071. /**
  114072. * Remove an impostor from the engine.
  114073. * This impostor and its mesh will not longer be updated by the physics engine.
  114074. * @param impostor the impostor to remove
  114075. */
  114076. removeImpostor(impostor: PhysicsImpostor): void;
  114077. /**
  114078. * Add a joint to the physics engine
  114079. * @param mainImpostor defines the main impostor to which the joint is added.
  114080. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  114081. * @param joint defines the joint that will connect both impostors.
  114082. */
  114083. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  114084. /**
  114085. * Removes a joint from the simulation
  114086. * @param mainImpostor defines the impostor used with the joint
  114087. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  114088. * @param joint defines the joint to remove
  114089. */
  114090. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  114091. /**
  114092. * Called by the scene. No need to call it.
  114093. * @param delta defines the timespam between frames
  114094. */
  114095. _step(delta: number): void;
  114096. /**
  114097. * Gets the current plugin used to run the simulation
  114098. * @returns current plugin
  114099. */
  114100. getPhysicsPlugin(): IPhysicsEnginePlugin;
  114101. /**
  114102. * Gets the list of physic impostors
  114103. * @returns an array of PhysicsImpostor
  114104. */
  114105. getImpostors(): Array<PhysicsImpostor>;
  114106. /**
  114107. * Gets the impostor for a physics enabled object
  114108. * @param object defines the object impersonated by the impostor
  114109. * @returns the PhysicsImpostor or null if not found
  114110. */
  114111. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  114112. /**
  114113. * Gets the impostor for a physics body object
  114114. * @param body defines physics body used by the impostor
  114115. * @returns the PhysicsImpostor or null if not found
  114116. */
  114117. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  114118. /**
  114119. * Does a raycast in the physics world
  114120. * @param from when should the ray start?
  114121. * @param to when should the ray end?
  114122. * @returns PhysicsRaycastResult
  114123. */
  114124. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  114125. }
  114126. }
  114127. declare module BABYLON {
  114128. /** @hidden */
  114129. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  114130. private _useDeltaForWorldStep;
  114131. world: any;
  114132. name: string;
  114133. private _physicsMaterials;
  114134. private _fixedTimeStep;
  114135. private _cannonRaycastResult;
  114136. private _raycastResult;
  114137. private _physicsBodysToRemoveAfterStep;
  114138. BJSCANNON: any;
  114139. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  114140. setGravity(gravity: Vector3): void;
  114141. setTimeStep(timeStep: number): void;
  114142. getTimeStep(): number;
  114143. executeStep(delta: number): void;
  114144. private _removeMarkedPhysicsBodiesFromWorld;
  114145. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  114146. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  114147. generatePhysicsBody(impostor: PhysicsImpostor): void;
  114148. private _processChildMeshes;
  114149. removePhysicsBody(impostor: PhysicsImpostor): void;
  114150. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  114151. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  114152. private _addMaterial;
  114153. private _checkWithEpsilon;
  114154. private _createShape;
  114155. private _createHeightmap;
  114156. private _minus90X;
  114157. private _plus90X;
  114158. private _tmpPosition;
  114159. private _tmpDeltaPosition;
  114160. private _tmpUnityRotation;
  114161. private _updatePhysicsBodyTransformation;
  114162. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  114163. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  114164. isSupported(): boolean;
  114165. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  114166. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  114167. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  114168. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  114169. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  114170. getBodyMass(impostor: PhysicsImpostor): number;
  114171. getBodyFriction(impostor: PhysicsImpostor): number;
  114172. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  114173. getBodyRestitution(impostor: PhysicsImpostor): number;
  114174. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  114175. sleepBody(impostor: PhysicsImpostor): void;
  114176. wakeUpBody(impostor: PhysicsImpostor): void;
  114177. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  114178. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  114179. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  114180. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  114181. getRadius(impostor: PhysicsImpostor): number;
  114182. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  114183. dispose(): void;
  114184. private _extendNamespace;
  114185. /**
  114186. * Does a raycast in the physics world
  114187. * @param from when should the ray start?
  114188. * @param to when should the ray end?
  114189. * @returns PhysicsRaycastResult
  114190. */
  114191. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  114192. }
  114193. }
  114194. declare module BABYLON {
  114195. /** @hidden */
  114196. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  114197. world: any;
  114198. name: string;
  114199. BJSOIMO: any;
  114200. private _raycastResult;
  114201. constructor(iterations?: number, oimoInjection?: any);
  114202. setGravity(gravity: Vector3): void;
  114203. setTimeStep(timeStep: number): void;
  114204. getTimeStep(): number;
  114205. private _tmpImpostorsArray;
  114206. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  114207. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  114208. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  114209. generatePhysicsBody(impostor: PhysicsImpostor): void;
  114210. private _tmpPositionVector;
  114211. removePhysicsBody(impostor: PhysicsImpostor): void;
  114212. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  114213. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  114214. isSupported(): boolean;
  114215. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  114216. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  114217. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  114218. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  114219. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  114220. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  114221. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  114222. getBodyMass(impostor: PhysicsImpostor): number;
  114223. getBodyFriction(impostor: PhysicsImpostor): number;
  114224. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  114225. getBodyRestitution(impostor: PhysicsImpostor): number;
  114226. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  114227. sleepBody(impostor: PhysicsImpostor): void;
  114228. wakeUpBody(impostor: PhysicsImpostor): void;
  114229. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  114230. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  114231. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  114232. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  114233. getRadius(impostor: PhysicsImpostor): number;
  114234. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  114235. dispose(): void;
  114236. /**
  114237. * Does a raycast in the physics world
  114238. * @param from when should the ray start?
  114239. * @param to when should the ray end?
  114240. * @returns PhysicsRaycastResult
  114241. */
  114242. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  114243. }
  114244. }
  114245. declare module BABYLON {
  114246. /**
  114247. * Class containing static functions to help procedurally build meshes
  114248. */
  114249. export class RibbonBuilder {
  114250. /**
  114251. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  114252. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  114253. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  114254. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  114255. * * 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
  114256. * * 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
  114257. * * 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
  114258. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  114259. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114260. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  114261. * * 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
  114262. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  114263. * * 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
  114264. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  114265. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114266. * @param name defines the name of the mesh
  114267. * @param options defines the options used to create the mesh
  114268. * @param scene defines the hosting scene
  114269. * @returns the ribbon mesh
  114270. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  114271. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  114272. */
  114273. static CreateRibbon(name: string, options: {
  114274. pathArray: Vector3[][];
  114275. closeArray?: boolean;
  114276. closePath?: boolean;
  114277. offset?: number;
  114278. updatable?: boolean;
  114279. sideOrientation?: number;
  114280. frontUVs?: Vector4;
  114281. backUVs?: Vector4;
  114282. instance?: Mesh;
  114283. invertUV?: boolean;
  114284. uvs?: Vector2[];
  114285. colors?: Color4[];
  114286. }, scene?: Nullable<Scene>): Mesh;
  114287. }
  114288. }
  114289. declare module BABYLON {
  114290. /**
  114291. * Class containing static functions to help procedurally build meshes
  114292. */
  114293. export class ShapeBuilder {
  114294. /**
  114295. * 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.
  114296. * * 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.
  114297. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  114298. * * 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.
  114299. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  114300. * * 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
  114301. * * 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
  114302. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  114303. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  114304. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114305. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  114306. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  114307. * @param name defines the name of the mesh
  114308. * @param options defines the options used to create the mesh
  114309. * @param scene defines the hosting scene
  114310. * @returns the extruded shape mesh
  114311. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  114312. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  114313. */
  114314. static ExtrudeShape(name: string, options: {
  114315. shape: Vector3[];
  114316. path: Vector3[];
  114317. scale?: number;
  114318. rotation?: number;
  114319. cap?: number;
  114320. updatable?: boolean;
  114321. sideOrientation?: number;
  114322. frontUVs?: Vector4;
  114323. backUVs?: Vector4;
  114324. instance?: Mesh;
  114325. invertUV?: boolean;
  114326. }, scene?: Nullable<Scene>): Mesh;
  114327. /**
  114328. * Creates an custom extruded shape mesh.
  114329. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  114330. * * 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.
  114331. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  114332. * * 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
  114333. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  114334. * * 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
  114335. * * It must returns a float value that will be the scale value applied to the shape on each path point
  114336. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  114337. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  114338. * * 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
  114339. * * 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
  114340. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  114341. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  114342. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114343. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  114344. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114345. * @param name defines the name of the mesh
  114346. * @param options defines the options used to create the mesh
  114347. * @param scene defines the hosting scene
  114348. * @returns the custom extruded shape mesh
  114349. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  114350. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  114351. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  114352. */
  114353. static ExtrudeShapeCustom(name: string, options: {
  114354. shape: Vector3[];
  114355. path: Vector3[];
  114356. scaleFunction?: any;
  114357. rotationFunction?: any;
  114358. ribbonCloseArray?: boolean;
  114359. ribbonClosePath?: boolean;
  114360. cap?: number;
  114361. updatable?: boolean;
  114362. sideOrientation?: number;
  114363. frontUVs?: Vector4;
  114364. backUVs?: Vector4;
  114365. instance?: Mesh;
  114366. invertUV?: boolean;
  114367. }, scene?: Nullable<Scene>): Mesh;
  114368. private static _ExtrudeShapeGeneric;
  114369. }
  114370. }
  114371. declare module BABYLON {
  114372. /**
  114373. * AmmoJS Physics plugin
  114374. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  114375. * @see https://github.com/kripken/ammo.js/
  114376. */
  114377. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  114378. private _useDeltaForWorldStep;
  114379. /**
  114380. * Reference to the Ammo library
  114381. */
  114382. bjsAMMO: any;
  114383. /**
  114384. * Created ammoJS world which physics bodies are added to
  114385. */
  114386. world: any;
  114387. /**
  114388. * Name of the plugin
  114389. */
  114390. name: string;
  114391. private _timeStep;
  114392. private _fixedTimeStep;
  114393. private _maxSteps;
  114394. private _tmpQuaternion;
  114395. private _tmpAmmoTransform;
  114396. private _tmpAmmoQuaternion;
  114397. private _tmpAmmoConcreteContactResultCallback;
  114398. private _collisionConfiguration;
  114399. private _dispatcher;
  114400. private _overlappingPairCache;
  114401. private _solver;
  114402. private _softBodySolver;
  114403. private _tmpAmmoVectorA;
  114404. private _tmpAmmoVectorB;
  114405. private _tmpAmmoVectorC;
  114406. private _tmpAmmoVectorD;
  114407. private _tmpContactCallbackResult;
  114408. private _tmpAmmoVectorRCA;
  114409. private _tmpAmmoVectorRCB;
  114410. private _raycastResult;
  114411. private static readonly DISABLE_COLLISION_FLAG;
  114412. private static readonly KINEMATIC_FLAG;
  114413. private static readonly DISABLE_DEACTIVATION_FLAG;
  114414. /**
  114415. * Initializes the ammoJS plugin
  114416. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  114417. * @param ammoInjection can be used to inject your own ammo reference
  114418. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  114419. */
  114420. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  114421. /**
  114422. * Sets the gravity of the physics world (m/(s^2))
  114423. * @param gravity Gravity to set
  114424. */
  114425. setGravity(gravity: Vector3): void;
  114426. /**
  114427. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  114428. * @param timeStep timestep to use in seconds
  114429. */
  114430. setTimeStep(timeStep: number): void;
  114431. /**
  114432. * 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)
  114433. * @param fixedTimeStep fixedTimeStep to use in seconds
  114434. */
  114435. setFixedTimeStep(fixedTimeStep: number): void;
  114436. /**
  114437. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  114438. * @param maxSteps the maximum number of steps by the physics engine per frame
  114439. */
  114440. setMaxSteps(maxSteps: number): void;
  114441. /**
  114442. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  114443. * @returns the current timestep in seconds
  114444. */
  114445. getTimeStep(): number;
  114446. private _isImpostorInContact;
  114447. private _isImpostorPairInContact;
  114448. private _stepSimulation;
  114449. /**
  114450. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  114451. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  114452. * After the step the babylon meshes are set to the position of the physics imposters
  114453. * @param delta amount of time to step forward
  114454. * @param impostors array of imposters to update before/after the step
  114455. */
  114456. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  114457. /**
  114458. * Update babylon mesh to match physics world object
  114459. * @param impostor imposter to match
  114460. */
  114461. private _afterSoftStep;
  114462. /**
  114463. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  114464. * @param impostor imposter to match
  114465. */
  114466. private _ropeStep;
  114467. /**
  114468. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  114469. * @param impostor imposter to match
  114470. */
  114471. private _softbodyOrClothStep;
  114472. private _tmpVector;
  114473. private _tmpMatrix;
  114474. /**
  114475. * Applies an impulse on the imposter
  114476. * @param impostor imposter to apply impulse to
  114477. * @param force amount of force to be applied to the imposter
  114478. * @param contactPoint the location to apply the impulse on the imposter
  114479. */
  114480. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  114481. /**
  114482. * Applies a force on the imposter
  114483. * @param impostor imposter to apply force
  114484. * @param force amount of force to be applied to the imposter
  114485. * @param contactPoint the location to apply the force on the imposter
  114486. */
  114487. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  114488. /**
  114489. * Creates a physics body using the plugin
  114490. * @param impostor the imposter to create the physics body on
  114491. */
  114492. generatePhysicsBody(impostor: PhysicsImpostor): void;
  114493. /**
  114494. * Removes the physics body from the imposter and disposes of the body's memory
  114495. * @param impostor imposter to remove the physics body from
  114496. */
  114497. removePhysicsBody(impostor: PhysicsImpostor): void;
  114498. /**
  114499. * Generates a joint
  114500. * @param impostorJoint the imposter joint to create the joint with
  114501. */
  114502. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  114503. /**
  114504. * Removes a joint
  114505. * @param impostorJoint the imposter joint to remove the joint from
  114506. */
  114507. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  114508. private _addMeshVerts;
  114509. /**
  114510. * Initialise the soft body vertices to match its object's (mesh) vertices
  114511. * Softbody vertices (nodes) are in world space and to match this
  114512. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  114513. * @param impostor to create the softbody for
  114514. */
  114515. private _softVertexData;
  114516. /**
  114517. * Create an impostor's soft body
  114518. * @param impostor to create the softbody for
  114519. */
  114520. private _createSoftbody;
  114521. /**
  114522. * Create cloth for an impostor
  114523. * @param impostor to create the softbody for
  114524. */
  114525. private _createCloth;
  114526. /**
  114527. * Create rope for an impostor
  114528. * @param impostor to create the softbody for
  114529. */
  114530. private _createRope;
  114531. private _addHullVerts;
  114532. private _createShape;
  114533. /**
  114534. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  114535. * @param impostor imposter containing the physics body and babylon object
  114536. */
  114537. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  114538. /**
  114539. * Sets the babylon object's position/rotation from the physics body's position/rotation
  114540. * @param impostor imposter containing the physics body and babylon object
  114541. * @param newPosition new position
  114542. * @param newRotation new rotation
  114543. */
  114544. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  114545. /**
  114546. * If this plugin is supported
  114547. * @returns true if its supported
  114548. */
  114549. isSupported(): boolean;
  114550. /**
  114551. * Sets the linear velocity of the physics body
  114552. * @param impostor imposter to set the velocity on
  114553. * @param velocity velocity to set
  114554. */
  114555. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  114556. /**
  114557. * Sets the angular velocity of the physics body
  114558. * @param impostor imposter to set the velocity on
  114559. * @param velocity velocity to set
  114560. */
  114561. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  114562. /**
  114563. * gets the linear velocity
  114564. * @param impostor imposter to get linear velocity from
  114565. * @returns linear velocity
  114566. */
  114567. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  114568. /**
  114569. * gets the angular velocity
  114570. * @param impostor imposter to get angular velocity from
  114571. * @returns angular velocity
  114572. */
  114573. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  114574. /**
  114575. * Sets the mass of physics body
  114576. * @param impostor imposter to set the mass on
  114577. * @param mass mass to set
  114578. */
  114579. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  114580. /**
  114581. * Gets the mass of the physics body
  114582. * @param impostor imposter to get the mass from
  114583. * @returns mass
  114584. */
  114585. getBodyMass(impostor: PhysicsImpostor): number;
  114586. /**
  114587. * Gets friction of the impostor
  114588. * @param impostor impostor to get friction from
  114589. * @returns friction value
  114590. */
  114591. getBodyFriction(impostor: PhysicsImpostor): number;
  114592. /**
  114593. * Sets friction of the impostor
  114594. * @param impostor impostor to set friction on
  114595. * @param friction friction value
  114596. */
  114597. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  114598. /**
  114599. * Gets restitution of the impostor
  114600. * @param impostor impostor to get restitution from
  114601. * @returns restitution value
  114602. */
  114603. getBodyRestitution(impostor: PhysicsImpostor): number;
  114604. /**
  114605. * Sets resitution of the impostor
  114606. * @param impostor impostor to set resitution on
  114607. * @param restitution resitution value
  114608. */
  114609. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  114610. /**
  114611. * Gets pressure inside the impostor
  114612. * @param impostor impostor to get pressure from
  114613. * @returns pressure value
  114614. */
  114615. getBodyPressure(impostor: PhysicsImpostor): number;
  114616. /**
  114617. * Sets pressure inside a soft body impostor
  114618. * Cloth and rope must remain 0 pressure
  114619. * @param impostor impostor to set pressure on
  114620. * @param pressure pressure value
  114621. */
  114622. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  114623. /**
  114624. * Gets stiffness of the impostor
  114625. * @param impostor impostor to get stiffness from
  114626. * @returns pressure value
  114627. */
  114628. getBodyStiffness(impostor: PhysicsImpostor): number;
  114629. /**
  114630. * Sets stiffness of the impostor
  114631. * @param impostor impostor to set stiffness on
  114632. * @param stiffness stiffness value from 0 to 1
  114633. */
  114634. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  114635. /**
  114636. * Gets velocityIterations of the impostor
  114637. * @param impostor impostor to get velocity iterations from
  114638. * @returns velocityIterations value
  114639. */
  114640. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  114641. /**
  114642. * Sets velocityIterations of the impostor
  114643. * @param impostor impostor to set velocity iterations on
  114644. * @param velocityIterations velocityIterations value
  114645. */
  114646. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  114647. /**
  114648. * Gets positionIterations of the impostor
  114649. * @param impostor impostor to get position iterations from
  114650. * @returns positionIterations value
  114651. */
  114652. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  114653. /**
  114654. * Sets positionIterations of the impostor
  114655. * @param impostor impostor to set position on
  114656. * @param positionIterations positionIterations value
  114657. */
  114658. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  114659. /**
  114660. * Append an anchor to a cloth object
  114661. * @param impostor is the cloth impostor to add anchor to
  114662. * @param otherImpostor is the rigid impostor to anchor to
  114663. * @param width ratio across width from 0 to 1
  114664. * @param height ratio up height from 0 to 1
  114665. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  114666. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  114667. */
  114668. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  114669. /**
  114670. * Append an hook to a rope object
  114671. * @param impostor is the rope impostor to add hook to
  114672. * @param otherImpostor is the rigid impostor to hook to
  114673. * @param length ratio along the rope from 0 to 1
  114674. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  114675. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  114676. */
  114677. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  114678. /**
  114679. * Sleeps the physics body and stops it from being active
  114680. * @param impostor impostor to sleep
  114681. */
  114682. sleepBody(impostor: PhysicsImpostor): void;
  114683. /**
  114684. * Activates the physics body
  114685. * @param impostor impostor to activate
  114686. */
  114687. wakeUpBody(impostor: PhysicsImpostor): void;
  114688. /**
  114689. * Updates the distance parameters of the joint
  114690. * @param joint joint to update
  114691. * @param maxDistance maximum distance of the joint
  114692. * @param minDistance minimum distance of the joint
  114693. */
  114694. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  114695. /**
  114696. * Sets a motor on the joint
  114697. * @param joint joint to set motor on
  114698. * @param speed speed of the motor
  114699. * @param maxForce maximum force of the motor
  114700. * @param motorIndex index of the motor
  114701. */
  114702. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  114703. /**
  114704. * Sets the motors limit
  114705. * @param joint joint to set limit on
  114706. * @param upperLimit upper limit
  114707. * @param lowerLimit lower limit
  114708. */
  114709. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  114710. /**
  114711. * Syncs the position and rotation of a mesh with the impostor
  114712. * @param mesh mesh to sync
  114713. * @param impostor impostor to update the mesh with
  114714. */
  114715. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  114716. /**
  114717. * Gets the radius of the impostor
  114718. * @param impostor impostor to get radius from
  114719. * @returns the radius
  114720. */
  114721. getRadius(impostor: PhysicsImpostor): number;
  114722. /**
  114723. * Gets the box size of the impostor
  114724. * @param impostor impostor to get box size from
  114725. * @param result the resulting box size
  114726. */
  114727. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  114728. /**
  114729. * Disposes of the impostor
  114730. */
  114731. dispose(): void;
  114732. /**
  114733. * Does a raycast in the physics world
  114734. * @param from when should the ray start?
  114735. * @param to when should the ray end?
  114736. * @returns PhysicsRaycastResult
  114737. */
  114738. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  114739. }
  114740. }
  114741. declare module BABYLON {
  114742. interface AbstractScene {
  114743. /**
  114744. * The list of reflection probes added to the scene
  114745. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  114746. */
  114747. reflectionProbes: Array<ReflectionProbe>;
  114748. /**
  114749. * Removes the given reflection probe from this scene.
  114750. * @param toRemove The reflection probe to remove
  114751. * @returns The index of the removed reflection probe
  114752. */
  114753. removeReflectionProbe(toRemove: ReflectionProbe): number;
  114754. /**
  114755. * Adds the given reflection probe to this scene.
  114756. * @param newReflectionProbe The reflection probe to add
  114757. */
  114758. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  114759. }
  114760. /**
  114761. * Class used to generate realtime reflection / refraction cube textures
  114762. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  114763. */
  114764. export class ReflectionProbe {
  114765. /** defines the name of the probe */
  114766. name: string;
  114767. private _scene;
  114768. private _renderTargetTexture;
  114769. private _projectionMatrix;
  114770. private _viewMatrix;
  114771. private _target;
  114772. private _add;
  114773. private _attachedMesh;
  114774. private _invertYAxis;
  114775. /** Gets or sets probe position (center of the cube map) */
  114776. position: Vector3;
  114777. /**
  114778. * Creates a new reflection probe
  114779. * @param name defines the name of the probe
  114780. * @param size defines the texture resolution (for each face)
  114781. * @param scene defines the hosting scene
  114782. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  114783. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  114784. */
  114785. constructor(
  114786. /** defines the name of the probe */
  114787. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  114788. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  114789. samples: number;
  114790. /** Gets or sets the refresh rate to use (on every frame by default) */
  114791. refreshRate: number;
  114792. /**
  114793. * Gets the hosting scene
  114794. * @returns a Scene
  114795. */
  114796. getScene(): Scene;
  114797. /** Gets the internal CubeTexture used to render to */
  114798. readonly cubeTexture: RenderTargetTexture;
  114799. /** Gets the list of meshes to render */
  114800. readonly renderList: Nullable<AbstractMesh[]>;
  114801. /**
  114802. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  114803. * @param mesh defines the mesh to attach to
  114804. */
  114805. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  114806. /**
  114807. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  114808. * @param renderingGroupId The rendering group id corresponding to its index
  114809. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  114810. */
  114811. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  114812. /**
  114813. * Clean all associated resources
  114814. */
  114815. dispose(): void;
  114816. /**
  114817. * Converts the reflection probe information to a readable string for debug purpose.
  114818. * @param fullDetails Supports for multiple levels of logging within scene loading
  114819. * @returns the human readable reflection probe info
  114820. */
  114821. toString(fullDetails?: boolean): string;
  114822. /**
  114823. * Get the class name of the relfection probe.
  114824. * @returns "ReflectionProbe"
  114825. */
  114826. getClassName(): string;
  114827. /**
  114828. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  114829. * @returns The JSON representation of the texture
  114830. */
  114831. serialize(): any;
  114832. /**
  114833. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  114834. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  114835. * @param scene Define the scene the parsed reflection probe should be instantiated in
  114836. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  114837. * @returns The parsed reflection probe if successful
  114838. */
  114839. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  114840. }
  114841. }
  114842. declare module BABYLON {
  114843. /** @hidden */
  114844. export var _BabylonLoaderRegistered: boolean;
  114845. }
  114846. declare module BABYLON {
  114847. /**
  114848. * The Physically based simple base material of BJS.
  114849. *
  114850. * This enables better naming and convention enforcements on top of the pbrMaterial.
  114851. * It is used as the base class for both the specGloss and metalRough conventions.
  114852. */
  114853. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  114854. /**
  114855. * Number of Simultaneous lights allowed on the material.
  114856. */
  114857. maxSimultaneousLights: number;
  114858. /**
  114859. * If sets to true, disables all the lights affecting the material.
  114860. */
  114861. disableLighting: boolean;
  114862. /**
  114863. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  114864. */
  114865. environmentTexture: BaseTexture;
  114866. /**
  114867. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  114868. */
  114869. invertNormalMapX: boolean;
  114870. /**
  114871. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  114872. */
  114873. invertNormalMapY: boolean;
  114874. /**
  114875. * Normal map used in the model.
  114876. */
  114877. normalTexture: BaseTexture;
  114878. /**
  114879. * Emissivie color used to self-illuminate the model.
  114880. */
  114881. emissiveColor: Color3;
  114882. /**
  114883. * Emissivie texture used to self-illuminate the model.
  114884. */
  114885. emissiveTexture: BaseTexture;
  114886. /**
  114887. * Occlusion Channel Strenght.
  114888. */
  114889. occlusionStrength: number;
  114890. /**
  114891. * Occlusion Texture of the material (adding extra occlusion effects).
  114892. */
  114893. occlusionTexture: BaseTexture;
  114894. /**
  114895. * Defines the alpha limits in alpha test mode.
  114896. */
  114897. alphaCutOff: number;
  114898. /**
  114899. * Gets the current double sided mode.
  114900. */
  114901. /**
  114902. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  114903. */
  114904. doubleSided: boolean;
  114905. /**
  114906. * Stores the pre-calculated light information of a mesh in a texture.
  114907. */
  114908. lightmapTexture: BaseTexture;
  114909. /**
  114910. * If true, the light map contains occlusion information instead of lighting info.
  114911. */
  114912. useLightmapAsShadowmap: boolean;
  114913. /**
  114914. * Instantiates a new PBRMaterial instance.
  114915. *
  114916. * @param name The material name
  114917. * @param scene The scene the material will be use in.
  114918. */
  114919. constructor(name: string, scene: Scene);
  114920. getClassName(): string;
  114921. }
  114922. }
  114923. declare module BABYLON {
  114924. /**
  114925. * The PBR material of BJS following the metal roughness convention.
  114926. *
  114927. * This fits to the PBR convention in the GLTF definition:
  114928. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  114929. */
  114930. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  114931. /**
  114932. * The base color has two different interpretations depending on the value of metalness.
  114933. * When the material is a metal, the base color is the specific measured reflectance value
  114934. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  114935. * of the material.
  114936. */
  114937. baseColor: Color3;
  114938. /**
  114939. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  114940. * well as opacity information in the alpha channel.
  114941. */
  114942. baseTexture: BaseTexture;
  114943. /**
  114944. * Specifies the metallic scalar value of the material.
  114945. * Can also be used to scale the metalness values of the metallic texture.
  114946. */
  114947. metallic: number;
  114948. /**
  114949. * Specifies the roughness scalar value of the material.
  114950. * Can also be used to scale the roughness values of the metallic texture.
  114951. */
  114952. roughness: number;
  114953. /**
  114954. * Texture containing both the metallic value in the B channel and the
  114955. * roughness value in the G channel to keep better precision.
  114956. */
  114957. metallicRoughnessTexture: BaseTexture;
  114958. /**
  114959. * Instantiates a new PBRMetalRoughnessMaterial instance.
  114960. *
  114961. * @param name The material name
  114962. * @param scene The scene the material will be use in.
  114963. */
  114964. constructor(name: string, scene: Scene);
  114965. /**
  114966. * Return the currrent class name of the material.
  114967. */
  114968. getClassName(): string;
  114969. /**
  114970. * Makes a duplicate of the current material.
  114971. * @param name - name to use for the new material.
  114972. */
  114973. clone(name: string): PBRMetallicRoughnessMaterial;
  114974. /**
  114975. * Serialize the material to a parsable JSON object.
  114976. */
  114977. serialize(): any;
  114978. /**
  114979. * Parses a JSON object correponding to the serialize function.
  114980. */
  114981. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  114982. }
  114983. }
  114984. declare module BABYLON {
  114985. /**
  114986. * The PBR material of BJS following the specular glossiness convention.
  114987. *
  114988. * This fits to the PBR convention in the GLTF definition:
  114989. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  114990. */
  114991. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  114992. /**
  114993. * Specifies the diffuse color of the material.
  114994. */
  114995. diffuseColor: Color3;
  114996. /**
  114997. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  114998. * channel.
  114999. */
  115000. diffuseTexture: BaseTexture;
  115001. /**
  115002. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  115003. */
  115004. specularColor: Color3;
  115005. /**
  115006. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  115007. */
  115008. glossiness: number;
  115009. /**
  115010. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  115011. */
  115012. specularGlossinessTexture: BaseTexture;
  115013. /**
  115014. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  115015. *
  115016. * @param name The material name
  115017. * @param scene The scene the material will be use in.
  115018. */
  115019. constructor(name: string, scene: Scene);
  115020. /**
  115021. * Return the currrent class name of the material.
  115022. */
  115023. getClassName(): string;
  115024. /**
  115025. * Makes a duplicate of the current material.
  115026. * @param name - name to use for the new material.
  115027. */
  115028. clone(name: string): PBRSpecularGlossinessMaterial;
  115029. /**
  115030. * Serialize the material to a parsable JSON object.
  115031. */
  115032. serialize(): any;
  115033. /**
  115034. * Parses a JSON object correponding to the serialize function.
  115035. */
  115036. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  115037. }
  115038. }
  115039. declare module BABYLON {
  115040. /**
  115041. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  115042. * It can help converting any input color in a desired output one. This can then be used to create effects
  115043. * from sepia, black and white to sixties or futuristic rendering...
  115044. *
  115045. * The only supported format is currently 3dl.
  115046. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  115047. */
  115048. export class ColorGradingTexture extends BaseTexture {
  115049. /**
  115050. * The current texture matrix. (will always be identity in color grading texture)
  115051. */
  115052. private _textureMatrix;
  115053. /**
  115054. * The texture URL.
  115055. */
  115056. url: string;
  115057. /**
  115058. * Empty line regex stored for GC.
  115059. */
  115060. private static _noneEmptyLineRegex;
  115061. private _engine;
  115062. /**
  115063. * Instantiates a ColorGradingTexture from the following parameters.
  115064. *
  115065. * @param url The location of the color gradind data (currently only supporting 3dl)
  115066. * @param scene The scene the texture will be used in
  115067. */
  115068. constructor(url: string, scene: Scene);
  115069. /**
  115070. * Returns the texture matrix used in most of the material.
  115071. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  115072. */
  115073. getTextureMatrix(): Matrix;
  115074. /**
  115075. * Occurs when the file being loaded is a .3dl LUT file.
  115076. */
  115077. private load3dlTexture;
  115078. /**
  115079. * Starts the loading process of the texture.
  115080. */
  115081. private loadTexture;
  115082. /**
  115083. * Clones the color gradind texture.
  115084. */
  115085. clone(): ColorGradingTexture;
  115086. /**
  115087. * Called during delayed load for textures.
  115088. */
  115089. delayLoad(): void;
  115090. /**
  115091. * Parses a color grading texture serialized by Babylon.
  115092. * @param parsedTexture The texture information being parsedTexture
  115093. * @param scene The scene to load the texture in
  115094. * @param rootUrl The root url of the data assets to load
  115095. * @return A color gradind texture
  115096. */
  115097. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  115098. /**
  115099. * Serializes the LUT texture to json format.
  115100. */
  115101. serialize(): any;
  115102. }
  115103. }
  115104. declare module BABYLON {
  115105. /**
  115106. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  115107. */
  115108. export class EquiRectangularCubeTexture extends BaseTexture {
  115109. /** The six faces of the cube. */
  115110. private static _FacesMapping;
  115111. private _noMipmap;
  115112. private _onLoad;
  115113. private _onError;
  115114. /** The size of the cubemap. */
  115115. private _size;
  115116. /** The buffer of the image. */
  115117. private _buffer;
  115118. /** The width of the input image. */
  115119. private _width;
  115120. /** The height of the input image. */
  115121. private _height;
  115122. /** The URL to the image. */
  115123. url: string;
  115124. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  115125. coordinatesMode: number;
  115126. /**
  115127. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  115128. * @param url The location of the image
  115129. * @param scene The scene the texture will be used in
  115130. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  115131. * @param noMipmap Forces to not generate the mipmap if true
  115132. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  115133. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  115134. * @param onLoad — defines a callback called when texture is loaded
  115135. * @param onError — defines a callback called if there is an error
  115136. */
  115137. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  115138. /**
  115139. * Load the image data, by putting the image on a canvas and extracting its buffer.
  115140. */
  115141. private loadImage;
  115142. /**
  115143. * Convert the image buffer into a cubemap and create a CubeTexture.
  115144. */
  115145. private loadTexture;
  115146. /**
  115147. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  115148. * @param buffer The ArrayBuffer that should be converted.
  115149. * @returns The buffer as Float32Array.
  115150. */
  115151. private getFloat32ArrayFromArrayBuffer;
  115152. /**
  115153. * Get the current class name of the texture useful for serialization or dynamic coding.
  115154. * @returns "EquiRectangularCubeTexture"
  115155. */
  115156. getClassName(): string;
  115157. /**
  115158. * Create a clone of the current EquiRectangularCubeTexture and return it.
  115159. * @returns A clone of the current EquiRectangularCubeTexture.
  115160. */
  115161. clone(): EquiRectangularCubeTexture;
  115162. }
  115163. }
  115164. declare module BABYLON {
  115165. /**
  115166. * Based on jsTGALoader - Javascript loader for TGA file
  115167. * By Vincent Thibault
  115168. * @see http://blog.robrowser.com/javascript-tga-loader.html
  115169. */
  115170. export class TGATools {
  115171. private static _TYPE_INDEXED;
  115172. private static _TYPE_RGB;
  115173. private static _TYPE_GREY;
  115174. private static _TYPE_RLE_INDEXED;
  115175. private static _TYPE_RLE_RGB;
  115176. private static _TYPE_RLE_GREY;
  115177. private static _ORIGIN_MASK;
  115178. private static _ORIGIN_SHIFT;
  115179. private static _ORIGIN_BL;
  115180. private static _ORIGIN_BR;
  115181. private static _ORIGIN_UL;
  115182. private static _ORIGIN_UR;
  115183. /**
  115184. * Gets the header of a TGA file
  115185. * @param data defines the TGA data
  115186. * @returns the header
  115187. */
  115188. static GetTGAHeader(data: Uint8Array): any;
  115189. /**
  115190. * Uploads TGA content to a Babylon Texture
  115191. * @hidden
  115192. */
  115193. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  115194. /** @hidden */
  115195. 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;
  115196. /** @hidden */
  115197. 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;
  115198. /** @hidden */
  115199. 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;
  115200. /** @hidden */
  115201. 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;
  115202. /** @hidden */
  115203. 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;
  115204. /** @hidden */
  115205. 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;
  115206. }
  115207. }
  115208. declare module BABYLON {
  115209. /**
  115210. * Implementation of the TGA Texture Loader.
  115211. * @hidden
  115212. */
  115213. export class _TGATextureLoader implements IInternalTextureLoader {
  115214. /**
  115215. * Defines wether the loader supports cascade loading the different faces.
  115216. */
  115217. readonly supportCascades: boolean;
  115218. /**
  115219. * This returns if the loader support the current file information.
  115220. * @param extension defines the file extension of the file being loaded
  115221. * @param textureFormatInUse defines the current compressed format in use iun the engine
  115222. * @param fallback defines the fallback internal texture if any
  115223. * @param isBase64 defines whether the texture is encoded as a base64
  115224. * @param isBuffer defines whether the texture data are stored as a buffer
  115225. * @returns true if the loader can load the specified file
  115226. */
  115227. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  115228. /**
  115229. * Transform the url before loading if required.
  115230. * @param rootUrl the url of the texture
  115231. * @param textureFormatInUse defines the current compressed format in use iun the engine
  115232. * @returns the transformed texture
  115233. */
  115234. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  115235. /**
  115236. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  115237. * @param rootUrl the url of the texture
  115238. * @param textureFormatInUse defines the current compressed format in use iun the engine
  115239. * @returns the fallback texture
  115240. */
  115241. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  115242. /**
  115243. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  115244. * @param data contains the texture data
  115245. * @param texture defines the BabylonJS internal texture
  115246. * @param createPolynomials will be true if polynomials have been requested
  115247. * @param onLoad defines the callback to trigger once the texture is ready
  115248. * @param onError defines the callback to trigger in case of error
  115249. */
  115250. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  115251. /**
  115252. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  115253. * @param data contains the texture data
  115254. * @param texture defines the BabylonJS internal texture
  115255. * @param callback defines the method to call once ready to upload
  115256. */
  115257. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  115258. }
  115259. }
  115260. declare module BABYLON {
  115261. /**
  115262. * Info about the .basis files
  115263. */
  115264. class BasisFileInfo {
  115265. /**
  115266. * If the file has alpha
  115267. */
  115268. hasAlpha: boolean;
  115269. /**
  115270. * Info about each image of the basis file
  115271. */
  115272. images: Array<{
  115273. levels: Array<{
  115274. width: number;
  115275. height: number;
  115276. transcodedPixels: ArrayBufferView;
  115277. }>;
  115278. }>;
  115279. }
  115280. /**
  115281. * Result of transcoding a basis file
  115282. */
  115283. class TranscodeResult {
  115284. /**
  115285. * Info about the .basis file
  115286. */
  115287. fileInfo: BasisFileInfo;
  115288. /**
  115289. * Format to use when loading the file
  115290. */
  115291. format: number;
  115292. }
  115293. /**
  115294. * Configuration options for the Basis transcoder
  115295. */
  115296. export class BasisTranscodeConfiguration {
  115297. /**
  115298. * Supported compression formats used to determine the supported output format of the transcoder
  115299. */
  115300. supportedCompressionFormats?: {
  115301. /**
  115302. * etc1 compression format
  115303. */
  115304. etc1?: boolean;
  115305. /**
  115306. * s3tc compression format
  115307. */
  115308. s3tc?: boolean;
  115309. /**
  115310. * pvrtc compression format
  115311. */
  115312. pvrtc?: boolean;
  115313. /**
  115314. * etc2 compression format
  115315. */
  115316. etc2?: boolean;
  115317. };
  115318. /**
  115319. * If mipmap levels should be loaded for transcoded images (Default: true)
  115320. */
  115321. loadMipmapLevels?: boolean;
  115322. /**
  115323. * Index of a single image to load (Default: all images)
  115324. */
  115325. loadSingleImage?: number;
  115326. }
  115327. /**
  115328. * Used to load .Basis files
  115329. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  115330. */
  115331. export class BasisTools {
  115332. private static _IgnoreSupportedFormats;
  115333. /**
  115334. * URL to use when loading the basis transcoder
  115335. */
  115336. static JSModuleURL: string;
  115337. /**
  115338. * URL to use when loading the wasm module for the transcoder
  115339. */
  115340. static WasmModuleURL: string;
  115341. /**
  115342. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  115343. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  115344. * @returns internal format corresponding to the Basis format
  115345. */
  115346. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  115347. private static _WorkerPromise;
  115348. private static _Worker;
  115349. private static _actionId;
  115350. private static _CreateWorkerAsync;
  115351. /**
  115352. * Transcodes a loaded image file to compressed pixel data
  115353. * @param imageData image data to transcode
  115354. * @param config configuration options for the transcoding
  115355. * @returns a promise resulting in the transcoded image
  115356. */
  115357. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  115358. /**
  115359. * Loads a texture from the transcode result
  115360. * @param texture texture load to
  115361. * @param transcodeResult the result of transcoding the basis file to load from
  115362. */
  115363. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  115364. }
  115365. }
  115366. declare module BABYLON {
  115367. /**
  115368. * Loader for .basis file format
  115369. */
  115370. export class _BasisTextureLoader implements IInternalTextureLoader {
  115371. /**
  115372. * Defines whether the loader supports cascade loading the different faces.
  115373. */
  115374. readonly supportCascades: boolean;
  115375. /**
  115376. * This returns if the loader support the current file information.
  115377. * @param extension defines the file extension of the file being loaded
  115378. * @param textureFormatInUse defines the current compressed format in use iun the engine
  115379. * @param fallback defines the fallback internal texture if any
  115380. * @param isBase64 defines whether the texture is encoded as a base64
  115381. * @param isBuffer defines whether the texture data are stored as a buffer
  115382. * @returns true if the loader can load the specified file
  115383. */
  115384. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  115385. /**
  115386. * Transform the url before loading if required.
  115387. * @param rootUrl the url of the texture
  115388. * @param textureFormatInUse defines the current compressed format in use iun the engine
  115389. * @returns the transformed texture
  115390. */
  115391. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  115392. /**
  115393. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  115394. * @param rootUrl the url of the texture
  115395. * @param textureFormatInUse defines the current compressed format in use iun the engine
  115396. * @returns the fallback texture
  115397. */
  115398. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  115399. /**
  115400. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  115401. * @param data contains the texture data
  115402. * @param texture defines the BabylonJS internal texture
  115403. * @param createPolynomials will be true if polynomials have been requested
  115404. * @param onLoad defines the callback to trigger once the texture is ready
  115405. * @param onError defines the callback to trigger in case of error
  115406. */
  115407. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  115408. /**
  115409. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  115410. * @param data contains the texture data
  115411. * @param texture defines the BabylonJS internal texture
  115412. * @param callback defines the method to call once ready to upload
  115413. */
  115414. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  115415. }
  115416. }
  115417. declare module BABYLON {
  115418. /**
  115419. * 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.
  115420. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  115421. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  115422. */
  115423. export class CustomProceduralTexture extends ProceduralTexture {
  115424. private _animate;
  115425. private _time;
  115426. private _config;
  115427. private _texturePath;
  115428. /**
  115429. * Instantiates a new Custom Procedural Texture.
  115430. * 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.
  115431. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  115432. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  115433. * @param name Define the name of the texture
  115434. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  115435. * @param size Define the size of the texture to create
  115436. * @param scene Define the scene the texture belongs to
  115437. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  115438. * @param generateMipMaps Define if the texture should creates mip maps or not
  115439. */
  115440. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  115441. private _loadJson;
  115442. /**
  115443. * Is the texture ready to be used ? (rendered at least once)
  115444. * @returns true if ready, otherwise, false.
  115445. */
  115446. isReady(): boolean;
  115447. /**
  115448. * Render the texture to its associated render target.
  115449. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  115450. */
  115451. render(useCameraPostProcess?: boolean): void;
  115452. /**
  115453. * Update the list of dependant textures samplers in the shader.
  115454. */
  115455. updateTextures(): void;
  115456. /**
  115457. * Update the uniform values of the procedural texture in the shader.
  115458. */
  115459. updateShaderUniforms(): void;
  115460. /**
  115461. * Define if the texture animates or not.
  115462. */
  115463. animate: boolean;
  115464. }
  115465. }
  115466. declare module BABYLON {
  115467. /** @hidden */
  115468. export var noisePixelShader: {
  115469. name: string;
  115470. shader: string;
  115471. };
  115472. }
  115473. declare module BABYLON {
  115474. /**
  115475. * Class used to generate noise procedural textures
  115476. */
  115477. export class NoiseProceduralTexture extends ProceduralTexture {
  115478. private _time;
  115479. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  115480. brightness: number;
  115481. /** Defines the number of octaves to process */
  115482. octaves: number;
  115483. /** Defines the level of persistence (0.8 by default) */
  115484. persistence: number;
  115485. /** Gets or sets animation speed factor (default is 1) */
  115486. animationSpeedFactor: number;
  115487. /**
  115488. * Creates a new NoiseProceduralTexture
  115489. * @param name defines the name fo the texture
  115490. * @param size defines the size of the texture (default is 256)
  115491. * @param scene defines the hosting scene
  115492. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  115493. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  115494. */
  115495. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  115496. private _updateShaderUniforms;
  115497. protected _getDefines(): string;
  115498. /** Generate the current state of the procedural texture */
  115499. render(useCameraPostProcess?: boolean): void;
  115500. /**
  115501. * Serializes this noise procedural texture
  115502. * @returns a serialized noise procedural texture object
  115503. */
  115504. serialize(): any;
  115505. /**
  115506. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  115507. * @param parsedTexture defines parsed texture data
  115508. * @param scene defines the current scene
  115509. * @param rootUrl defines the root URL containing noise procedural texture information
  115510. * @returns a parsed NoiseProceduralTexture
  115511. */
  115512. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  115513. }
  115514. }
  115515. declare module BABYLON {
  115516. /**
  115517. * Raw cube texture where the raw buffers are passed in
  115518. */
  115519. export class RawCubeTexture extends CubeTexture {
  115520. /**
  115521. * Creates a cube texture where the raw buffers are passed in.
  115522. * @param scene defines the scene the texture is attached to
  115523. * @param data defines the array of data to use to create each face
  115524. * @param size defines the size of the textures
  115525. * @param format defines the format of the data
  115526. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  115527. * @param generateMipMaps defines if the engine should generate the mip levels
  115528. * @param invertY defines if data must be stored with Y axis inverted
  115529. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  115530. * @param compression defines the compression used (null by default)
  115531. */
  115532. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  115533. /**
  115534. * Updates the raw cube texture.
  115535. * @param data defines the data to store
  115536. * @param format defines the data format
  115537. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  115538. * @param invertY defines if data must be stored with Y axis inverted
  115539. * @param compression defines the compression used (null by default)
  115540. * @param level defines which level of the texture to update
  115541. */
  115542. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  115543. /**
  115544. * Updates a raw cube texture with RGBD encoded data.
  115545. * @param data defines the array of data [mipmap][face] to use to create each face
  115546. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  115547. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  115548. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  115549. * @returns a promsie that resolves when the operation is complete
  115550. */
  115551. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  115552. /**
  115553. * Clones the raw cube texture.
  115554. * @return a new cube texture
  115555. */
  115556. clone(): CubeTexture;
  115557. /** @hidden */
  115558. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  115559. }
  115560. }
  115561. declare module BABYLON {
  115562. /**
  115563. * Class used to store 3D textures containing user data
  115564. */
  115565. export class RawTexture3D extends Texture {
  115566. /** Gets or sets the texture format to use */
  115567. format: number;
  115568. private _engine;
  115569. /**
  115570. * Create a new RawTexture3D
  115571. * @param data defines the data of the texture
  115572. * @param width defines the width of the texture
  115573. * @param height defines the height of the texture
  115574. * @param depth defines the depth of the texture
  115575. * @param format defines the texture format to use
  115576. * @param scene defines the hosting scene
  115577. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  115578. * @param invertY defines if texture must be stored with Y axis inverted
  115579. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  115580. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  115581. */
  115582. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  115583. /** Gets or sets the texture format to use */
  115584. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  115585. /**
  115586. * Update the texture with new data
  115587. * @param data defines the data to store in the texture
  115588. */
  115589. update(data: ArrayBufferView): void;
  115590. }
  115591. }
  115592. declare module BABYLON {
  115593. /**
  115594. * Creates a refraction texture used by refraction channel of the standard material.
  115595. * It is like a mirror but to see through a material.
  115596. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  115597. */
  115598. export class RefractionTexture extends RenderTargetTexture {
  115599. /**
  115600. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  115601. * 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.
  115602. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  115603. */
  115604. refractionPlane: Plane;
  115605. /**
  115606. * Define how deep under the surface we should see.
  115607. */
  115608. depth: number;
  115609. /**
  115610. * Creates a refraction texture used by refraction channel of the standard material.
  115611. * It is like a mirror but to see through a material.
  115612. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  115613. * @param name Define the texture name
  115614. * @param size Define the size of the underlying texture
  115615. * @param scene Define the scene the refraction belongs to
  115616. * @param generateMipMaps Define if we need to generate mips level for the refraction
  115617. */
  115618. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  115619. /**
  115620. * Clone the refraction texture.
  115621. * @returns the cloned texture
  115622. */
  115623. clone(): RefractionTexture;
  115624. /**
  115625. * Serialize the texture to a JSON representation you could use in Parse later on
  115626. * @returns the serialized JSON representation
  115627. */
  115628. serialize(): any;
  115629. }
  115630. }
  115631. declare module BABYLON {
  115632. /**
  115633. * Defines the options related to the creation of an HtmlElementTexture
  115634. */
  115635. export interface IHtmlElementTextureOptions {
  115636. /**
  115637. * Defines wether mip maps should be created or not.
  115638. */
  115639. generateMipMaps?: boolean;
  115640. /**
  115641. * Defines the sampling mode of the texture.
  115642. */
  115643. samplingMode?: number;
  115644. /**
  115645. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  115646. */
  115647. engine: Nullable<Engine>;
  115648. /**
  115649. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  115650. */
  115651. scene: Nullable<Scene>;
  115652. }
  115653. /**
  115654. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  115655. * To be as efficient as possible depending on your constraints nothing aside the first upload
  115656. * is automatically managed.
  115657. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  115658. * in your application.
  115659. *
  115660. * As the update is not automatic, you need to call them manually.
  115661. */
  115662. export class HtmlElementTexture extends BaseTexture {
  115663. /**
  115664. * The texture URL.
  115665. */
  115666. element: HTMLVideoElement | HTMLCanvasElement;
  115667. private static readonly DefaultOptions;
  115668. private _textureMatrix;
  115669. private _engine;
  115670. private _isVideo;
  115671. private _generateMipMaps;
  115672. private _samplingMode;
  115673. /**
  115674. * Instantiates a HtmlElementTexture from the following parameters.
  115675. *
  115676. * @param name Defines the name of the texture
  115677. * @param element Defines the video or canvas the texture is filled with
  115678. * @param options Defines the other none mandatory texture creation options
  115679. */
  115680. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  115681. private _createInternalTexture;
  115682. /**
  115683. * Returns the texture matrix used in most of the material.
  115684. */
  115685. getTextureMatrix(): Matrix;
  115686. /**
  115687. * Updates the content of the texture.
  115688. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  115689. */
  115690. update(invertY?: Nullable<boolean>): void;
  115691. }
  115692. }
  115693. declare module BABYLON {
  115694. /**
  115695. * Enum used to define the target of a block
  115696. */
  115697. export enum NodeMaterialBlockTargets {
  115698. /** Vertex shader */
  115699. Vertex = 1,
  115700. /** Fragment shader */
  115701. Fragment = 2,
  115702. /** Neutral */
  115703. Neutral = 4,
  115704. /** Vertex and Fragment */
  115705. VertexAndFragment = 3
  115706. }
  115707. }
  115708. declare module BABYLON {
  115709. /**
  115710. * Defines the kind of connection point for node based material
  115711. */
  115712. export enum NodeMaterialBlockConnectionPointTypes {
  115713. /** Float */
  115714. Float = 1,
  115715. /** Int */
  115716. Int = 2,
  115717. /** Vector2 */
  115718. Vector2 = 4,
  115719. /** Vector3 */
  115720. Vector3 = 8,
  115721. /** Vector4 */
  115722. Vector4 = 16,
  115723. /** Color3 */
  115724. Color3 = 32,
  115725. /** Color4 */
  115726. Color4 = 64,
  115727. /** Matrix */
  115728. Matrix = 128,
  115729. /** Detect type based on connection */
  115730. AutoDetect = 1024,
  115731. /** Output type that will be defined by input type */
  115732. BasedOnInput = 2048
  115733. }
  115734. }
  115735. declare module BABYLON {
  115736. /**
  115737. * Root class for all node material optimizers
  115738. */
  115739. export class NodeMaterialOptimizer {
  115740. /**
  115741. * Function used to optimize a NodeMaterial graph
  115742. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  115743. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  115744. */
  115745. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  115746. }
  115747. }
  115748. declare module BABYLON {
  115749. /**
  115750. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  115751. */
  115752. export class TransformBlock extends NodeMaterialBlock {
  115753. /**
  115754. * Defines the value to use to complement W value to transform it to a Vector4
  115755. */
  115756. complementW: number;
  115757. /**
  115758. * Defines the value to use to complement z value to transform it to a Vector4
  115759. */
  115760. complementZ: number;
  115761. /**
  115762. * Creates a new TransformBlock
  115763. * @param name defines the block name
  115764. */
  115765. constructor(name: string);
  115766. /**
  115767. * Gets the current class name
  115768. * @returns the class name
  115769. */
  115770. getClassName(): string;
  115771. /**
  115772. * Gets the vector input
  115773. */
  115774. readonly vector: NodeMaterialConnectionPoint;
  115775. /**
  115776. * Gets the output component
  115777. */
  115778. readonly output: NodeMaterialConnectionPoint;
  115779. /**
  115780. * Gets the matrix transform input
  115781. */
  115782. readonly transform: NodeMaterialConnectionPoint;
  115783. protected _buildBlock(state: NodeMaterialBuildState): this;
  115784. serialize(): any;
  115785. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  115786. }
  115787. }
  115788. declare module BABYLON {
  115789. /**
  115790. * Block used to output the vertex position
  115791. */
  115792. export class VertexOutputBlock extends NodeMaterialBlock {
  115793. /**
  115794. * Creates a new VertexOutputBlock
  115795. * @param name defines the block name
  115796. */
  115797. constructor(name: string);
  115798. /**
  115799. * Gets the current class name
  115800. * @returns the class name
  115801. */
  115802. getClassName(): string;
  115803. /**
  115804. * Gets the vector input component
  115805. */
  115806. readonly vector: NodeMaterialConnectionPoint;
  115807. protected _buildBlock(state: NodeMaterialBuildState): this;
  115808. }
  115809. }
  115810. declare module BABYLON {
  115811. /**
  115812. * Block used to output the final color
  115813. */
  115814. export class FragmentOutputBlock extends NodeMaterialBlock {
  115815. /**
  115816. * Create a new FragmentOutputBlock
  115817. * @param name defines the block name
  115818. */
  115819. constructor(name: string);
  115820. /**
  115821. * Gets the current class name
  115822. * @returns the class name
  115823. */
  115824. getClassName(): string;
  115825. /**
  115826. * Gets the rgba input component
  115827. */
  115828. readonly rgba: NodeMaterialConnectionPoint;
  115829. /**
  115830. * Gets the rgb input component
  115831. */
  115832. readonly rgb: NodeMaterialConnectionPoint;
  115833. /**
  115834. * Gets the a input component
  115835. */
  115836. readonly a: NodeMaterialConnectionPoint;
  115837. protected _buildBlock(state: NodeMaterialBuildState): this;
  115838. }
  115839. }
  115840. declare module BABYLON {
  115841. /**
  115842. * Interface used to configure the node material editor
  115843. */
  115844. export interface INodeMaterialEditorOptions {
  115845. /** Define the URl to load node editor script */
  115846. editorURL?: string;
  115847. }
  115848. /** @hidden */
  115849. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  115850. /** BONES */
  115851. NUM_BONE_INFLUENCERS: number;
  115852. BonesPerMesh: number;
  115853. BONETEXTURE: boolean;
  115854. /** MORPH TARGETS */
  115855. MORPHTARGETS: boolean;
  115856. MORPHTARGETS_NORMAL: boolean;
  115857. MORPHTARGETS_TANGENT: boolean;
  115858. MORPHTARGETS_UV: boolean;
  115859. NUM_MORPH_INFLUENCERS: number;
  115860. /** IMAGE PROCESSING */
  115861. IMAGEPROCESSING: boolean;
  115862. VIGNETTE: boolean;
  115863. VIGNETTEBLENDMODEMULTIPLY: boolean;
  115864. VIGNETTEBLENDMODEOPAQUE: boolean;
  115865. TONEMAPPING: boolean;
  115866. TONEMAPPING_ACES: boolean;
  115867. CONTRAST: boolean;
  115868. EXPOSURE: boolean;
  115869. COLORCURVES: boolean;
  115870. COLORGRADING: boolean;
  115871. COLORGRADING3D: boolean;
  115872. SAMPLER3DGREENDEPTH: boolean;
  115873. SAMPLER3DBGRMAP: boolean;
  115874. IMAGEPROCESSINGPOSTPROCESS: boolean;
  115875. constructor();
  115876. setValue(name: string, value: boolean): void;
  115877. }
  115878. /**
  115879. * Class used to configure NodeMaterial
  115880. */
  115881. export interface INodeMaterialOptions {
  115882. /**
  115883. * Defines if blocks should emit comments
  115884. */
  115885. emitComments: boolean;
  115886. }
  115887. /**
  115888. * Class used to create a node based material built by assembling shader blocks
  115889. */
  115890. export class NodeMaterial extends PushMaterial {
  115891. private static _BuildIdGenerator;
  115892. private _options;
  115893. private _vertexCompilationState;
  115894. private _fragmentCompilationState;
  115895. private _sharedData;
  115896. private _buildId;
  115897. private _buildWasSuccessful;
  115898. private _cachedWorldViewMatrix;
  115899. private _cachedWorldViewProjectionMatrix;
  115900. private _optimizers;
  115901. /** Define the URl to load node editor script */
  115902. static EditorURL: string;
  115903. private BJSNODEMATERIALEDITOR;
  115904. /** Get the inspector from bundle or global */
  115905. private _getGlobalNodeMaterialEditor;
  115906. /**
  115907. * 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)
  115908. */
  115909. ignoreAlpha: boolean;
  115910. /**
  115911. * Defines the maximum number of lights that can be used in the material
  115912. */
  115913. maxSimultaneousLights: number;
  115914. /**
  115915. * Observable raised when the material is built
  115916. */
  115917. onBuildObservable: Observable<NodeMaterial>;
  115918. /**
  115919. * Gets or sets the root nodes of the material vertex shader
  115920. */
  115921. _vertexOutputNodes: NodeMaterialBlock[];
  115922. /**
  115923. * Gets or sets the root nodes of the material fragment (pixel) shader
  115924. */
  115925. _fragmentOutputNodes: NodeMaterialBlock[];
  115926. /** Gets or sets options to control the node material overall behavior */
  115927. options: INodeMaterialOptions;
  115928. /**
  115929. * Default configuration related to image processing available in the standard Material.
  115930. */
  115931. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  115932. /**
  115933. * Gets the image processing configuration used either in this material.
  115934. */
  115935. /**
  115936. * Sets the Default image processing configuration used either in the this material.
  115937. *
  115938. * If sets to null, the scene one is in use.
  115939. */
  115940. imageProcessingConfiguration: ImageProcessingConfiguration;
  115941. /**
  115942. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  115943. */
  115944. attachedBlocks: NodeMaterialBlock[];
  115945. /**
  115946. * Create a new node based material
  115947. * @param name defines the material name
  115948. * @param scene defines the hosting scene
  115949. * @param options defines creation option
  115950. */
  115951. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  115952. /**
  115953. * Gets the current class name of the material e.g. "NodeMaterial"
  115954. * @returns the class name
  115955. */
  115956. getClassName(): string;
  115957. /**
  115958. * Keep track of the image processing observer to allow dispose and replace.
  115959. */
  115960. private _imageProcessingObserver;
  115961. /**
  115962. * Attaches a new image processing configuration to the Standard Material.
  115963. * @param configuration
  115964. */
  115965. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  115966. /**
  115967. * Adds a new optimizer to the list of optimizers
  115968. * @param optimizer defines the optimizers to add
  115969. * @returns the current material
  115970. */
  115971. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  115972. /**
  115973. * Remove an optimizer from the list of optimizers
  115974. * @param optimizer defines the optimizers to remove
  115975. * @returns the current material
  115976. */
  115977. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  115978. /**
  115979. * Add a new block to the list of output nodes
  115980. * @param node defines the node to add
  115981. * @returns the current material
  115982. */
  115983. addOutputNode(node: NodeMaterialBlock): this;
  115984. /**
  115985. * Remove a block from the list of root nodes
  115986. * @param node defines the node to remove
  115987. * @returns the current material
  115988. */
  115989. removeOutputNode(node: NodeMaterialBlock): this;
  115990. private _addVertexOutputNode;
  115991. private _removeVertexOutputNode;
  115992. private _addFragmentOutputNode;
  115993. private _removeFragmentOutputNode;
  115994. /**
  115995. * Specifies if the material will require alpha blending
  115996. * @returns a boolean specifying if alpha blending is needed
  115997. */
  115998. needAlphaBlending(): boolean;
  115999. /**
  116000. * Specifies if this material should be rendered in alpha test mode
  116001. * @returns a boolean specifying if an alpha test is needed.
  116002. */
  116003. needAlphaTesting(): boolean;
  116004. private _initializeBlock;
  116005. private _resetDualBlocks;
  116006. /**
  116007. * Build the material and generates the inner effect
  116008. * @param verbose defines if the build should log activity
  116009. */
  116010. build(verbose?: boolean): void;
  116011. /**
  116012. * Runs an otpimization phase to try to improve the shader code
  116013. */
  116014. optimize(): void;
  116015. private _prepareDefinesForAttributes;
  116016. /**
  116017. * Get if the submesh is ready to be used and all its information available.
  116018. * Child classes can use it to update shaders
  116019. * @param mesh defines the mesh to check
  116020. * @param subMesh defines which submesh to check
  116021. * @param useInstances specifies that instances should be used
  116022. * @returns a boolean indicating that the submesh is ready or not
  116023. */
  116024. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  116025. /**
  116026. * Get a string representing the shaders built by the current node graph
  116027. */
  116028. readonly compiledShaders: string;
  116029. /**
  116030. * Binds the world matrix to the material
  116031. * @param world defines the world transformation matrix
  116032. */
  116033. bindOnlyWorldMatrix(world: Matrix): void;
  116034. /**
  116035. * Binds the submesh to this material by preparing the effect and shader to draw
  116036. * @param world defines the world transformation matrix
  116037. * @param mesh defines the mesh containing the submesh
  116038. * @param subMesh defines the submesh to bind the material to
  116039. */
  116040. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  116041. /**
  116042. * Gets the active textures from the material
  116043. * @returns an array of textures
  116044. */
  116045. getActiveTextures(): BaseTexture[];
  116046. /**
  116047. * Specifies if the material uses a texture
  116048. * @param texture defines the texture to check against the material
  116049. * @returns a boolean specifying if the material uses the texture
  116050. */
  116051. hasTexture(texture: BaseTexture): boolean;
  116052. /**
  116053. * Disposes the material
  116054. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  116055. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  116056. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  116057. */
  116058. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  116059. /** Creates the node editor window. */
  116060. private _createNodeEditor;
  116061. /**
  116062. * Launch the node material editor
  116063. * @param config Define the configuration of the editor
  116064. * @return a promise fulfilled when the node editor is visible
  116065. */
  116066. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  116067. /**
  116068. * Clear the current material
  116069. */
  116070. clear(): void;
  116071. /**
  116072. * Clear the current material and set it to a default state
  116073. */
  116074. setToDefault(): void;
  116075. private _gatherBlocks;
  116076. /**
  116077. * Serializes this material in a JSON representation
  116078. * @returns the serialized material object
  116079. */
  116080. serialize(): any;
  116081. /**
  116082. * Clear the current graph and load a new one from a serialization object
  116083. * @param source defines the JSON representation of the material
  116084. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  116085. */
  116086. loadFromSerialization(source: any, rootUrl?: string): void;
  116087. /**
  116088. * Creates a node material from parsed material data
  116089. * @param source defines the JSON representation of the material
  116090. * @param scene defines the hosting scene
  116091. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  116092. * @returns a new node material
  116093. */
  116094. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  116095. }
  116096. }
  116097. declare module BABYLON {
  116098. /**
  116099. * Block used to read a texture from a sampler
  116100. */
  116101. export class TextureBlock extends NodeMaterialBlock {
  116102. private _defineName;
  116103. private _samplerName;
  116104. private _transformedUVName;
  116105. private _textureTransformName;
  116106. private _textureInfoName;
  116107. private _mainUVName;
  116108. private _mainUVDefineName;
  116109. /**
  116110. * Gets or sets the texture associated with the node
  116111. */
  116112. texture: Nullable<BaseTexture>;
  116113. /**
  116114. * Create a new TextureBlock
  116115. * @param name defines the block name
  116116. */
  116117. constructor(name: string);
  116118. /**
  116119. * Gets the current class name
  116120. * @returns the class name
  116121. */
  116122. getClassName(): string;
  116123. /**
  116124. * Gets the uv input component
  116125. */
  116126. readonly uv: NodeMaterialConnectionPoint;
  116127. /**
  116128. * Gets the output component
  116129. */
  116130. readonly output: NodeMaterialConnectionPoint;
  116131. autoConfigure(): void;
  116132. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  116133. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  116134. isReady(): boolean;
  116135. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  116136. private _injectVertexCode;
  116137. private _writeOutput;
  116138. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  116139. serialize(): any;
  116140. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  116141. }
  116142. }
  116143. declare module BABYLON {
  116144. /**
  116145. * Class used to store shared data between 2 NodeMaterialBuildState
  116146. */
  116147. export class NodeMaterialBuildStateSharedData {
  116148. /**
  116149. * Gets the list of emitted varyings
  116150. */
  116151. varyings: string[];
  116152. /**
  116153. * Gets the varying declaration string
  116154. */
  116155. varyingDeclaration: string;
  116156. /**
  116157. * Input blocks
  116158. */
  116159. inputBlocks: InputBlock[];
  116160. /**
  116161. * Input blocks
  116162. */
  116163. textureBlocks: TextureBlock[];
  116164. /**
  116165. * Bindable blocks (Blocks that need to set data to the effect)
  116166. */
  116167. bindableBlocks: NodeMaterialBlock[];
  116168. /**
  116169. * List of blocks that can provide a compilation fallback
  116170. */
  116171. blocksWithFallbacks: NodeMaterialBlock[];
  116172. /**
  116173. * List of blocks that can provide a define update
  116174. */
  116175. blocksWithDefines: NodeMaterialBlock[];
  116176. /**
  116177. * List of blocks that can provide a repeatable content
  116178. */
  116179. repeatableContentBlocks: NodeMaterialBlock[];
  116180. /**
  116181. * List of blocks that can provide a dynamic list of uniforms
  116182. */
  116183. dynamicUniformBlocks: NodeMaterialBlock[];
  116184. /**
  116185. * List of blocks that can block the isReady function for the material
  116186. */
  116187. blockingBlocks: NodeMaterialBlock[];
  116188. /**
  116189. * Build Id used to avoid multiple recompilations
  116190. */
  116191. buildId: number;
  116192. /** List of emitted variables */
  116193. variableNames: {
  116194. [key: string]: number;
  116195. };
  116196. /** List of emitted defines */
  116197. defineNames: {
  116198. [key: string]: number;
  116199. };
  116200. /** Should emit comments? */
  116201. emitComments: boolean;
  116202. /** Emit build activity */
  116203. verbose: boolean;
  116204. /**
  116205. * Gets the compilation hints emitted at compilation time
  116206. */
  116207. hints: {
  116208. needWorldViewMatrix: boolean;
  116209. needWorldViewProjectionMatrix: boolean;
  116210. needAlphaBlending: boolean;
  116211. needAlphaTesting: boolean;
  116212. };
  116213. /**
  116214. * List of compilation checks
  116215. */
  116216. checks: {
  116217. emitVertex: boolean;
  116218. emitFragment: boolean;
  116219. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  116220. };
  116221. /** Creates a new shared data */
  116222. constructor();
  116223. /**
  116224. * Emits console errors and exceptions if there is a failing check
  116225. */
  116226. emitErrors(): void;
  116227. }
  116228. }
  116229. declare module BABYLON {
  116230. /**
  116231. * Class used to store node based material build state
  116232. */
  116233. export class NodeMaterialBuildState {
  116234. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  116235. supportUniformBuffers: boolean;
  116236. /**
  116237. * Gets the list of emitted attributes
  116238. */
  116239. attributes: string[];
  116240. /**
  116241. * Gets the list of emitted uniforms
  116242. */
  116243. uniforms: string[];
  116244. /**
  116245. * Gets the list of emitted uniform buffers
  116246. */
  116247. uniformBuffers: string[];
  116248. /**
  116249. * Gets the list of emitted samplers
  116250. */
  116251. samplers: string[];
  116252. /**
  116253. * Gets the list of emitted functions
  116254. */
  116255. functions: {
  116256. [key: string]: string;
  116257. };
  116258. /**
  116259. * Gets the target of the compilation state
  116260. */
  116261. target: NodeMaterialBlockTargets;
  116262. /**
  116263. * Gets the list of emitted counters
  116264. */
  116265. counters: {
  116266. [key: string]: number;
  116267. };
  116268. /**
  116269. * Shared data between multiple NodeMaterialBuildState instances
  116270. */
  116271. sharedData: NodeMaterialBuildStateSharedData;
  116272. /** @hidden */
  116273. _vertexState: NodeMaterialBuildState;
  116274. /** @hidden */
  116275. _attributeDeclaration: string;
  116276. /** @hidden */
  116277. _uniformDeclaration: string;
  116278. /** @hidden */
  116279. _samplerDeclaration: string;
  116280. /** @hidden */
  116281. _varyingTransfer: string;
  116282. private _repeatableContentAnchorIndex;
  116283. /** @hidden */
  116284. _builtCompilationString: string;
  116285. /**
  116286. * Gets the emitted compilation strings
  116287. */
  116288. compilationString: string;
  116289. /**
  116290. * Finalize the compilation strings
  116291. * @param state defines the current compilation state
  116292. */
  116293. finalize(state: NodeMaterialBuildState): void;
  116294. /** @hidden */
  116295. readonly _repeatableContentAnchor: string;
  116296. /** @hidden */
  116297. _getFreeVariableName(prefix: string): string;
  116298. /** @hidden */
  116299. _getFreeDefineName(prefix: string): string;
  116300. /** @hidden */
  116301. _excludeVariableName(name: string): void;
  116302. /** @hidden */
  116303. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  116304. /** @hidden */
  116305. _emitFunction(name: string, code: string, comments: string): void;
  116306. /** @hidden */
  116307. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  116308. replaceStrings?: {
  116309. search: RegExp;
  116310. replace: string;
  116311. }[];
  116312. repeatKey?: string;
  116313. }): string;
  116314. /** @hidden */
  116315. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  116316. repeatKey?: string;
  116317. removeAttributes?: boolean;
  116318. removeUniforms?: boolean;
  116319. removeVaryings?: boolean;
  116320. removeIfDef?: boolean;
  116321. replaceStrings?: {
  116322. search: RegExp;
  116323. replace: string;
  116324. }[];
  116325. }, storeKey?: string): void;
  116326. /** @hidden */
  116327. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  116328. /** @hidden */
  116329. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  116330. }
  116331. }
  116332. declare module BABYLON {
  116333. /**
  116334. * Defines a block that can be used inside a node based material
  116335. */
  116336. export class NodeMaterialBlock {
  116337. private _buildId;
  116338. private _buildTarget;
  116339. private _target;
  116340. private _isFinalMerger;
  116341. private _isInput;
  116342. /** @hidden */
  116343. _inputs: NodeMaterialConnectionPoint[];
  116344. /** @hidden */
  116345. _outputs: NodeMaterialConnectionPoint[];
  116346. /**
  116347. * Gets or sets the name of the block
  116348. */
  116349. name: string;
  116350. /**
  116351. * Gets or sets the unique id of the node
  116352. */
  116353. uniqueId: number;
  116354. /**
  116355. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  116356. */
  116357. readonly isFinalMerger: boolean;
  116358. /**
  116359. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  116360. */
  116361. readonly isInput: boolean;
  116362. /**
  116363. * Gets or sets the build Id
  116364. */
  116365. buildId: number;
  116366. /**
  116367. * Gets or sets the target of the block
  116368. */
  116369. target: NodeMaterialBlockTargets;
  116370. /**
  116371. * Gets the list of input points
  116372. */
  116373. readonly inputs: NodeMaterialConnectionPoint[];
  116374. /** Gets the list of output points */
  116375. readonly outputs: NodeMaterialConnectionPoint[];
  116376. /**
  116377. * Find an input by its name
  116378. * @param name defines the name of the input to look for
  116379. * @returns the input or null if not found
  116380. */
  116381. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  116382. /**
  116383. * Find an output by its name
  116384. * @param name defines the name of the outputto look for
  116385. * @returns the output or null if not found
  116386. */
  116387. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  116388. /**
  116389. * Creates a new NodeMaterialBlock
  116390. * @param name defines the block name
  116391. * @param target defines the target of that block (Vertex by default)
  116392. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  116393. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  116394. */
  116395. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  116396. /**
  116397. * Initialize the block and prepare the context for build
  116398. * @param state defines the state that will be used for the build
  116399. */
  116400. initialize(state: NodeMaterialBuildState): void;
  116401. /**
  116402. * Bind data to effect. Will only be called for blocks with isBindable === true
  116403. * @param effect defines the effect to bind data to
  116404. * @param nodeMaterial defines the hosting NodeMaterial
  116405. * @param mesh defines the mesh that will be rendered
  116406. */
  116407. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  116408. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  116409. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  116410. protected _writeFloat(value: number): string;
  116411. /**
  116412. * Gets the current class name e.g. "NodeMaterialBlock"
  116413. * @returns the class name
  116414. */
  116415. getClassName(): string;
  116416. /**
  116417. * Register a new input. Must be called inside a block constructor
  116418. * @param name defines the connection point name
  116419. * @param type defines the connection point type
  116420. * @param isOptional defines a boolean indicating that this input can be omitted
  116421. * @param target defines the target to use to limit the connection point (will be VetexAndFragment by default)
  116422. * @returns the current block
  116423. */
  116424. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  116425. /**
  116426. * Register a new output. Must be called inside a block constructor
  116427. * @param name defines the connection point name
  116428. * @param type defines the connection point type
  116429. * @param target defines the target to use to limit the connection point (will be VetexAndFragment by default)
  116430. * @returns the current block
  116431. */
  116432. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  116433. /**
  116434. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  116435. * @param forOutput defines an optional connection point to check compatibility with
  116436. * @returns the first available input or null
  116437. */
  116438. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  116439. /**
  116440. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  116441. * @param forBlock defines an optional block to check compatibility with
  116442. * @returns the first available input or null
  116443. */
  116444. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  116445. /**
  116446. * Connect current block with another block
  116447. * @param other defines the block to connect with
  116448. * @param options define the various options to help pick the right connections
  116449. * @returns the current block
  116450. */
  116451. connectTo(other: NodeMaterialBlock, options?: {
  116452. input?: string;
  116453. output?: string;
  116454. outputSwizzle?: string;
  116455. }): this | undefined;
  116456. protected _buildBlock(state: NodeMaterialBuildState): void;
  116457. /**
  116458. * Add uniforms, samplers and uniform buffers at compilation time
  116459. * @param state defines the state to update
  116460. * @param nodeMaterial defines the node material requesting the update
  116461. * @param defines defines the material defines to update
  116462. */
  116463. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  116464. /**
  116465. * Add potential fallbacks if shader compilation fails
  116466. * @param mesh defines the mesh to be rendered
  116467. * @param fallbacks defines the current prioritized list of fallbacks
  116468. */
  116469. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  116470. /**
  116471. * Update defines for shader compilation
  116472. * @param mesh defines the mesh to be rendered
  116473. * @param nodeMaterial defines the node material requesting the update
  116474. * @param defines defines the material defines to update
  116475. * @param useInstances specifies that instances should be used
  116476. */
  116477. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  116478. /**
  116479. * Initialize defines for shader compilation
  116480. * @param mesh defines the mesh to be rendered
  116481. * @param nodeMaterial defines the node material requesting the update
  116482. * @param defines defines the material defines to be prepared
  116483. * @param useInstances specifies that instances should be used
  116484. */
  116485. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  116486. /**
  116487. * Lets the block try to connect some inputs automatically
  116488. */
  116489. autoConfigure(): void;
  116490. /**
  116491. * Function called when a block is declared as repeatable content generator
  116492. * @param vertexShaderState defines the current compilation state for the vertex shader
  116493. * @param fragmentShaderState defines the current compilation state for the fragment shader
  116494. * @param mesh defines the mesh to be rendered
  116495. * @param defines defines the material defines to update
  116496. */
  116497. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  116498. /**
  116499. * Checks if the block is ready
  116500. * @param mesh defines the mesh to be rendered
  116501. * @param nodeMaterial defines the node material requesting the update
  116502. * @param defines defines the material defines to update
  116503. * @param useInstances specifies that instances should be used
  116504. * @returns true if the block is ready
  116505. */
  116506. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  116507. private _processBuild;
  116508. /**
  116509. * Compile the current node and generate the shader code
  116510. * @param state defines the current compilation state (uniforms, samplers, current string)
  116511. * @param contextSwitched indicates that the previous block was built for a different context (vertex vs. fragment)
  116512. * @returns true if already built
  116513. */
  116514. build(state: NodeMaterialBuildState, contextSwitched?: boolean): boolean;
  116515. /**
  116516. * Serializes this block in a JSON representation
  116517. * @returns the serialized block object
  116518. */
  116519. serialize(): any;
  116520. /** @hidden */
  116521. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  116522. }
  116523. }
  116524. declare module BABYLON {
  116525. /**
  116526. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  116527. */
  116528. export enum NodeMaterialBlockConnectionPointMode {
  116529. /** Value is an uniform */
  116530. Uniform = 0,
  116531. /** Value is a mesh attribute */
  116532. Attribute = 1,
  116533. /** Value is a varying between vertex and fragment shaders */
  116534. Varying = 2,
  116535. /** Mode is undefined */
  116536. Undefined = 3
  116537. }
  116538. }
  116539. declare module BABYLON {
  116540. /**
  116541. * Enum used to define well known values e.g. values automatically provided by the system
  116542. */
  116543. export enum NodeMaterialWellKnownValues {
  116544. /** World */
  116545. World = 1,
  116546. /** View */
  116547. View = 2,
  116548. /** Projection */
  116549. Projection = 3,
  116550. /** ViewProjection */
  116551. ViewProjection = 4,
  116552. /** WorldView */
  116553. WorldView = 5,
  116554. /** WorldViewProjection */
  116555. WorldViewProjection = 6,
  116556. /** CameraPosition */
  116557. CameraPosition = 7,
  116558. /** Fog Color */
  116559. FogColor = 8
  116560. }
  116561. }
  116562. declare module BABYLON {
  116563. /**
  116564. * Contains position and normal vectors for a vertex
  116565. */
  116566. export class PositionNormalVertex {
  116567. /** the position of the vertex (defaut: 0,0,0) */
  116568. position: Vector3;
  116569. /** the normal of the vertex (defaut: 0,1,0) */
  116570. normal: Vector3;
  116571. /**
  116572. * Creates a PositionNormalVertex
  116573. * @param position the position of the vertex (defaut: 0,0,0)
  116574. * @param normal the normal of the vertex (defaut: 0,1,0)
  116575. */
  116576. constructor(
  116577. /** the position of the vertex (defaut: 0,0,0) */
  116578. position?: Vector3,
  116579. /** the normal of the vertex (defaut: 0,1,0) */
  116580. normal?: Vector3);
  116581. /**
  116582. * Clones the PositionNormalVertex
  116583. * @returns the cloned PositionNormalVertex
  116584. */
  116585. clone(): PositionNormalVertex;
  116586. }
  116587. /**
  116588. * Contains position, normal and uv vectors for a vertex
  116589. */
  116590. export class PositionNormalTextureVertex {
  116591. /** the position of the vertex (defaut: 0,0,0) */
  116592. position: Vector3;
  116593. /** the normal of the vertex (defaut: 0,1,0) */
  116594. normal: Vector3;
  116595. /** the uv of the vertex (default: 0,0) */
  116596. uv: Vector2;
  116597. /**
  116598. * Creates a PositionNormalTextureVertex
  116599. * @param position the position of the vertex (defaut: 0,0,0)
  116600. * @param normal the normal of the vertex (defaut: 0,1,0)
  116601. * @param uv the uv of the vertex (default: 0,0)
  116602. */
  116603. constructor(
  116604. /** the position of the vertex (defaut: 0,0,0) */
  116605. position?: Vector3,
  116606. /** the normal of the vertex (defaut: 0,1,0) */
  116607. normal?: Vector3,
  116608. /** the uv of the vertex (default: 0,0) */
  116609. uv?: Vector2);
  116610. /**
  116611. * Clones the PositionNormalTextureVertex
  116612. * @returns the cloned PositionNormalTextureVertex
  116613. */
  116614. clone(): PositionNormalTextureVertex;
  116615. }
  116616. }
  116617. declare module BABYLON {
  116618. /**
  116619. * Block used to expose an input value
  116620. */
  116621. export class InputBlock extends NodeMaterialBlock {
  116622. private _mode;
  116623. private _associatedVariableName;
  116624. private _storedValue;
  116625. private _valueCallback;
  116626. private _type;
  116627. /** @hidden */
  116628. _wellKnownValue: Nullable<NodeMaterialWellKnownValues>;
  116629. /**
  116630. * Gets or sets the connection point type (default is float)
  116631. */
  116632. readonly type: NodeMaterialBlockConnectionPointTypes;
  116633. /**
  116634. * Creates a new InputBlock
  116635. * @param name defines the block name
  116636. * @param target defines the target of that block (Vertex by default)
  116637. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  116638. */
  116639. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  116640. /**
  116641. * Gets the output component
  116642. */
  116643. readonly output: NodeMaterialConnectionPoint;
  116644. /**
  116645. * Set the source of this connection point to a vertex attribute
  116646. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  116647. * @returns the current connection point
  116648. */
  116649. setAsAttribute(attributeName?: string): InputBlock;
  116650. /**
  116651. * Set the source of this connection point to a well known value
  116652. * @param value define the well known value to use (world, view, etc...) or null to switch to manual value
  116653. * @returns the current connection point
  116654. */
  116655. setAsWellKnownValue(value: Nullable<NodeMaterialWellKnownValues>): InputBlock;
  116656. /**
  116657. * Gets or sets the value of that point.
  116658. * Please note that this value will be ignored if valueCallback is defined
  116659. */
  116660. value: any;
  116661. /**
  116662. * Gets or sets a callback used to get the value of that point.
  116663. * Please note that setting this value will force the connection point to ignore the value property
  116664. */
  116665. valueCallback: () => any;
  116666. /**
  116667. * Gets or sets the associated variable name in the shader
  116668. */
  116669. associatedVariableName: string;
  116670. /**
  116671. * Gets a boolean indicating that this connection point not defined yet
  116672. */
  116673. readonly isUndefined: boolean;
  116674. /**
  116675. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  116676. * In this case the connection point name must be the name of the uniform to use.
  116677. * Can only be set on inputs
  116678. */
  116679. isUniform: boolean;
  116680. /**
  116681. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  116682. * In this case the connection point name must be the name of the attribute to use
  116683. * Can only be set on inputs
  116684. */
  116685. isAttribute: boolean;
  116686. /**
  116687. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  116688. * Can only be set on exit points
  116689. */
  116690. isVarying: boolean;
  116691. /**
  116692. * Gets a boolean indicating that the current connection point is a well known value
  116693. */
  116694. readonly isWellKnownValue: boolean;
  116695. /**
  116696. * Gets or sets the current well known value or null if not defined as well know value
  116697. */
  116698. wellKnownValue: Nullable<NodeMaterialWellKnownValues>;
  116699. /**
  116700. * Gets the current class name
  116701. * @returns the class name
  116702. */
  116703. getClassName(): string;
  116704. private _emitDefine;
  116705. /**
  116706. * Set the input block to its default value (based on its type)
  116707. */
  116708. setDefaultValue(): void;
  116709. private _emit;
  116710. /** @hidden */
  116711. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  116712. /** @hidden */
  116713. _transmit(effect: Effect, scene: Scene): void;
  116714. protected _buildBlock(state: NodeMaterialBuildState): void;
  116715. serialize(): any;
  116716. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  116717. }
  116718. }
  116719. declare module BABYLON {
  116720. /**
  116721. * Defines a connection point for a block
  116722. */
  116723. export class NodeMaterialConnectionPoint {
  116724. /** @hidden */
  116725. _ownerBlock: NodeMaterialBlock;
  116726. /** @hidden */
  116727. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  116728. private _endpoints;
  116729. private _associatedVariableName;
  116730. /** @hidden */
  116731. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  116732. private _type;
  116733. /** @hidden */
  116734. _enforceAssociatedVariableName: boolean;
  116735. /**
  116736. * Gets or sets the additional types supported byt this connection point
  116737. */
  116738. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  116739. /**
  116740. * Gets or sets the associated variable name in the shader
  116741. */
  116742. associatedVariableName: string;
  116743. /**
  116744. * Gets or sets the connection point type (default is float)
  116745. */
  116746. type: NodeMaterialBlockConnectionPointTypes;
  116747. /**
  116748. * Gets or sets the connection point name
  116749. */
  116750. name: string;
  116751. /**
  116752. * Gets or sets a boolean indicating that this connection point can be omitted
  116753. */
  116754. isOptional: boolean;
  116755. /**
  116756. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  116757. */
  116758. define: string;
  116759. /** Gets or sets the target of that connection point */
  116760. target: NodeMaterialBlockTargets;
  116761. /**
  116762. * Gets a boolean indicating that the current point is connected
  116763. */
  116764. readonly isConnected: boolean;
  116765. /**
  116766. * Gets a boolean indicating that the current point is connected to an input block
  116767. */
  116768. readonly isConnectedToInput: boolean;
  116769. /**
  116770. * Gets a the connected input block (if any)
  116771. */
  116772. readonly connectInputBlock: Nullable<InputBlock>;
  116773. /** Get the other side of the connection (if any) */
  116774. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  116775. /** Get the block that owns this connection point */
  116776. readonly ownerBlock: NodeMaterialBlock;
  116777. /** Get the block connected on the other side of this connection (if any) */
  116778. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  116779. /** Get the block connected on the endpoints of this connection (if any) */
  116780. readonly connectedBlocks: Array<NodeMaterialBlock>;
  116781. /** Gets the list of connected endpoints */
  116782. readonly endpoints: NodeMaterialConnectionPoint[];
  116783. /**
  116784. * Creates a new connection point
  116785. * @param name defines the connection point name
  116786. * @param ownerBlock defines the block hosting this connection point
  116787. */
  116788. constructor(name: string, ownerBlock: NodeMaterialBlock);
  116789. /**
  116790. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  116791. * @returns the class name
  116792. */
  116793. getClassName(): string;
  116794. /**
  116795. * Gets an boolean indicating if the current point can be connected to another point
  116796. * @param connectionPoint defines the other connection point
  116797. * @returns true if the connection is possible
  116798. */
  116799. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  116800. /**
  116801. * Connect this point to another connection point
  116802. * @param connectionPoint defines the other connection point
  116803. * @returns the current connection point
  116804. */
  116805. connectTo(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  116806. /**
  116807. * Disconnect this point from one of his endpoint
  116808. * @param endpoint defines the other connection point
  116809. * @returns the current connection point
  116810. */
  116811. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  116812. /**
  116813. * Serializes this point in a JSON representation
  116814. * @returns the serialized point object
  116815. */
  116816. serialize(): any;
  116817. }
  116818. }
  116819. declare module BABYLON {
  116820. /**
  116821. * Block used to add support for vertex skinning (bones)
  116822. */
  116823. export class BonesBlock extends NodeMaterialBlock {
  116824. /**
  116825. * Creates a new BonesBlock
  116826. * @param name defines the block name
  116827. */
  116828. constructor(name: string);
  116829. /**
  116830. * Initialize the block and prepare the context for build
  116831. * @param state defines the state that will be used for the build
  116832. */
  116833. initialize(state: NodeMaterialBuildState): void;
  116834. /**
  116835. * Gets the current class name
  116836. * @returns the class name
  116837. */
  116838. getClassName(): string;
  116839. /**
  116840. * Gets the matrix indices input component
  116841. */
  116842. readonly matricesIndices: NodeMaterialConnectionPoint;
  116843. /**
  116844. * Gets the matrix weights input component
  116845. */
  116846. readonly matricesWeights: NodeMaterialConnectionPoint;
  116847. /**
  116848. * Gets the extra matrix indices input component
  116849. */
  116850. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  116851. /**
  116852. * Gets the extra matrix weights input component
  116853. */
  116854. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  116855. /**
  116856. * Gets the world input component
  116857. */
  116858. readonly world: NodeMaterialConnectionPoint;
  116859. /**
  116860. * Gets the output component
  116861. */
  116862. readonly output: NodeMaterialConnectionPoint;
  116863. autoConfigure(): void;
  116864. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  116865. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  116866. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  116867. protected _buildBlock(state: NodeMaterialBuildState): this;
  116868. }
  116869. }
  116870. declare module BABYLON {
  116871. /**
  116872. * Block used to add support for instances
  116873. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  116874. */
  116875. export class InstancesBlock extends NodeMaterialBlock {
  116876. /**
  116877. * Creates a new InstancesBlock
  116878. * @param name defines the block name
  116879. */
  116880. constructor(name: string);
  116881. /**
  116882. * Gets the current class name
  116883. * @returns the class name
  116884. */
  116885. getClassName(): string;
  116886. /**
  116887. * Gets the first world row input component
  116888. */
  116889. readonly world0: NodeMaterialConnectionPoint;
  116890. /**
  116891. * Gets the second world row input component
  116892. */
  116893. readonly world1: NodeMaterialConnectionPoint;
  116894. /**
  116895. * Gets the third world row input component
  116896. */
  116897. readonly world2: NodeMaterialConnectionPoint;
  116898. /**
  116899. * Gets the forth world row input component
  116900. */
  116901. readonly world3: NodeMaterialConnectionPoint;
  116902. /**
  116903. * Gets the world input component
  116904. */
  116905. readonly world: NodeMaterialConnectionPoint;
  116906. /**
  116907. * Gets the output component
  116908. */
  116909. readonly output: NodeMaterialConnectionPoint;
  116910. autoConfigure(): void;
  116911. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  116912. protected _buildBlock(state: NodeMaterialBuildState): this;
  116913. }
  116914. }
  116915. declare module BABYLON {
  116916. /**
  116917. * Block used to add morph targets support to vertex shader
  116918. */
  116919. export class MorphTargetsBlock extends NodeMaterialBlock {
  116920. private _repeatableContentAnchor;
  116921. private _repeatebleContentGenerated;
  116922. /**
  116923. * Create a new MorphTargetsBlock
  116924. * @param name defines the block name
  116925. */
  116926. constructor(name: string);
  116927. /**
  116928. * Gets the current class name
  116929. * @returns the class name
  116930. */
  116931. getClassName(): string;
  116932. /**
  116933. * Gets the position input component
  116934. */
  116935. readonly position: NodeMaterialConnectionPoint;
  116936. /**
  116937. * Gets the normal input component
  116938. */
  116939. readonly normal: NodeMaterialConnectionPoint;
  116940. /**
  116941. * Gets the tangent input component
  116942. */
  116943. readonly tangent: NodeMaterialConnectionPoint;
  116944. /**
  116945. * Gets the tangent input component
  116946. */
  116947. readonly uv: NodeMaterialConnectionPoint;
  116948. /**
  116949. * Gets the position output component
  116950. */
  116951. readonly positionOutput: NodeMaterialConnectionPoint;
  116952. /**
  116953. * Gets the normal output component
  116954. */
  116955. readonly normalOutput: NodeMaterialConnectionPoint;
  116956. /**
  116957. * Gets the tangent output component
  116958. */
  116959. readonly tangentOutput: NodeMaterialConnectionPoint;
  116960. /**
  116961. * Gets the tangent output component
  116962. */
  116963. readonly uvOutput: NodeMaterialConnectionPoint;
  116964. initialize(state: NodeMaterialBuildState): void;
  116965. autoConfigure(): void;
  116966. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  116967. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  116968. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  116969. protected _buildBlock(state: NodeMaterialBuildState): this;
  116970. }
  116971. }
  116972. declare module BABYLON {
  116973. /**
  116974. * Block used to add an alpha test in the fragment shader
  116975. */
  116976. export class AlphaTestBlock extends NodeMaterialBlock {
  116977. /**
  116978. * Gets or sets the alpha value where alpha testing happens
  116979. */
  116980. alphaCutOff: number;
  116981. /**
  116982. * Create a new AlphaTestBlock
  116983. * @param name defines the block name
  116984. */
  116985. constructor(name: string);
  116986. /**
  116987. * Gets the current class name
  116988. * @returns the class name
  116989. */
  116990. getClassName(): string;
  116991. /**
  116992. * Gets the color input component
  116993. */
  116994. readonly color: NodeMaterialConnectionPoint;
  116995. /**
  116996. * Gets the alpha input component
  116997. */
  116998. readonly alpha: NodeMaterialConnectionPoint;
  116999. protected _buildBlock(state: NodeMaterialBuildState): this;
  117000. }
  117001. }
  117002. declare module BABYLON {
  117003. /**
  117004. * Block used to create a Color3/4 out of individual inputs (one for each component)
  117005. */
  117006. export class ColorMergerBlock extends NodeMaterialBlock {
  117007. /**
  117008. * Create a new ColorMergerBlock
  117009. * @param name defines the block name
  117010. */
  117011. constructor(name: string);
  117012. /**
  117013. * Gets the current class name
  117014. * @returns the class name
  117015. */
  117016. getClassName(): string;
  117017. /**
  117018. * Gets the r component (input)
  117019. */
  117020. readonly r: NodeMaterialConnectionPoint;
  117021. /**
  117022. * Gets the g component (input)
  117023. */
  117024. readonly g: NodeMaterialConnectionPoint;
  117025. /**
  117026. * Gets the b component (input)
  117027. */
  117028. readonly b: NodeMaterialConnectionPoint;
  117029. /**
  117030. * Gets the a component (input)
  117031. */
  117032. readonly a: NodeMaterialConnectionPoint;
  117033. /**
  117034. * Gets the rgba component (output)
  117035. */
  117036. readonly rgba: NodeMaterialConnectionPoint;
  117037. /**
  117038. * Gets the rgb component (output)
  117039. */
  117040. readonly rgb: NodeMaterialConnectionPoint;
  117041. protected _buildBlock(state: NodeMaterialBuildState): this;
  117042. }
  117043. }
  117044. declare module BABYLON {
  117045. /**
  117046. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  117047. */
  117048. export class VectorMergerBlock extends NodeMaterialBlock {
  117049. /**
  117050. * Create a new VectorMergerBlock
  117051. * @param name defines the block name
  117052. */
  117053. constructor(name: string);
  117054. /**
  117055. * Gets the current class name
  117056. * @returns the class name
  117057. */
  117058. getClassName(): string;
  117059. /**
  117060. * Gets the x component (input)
  117061. */
  117062. readonly x: NodeMaterialConnectionPoint;
  117063. /**
  117064. * Gets the y component (input)
  117065. */
  117066. readonly y: NodeMaterialConnectionPoint;
  117067. /**
  117068. * Gets the z component (input)
  117069. */
  117070. readonly z: NodeMaterialConnectionPoint;
  117071. /**
  117072. * Gets the w component (input)
  117073. */
  117074. readonly w: NodeMaterialConnectionPoint;
  117075. /**
  117076. * Gets the xyzw component (output)
  117077. */
  117078. readonly xyzw: NodeMaterialConnectionPoint;
  117079. /**
  117080. * Gets the xyz component (output)
  117081. */
  117082. readonly xyz: NodeMaterialConnectionPoint;
  117083. /**
  117084. * Gets the xy component (output)
  117085. */
  117086. readonly xy: NodeMaterialConnectionPoint;
  117087. protected _buildBlock(state: NodeMaterialBuildState): this;
  117088. }
  117089. }
  117090. declare module BABYLON {
  117091. /**
  117092. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  117093. */
  117094. export class ColorSplitterBlock extends NodeMaterialBlock {
  117095. /**
  117096. * Create a new ColorSplitterBlock
  117097. * @param name defines the block name
  117098. */
  117099. constructor(name: string);
  117100. /**
  117101. * Gets the current class name
  117102. * @returns the class name
  117103. */
  117104. getClassName(): string;
  117105. /**
  117106. * Gets the rgba component (input)
  117107. */
  117108. readonly rgba: NodeMaterialConnectionPoint;
  117109. /**
  117110. * Gets the rgb component (input)
  117111. */
  117112. readonly rgbIn: NodeMaterialConnectionPoint;
  117113. /**
  117114. * Gets the rgb component (output)
  117115. */
  117116. readonly rgbOut: NodeMaterialConnectionPoint;
  117117. /**
  117118. * Gets the r component (output)
  117119. */
  117120. readonly r: NodeMaterialConnectionPoint;
  117121. /**
  117122. * Gets the g component (output)
  117123. */
  117124. readonly g: NodeMaterialConnectionPoint;
  117125. /**
  117126. * Gets the b component (output)
  117127. */
  117128. readonly b: NodeMaterialConnectionPoint;
  117129. /**
  117130. * Gets the a component (output)
  117131. */
  117132. readonly a: NodeMaterialConnectionPoint;
  117133. protected _buildBlock(state: NodeMaterialBuildState): this;
  117134. }
  117135. }
  117136. declare module BABYLON {
  117137. /**
  117138. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  117139. */
  117140. export class VectorSplitterBlock extends NodeMaterialBlock {
  117141. /**
  117142. * Create a new VectorSplitterBlock
  117143. * @param name defines the block name
  117144. */
  117145. constructor(name: string);
  117146. /**
  117147. * Gets the current class name
  117148. * @returns the class name
  117149. */
  117150. getClassName(): string;
  117151. /**
  117152. * Gets the xyzw component (input)
  117153. */
  117154. readonly xyzw: NodeMaterialConnectionPoint;
  117155. /**
  117156. * Gets the xyz component (input)
  117157. */
  117158. readonly xyzIn: NodeMaterialConnectionPoint;
  117159. /**
  117160. * Gets the xyz component (output)
  117161. */
  117162. readonly xyzOut: NodeMaterialConnectionPoint;
  117163. /**
  117164. * Gets the xy component (output)
  117165. */
  117166. readonly xy: NodeMaterialConnectionPoint;
  117167. /**
  117168. * Gets the x component (output)
  117169. */
  117170. readonly x: NodeMaterialConnectionPoint;
  117171. /**
  117172. * Gets the y component (output)
  117173. */
  117174. readonly y: NodeMaterialConnectionPoint;
  117175. /**
  117176. * Gets the z component (output)
  117177. */
  117178. readonly z: NodeMaterialConnectionPoint;
  117179. /**
  117180. * Gets the w component (output)
  117181. */
  117182. readonly w: NodeMaterialConnectionPoint;
  117183. protected _buildBlock(state: NodeMaterialBuildState): this;
  117184. }
  117185. }
  117186. declare module BABYLON {
  117187. /**
  117188. * Block used to add image processing support to fragment shader
  117189. */
  117190. export class ImageProcessingBlock extends NodeMaterialBlock {
  117191. /**
  117192. * Create a new ImageProcessingBlock
  117193. * @param name defines the block name
  117194. */
  117195. constructor(name: string);
  117196. /**
  117197. * Gets the current class name
  117198. * @returns the class name
  117199. */
  117200. getClassName(): string;
  117201. /**
  117202. * Gets the color input component
  117203. */
  117204. readonly color: NodeMaterialConnectionPoint;
  117205. /**
  117206. * Gets the output component
  117207. */
  117208. readonly output: NodeMaterialConnectionPoint;
  117209. /**
  117210. * Initialize the block and prepare the context for build
  117211. * @param state defines the state that will be used for the build
  117212. */
  117213. initialize(state: NodeMaterialBuildState): void;
  117214. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  117215. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  117216. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  117217. protected _buildBlock(state: NodeMaterialBuildState): this;
  117218. }
  117219. }
  117220. declare module BABYLON {
  117221. /**
  117222. * Block used to add support for scene fog
  117223. */
  117224. export class FogBlock extends NodeMaterialBlock {
  117225. private _fogDistanceName;
  117226. private _fogParameters;
  117227. /**
  117228. * Create a new FogBlock
  117229. * @param name defines the block name
  117230. */
  117231. constructor(name: string);
  117232. /**
  117233. * Gets the current class name
  117234. * @returns the class name
  117235. */
  117236. getClassName(): string;
  117237. /**
  117238. * Gets the world position input component
  117239. */
  117240. readonly worldPosition: NodeMaterialConnectionPoint;
  117241. /**
  117242. * Gets the view input component
  117243. */
  117244. readonly view: NodeMaterialConnectionPoint;
  117245. /**
  117246. * Gets the color input component
  117247. */
  117248. readonly color: NodeMaterialConnectionPoint;
  117249. /**
  117250. * Gets the fog color input component
  117251. */
  117252. readonly fogColor: NodeMaterialConnectionPoint;
  117253. /**
  117254. * Gets the output component
  117255. */
  117256. readonly output: NodeMaterialConnectionPoint;
  117257. autoConfigure(): void;
  117258. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  117259. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  117260. protected _buildBlock(state: NodeMaterialBuildState): this;
  117261. }
  117262. }
  117263. declare module BABYLON {
  117264. /**
  117265. * Block used to add light in the fragment shader
  117266. */
  117267. export class LightBlock extends NodeMaterialBlock {
  117268. private _lightId;
  117269. /**
  117270. * Gets or sets the light associated with this block
  117271. */
  117272. light: Nullable<Light>;
  117273. /**
  117274. * Create a new LightBlock
  117275. * @param name defines the block name
  117276. */
  117277. constructor(name: string);
  117278. /**
  117279. * Gets the current class name
  117280. * @returns the class name
  117281. */
  117282. getClassName(): string;
  117283. /**
  117284. * Gets the world position input component
  117285. */
  117286. readonly worldPosition: NodeMaterialConnectionPoint;
  117287. /**
  117288. * Gets the world normal input component
  117289. */
  117290. readonly worldNormal: NodeMaterialConnectionPoint;
  117291. /**
  117292. * Gets the camera (or eye) position component
  117293. */
  117294. readonly cameraPosition: NodeMaterialConnectionPoint;
  117295. /**
  117296. * Gets the diffuse output component
  117297. */
  117298. readonly diffuseOutput: NodeMaterialConnectionPoint;
  117299. /**
  117300. * Gets the specular output component
  117301. */
  117302. readonly specularOutput: NodeMaterialConnectionPoint;
  117303. autoConfigure(): void;
  117304. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  117305. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  117306. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  117307. private _injectVertexCode;
  117308. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  117309. serialize(): any;
  117310. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  117311. }
  117312. }
  117313. declare module BABYLON {
  117314. /**
  117315. * Block used to multiply 2 values
  117316. */
  117317. export class MultiplyBlock extends NodeMaterialBlock {
  117318. /**
  117319. * Creates a new MultiplyBlock
  117320. * @param name defines the block name
  117321. */
  117322. constructor(name: string);
  117323. /**
  117324. * Gets the current class name
  117325. * @returns the class name
  117326. */
  117327. getClassName(): string;
  117328. /**
  117329. * Gets the left operand input component
  117330. */
  117331. readonly left: NodeMaterialConnectionPoint;
  117332. /**
  117333. * Gets the right operand input component
  117334. */
  117335. readonly right: NodeMaterialConnectionPoint;
  117336. /**
  117337. * Gets the output component
  117338. */
  117339. readonly output: NodeMaterialConnectionPoint;
  117340. protected _buildBlock(state: NodeMaterialBuildState): this;
  117341. }
  117342. }
  117343. declare module BABYLON {
  117344. /**
  117345. * Block used to add 2 vectors
  117346. */
  117347. export class AddBlock extends NodeMaterialBlock {
  117348. /**
  117349. * Creates a new AddBlock
  117350. * @param name defines the block name
  117351. */
  117352. constructor(name: string);
  117353. /**
  117354. * Gets the current class name
  117355. * @returns the class name
  117356. */
  117357. getClassName(): string;
  117358. /**
  117359. * Gets the left operand input component
  117360. */
  117361. readonly left: NodeMaterialConnectionPoint;
  117362. /**
  117363. * Gets the right operand input component
  117364. */
  117365. readonly right: NodeMaterialConnectionPoint;
  117366. /**
  117367. * Gets the output component
  117368. */
  117369. readonly output: NodeMaterialConnectionPoint;
  117370. protected _buildBlock(state: NodeMaterialBuildState): this;
  117371. }
  117372. }
  117373. declare module BABYLON {
  117374. /**
  117375. * Block used to clamp a float
  117376. */
  117377. export class ClampBlock extends NodeMaterialBlock {
  117378. /** Gets or sets the minimum range */
  117379. minimum: number;
  117380. /** Gets or sets the maximum range */
  117381. maximum: number;
  117382. /**
  117383. * Creates a new ClampBlock
  117384. * @param name defines the block name
  117385. */
  117386. constructor(name: string);
  117387. /**
  117388. * Gets the current class name
  117389. * @returns the class name
  117390. */
  117391. getClassName(): string;
  117392. /**
  117393. * Gets the value input component
  117394. */
  117395. readonly value: NodeMaterialConnectionPoint;
  117396. /**
  117397. * Gets the output component
  117398. */
  117399. readonly output: NodeMaterialConnectionPoint;
  117400. protected _buildBlock(state: NodeMaterialBuildState): this;
  117401. }
  117402. }
  117403. declare module BABYLON {
  117404. /**
  117405. * Block used to apply a cross product between 2 vectors
  117406. */
  117407. export class CrossBlock extends NodeMaterialBlock {
  117408. /**
  117409. * Creates a new CrossBlock
  117410. * @param name defines the block name
  117411. */
  117412. constructor(name: string);
  117413. /**
  117414. * Gets the current class name
  117415. * @returns the class name
  117416. */
  117417. getClassName(): string;
  117418. /**
  117419. * Gets the left operand input component
  117420. */
  117421. readonly left: NodeMaterialConnectionPoint;
  117422. /**
  117423. * Gets the right operand input component
  117424. */
  117425. readonly right: NodeMaterialConnectionPoint;
  117426. /**
  117427. * Gets the output component
  117428. */
  117429. readonly output: NodeMaterialConnectionPoint;
  117430. protected _buildBlock(state: NodeMaterialBuildState): this;
  117431. }
  117432. }
  117433. declare module BABYLON {
  117434. /**
  117435. * Block used to apply a dot product between 2 vectors
  117436. */
  117437. export class DotBlock extends NodeMaterialBlock {
  117438. /**
  117439. * Creates a new DotBlock
  117440. * @param name defines the block name
  117441. */
  117442. constructor(name: string);
  117443. /**
  117444. * Gets the current class name
  117445. * @returns the class name
  117446. */
  117447. getClassName(): string;
  117448. /**
  117449. * Gets the left operand input component
  117450. */
  117451. readonly left: NodeMaterialConnectionPoint;
  117452. /**
  117453. * Gets the right operand input component
  117454. */
  117455. readonly right: NodeMaterialConnectionPoint;
  117456. /**
  117457. * Gets the output component
  117458. */
  117459. readonly output: NodeMaterialConnectionPoint;
  117460. protected _buildBlock(state: NodeMaterialBuildState): this;
  117461. }
  117462. }
  117463. declare module BABYLON {
  117464. /**
  117465. * Block used to remap a float from a range to a new one
  117466. */
  117467. export class RemapBlock extends NodeMaterialBlock {
  117468. /**
  117469. * Gets or sets the source range
  117470. */
  117471. sourceRange: Vector2;
  117472. /**
  117473. * Gets or sets the target range
  117474. */
  117475. targetRange: Vector2;
  117476. /**
  117477. * Creates a new RemapBlock
  117478. * @param name defines the block name
  117479. */
  117480. constructor(name: string);
  117481. /**
  117482. * Gets the current class name
  117483. * @returns the class name
  117484. */
  117485. getClassName(): string;
  117486. /**
  117487. * Gets the input component
  117488. */
  117489. readonly input: NodeMaterialConnectionPoint;
  117490. /**
  117491. * Gets the output component
  117492. */
  117493. readonly output: NodeMaterialConnectionPoint;
  117494. protected _buildBlock(state: NodeMaterialBuildState): this;
  117495. }
  117496. }
  117497. declare module BABYLON {
  117498. /**
  117499. * Block used to normalize a vector
  117500. */
  117501. export class NormalizeBlock extends NodeMaterialBlock {
  117502. /**
  117503. * Creates a new NormalizeBlock
  117504. * @param name defines the block name
  117505. */
  117506. constructor(name: string);
  117507. /**
  117508. * Gets the current class name
  117509. * @returns the class name
  117510. */
  117511. getClassName(): string;
  117512. /**
  117513. * Gets the input component
  117514. */
  117515. readonly input: NodeMaterialConnectionPoint;
  117516. /**
  117517. * Gets the output component
  117518. */
  117519. readonly output: NodeMaterialConnectionPoint;
  117520. protected _buildBlock(state: NodeMaterialBuildState): this;
  117521. }
  117522. }
  117523. declare module BABYLON {
  117524. /**
  117525. * Effect Render Options
  117526. */
  117527. export interface IEffectRendererOptions {
  117528. /**
  117529. * Defines the vertices positions.
  117530. */
  117531. positions?: number[];
  117532. /**
  117533. * Defines the indices.
  117534. */
  117535. indices?: number[];
  117536. }
  117537. /**
  117538. * Helper class to render one or more effects
  117539. */
  117540. export class EffectRenderer {
  117541. private engine;
  117542. private static _DefaultOptions;
  117543. private _vertexBuffers;
  117544. private _indexBuffer;
  117545. private _ringBufferIndex;
  117546. private _ringScreenBuffer;
  117547. private _fullscreenViewport;
  117548. private _getNextFrameBuffer;
  117549. /**
  117550. * Creates an effect renderer
  117551. * @param engine the engine to use for rendering
  117552. * @param options defines the options of the effect renderer
  117553. */
  117554. constructor(engine: Engine, options?: IEffectRendererOptions);
  117555. /**
  117556. * Sets the current viewport in normalized coordinates 0-1
  117557. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  117558. */
  117559. setViewport(viewport?: Viewport): void;
  117560. /**
  117561. * Sets the current effect wrapper to use during draw.
  117562. * The effect needs to be ready before calling this api.
  117563. * This also sets the default full screen position attribute.
  117564. * @param effectWrapper Defines the effect to draw with
  117565. */
  117566. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  117567. /**
  117568. * Draws a full screen quad.
  117569. */
  117570. draw(): void;
  117571. /**
  117572. * renders one or more effects to a specified texture
  117573. * @param effectWrappers list of effects to renderer
  117574. * @param outputTexture texture to draw to, if null it will render to the screen
  117575. */
  117576. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  117577. /**
  117578. * Disposes of the effect renderer
  117579. */
  117580. dispose(): void;
  117581. }
  117582. /**
  117583. * Options to create an EffectWrapper
  117584. */
  117585. interface EffectWrapperCreationOptions {
  117586. /**
  117587. * Engine to use to create the effect
  117588. */
  117589. engine: Engine;
  117590. /**
  117591. * Fragment shader for the effect
  117592. */
  117593. fragmentShader: string;
  117594. /**
  117595. * Vertex shader for the effect
  117596. */
  117597. vertexShader?: string;
  117598. /**
  117599. * Attributes to use in the shader
  117600. */
  117601. attributeNames?: Array<string>;
  117602. /**
  117603. * Uniforms to use in the shader
  117604. */
  117605. uniformNames?: Array<string>;
  117606. /**
  117607. * Texture sampler names to use in the shader
  117608. */
  117609. samplerNames?: Array<string>;
  117610. /**
  117611. * The friendly name of the effect displayed in Spector.
  117612. */
  117613. name?: string;
  117614. }
  117615. /**
  117616. * Wraps an effect to be used for rendering
  117617. */
  117618. export class EffectWrapper {
  117619. /**
  117620. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  117621. */
  117622. onApplyObservable: Observable<{}>;
  117623. /**
  117624. * The underlying effect
  117625. */
  117626. effect: Effect;
  117627. /**
  117628. * Creates an effect to be renderer
  117629. * @param creationOptions options to create the effect
  117630. */
  117631. constructor(creationOptions: EffectWrapperCreationOptions);
  117632. /**
  117633. * Disposes of the effect wrapper
  117634. */
  117635. dispose(): void;
  117636. }
  117637. }
  117638. declare module BABYLON {
  117639. /**
  117640. * Helper class to push actions to a pool of workers.
  117641. */
  117642. export class WorkerPool implements IDisposable {
  117643. private _workerInfos;
  117644. private _pendingActions;
  117645. /**
  117646. * Constructor
  117647. * @param workers Array of workers to use for actions
  117648. */
  117649. constructor(workers: Array<Worker>);
  117650. /**
  117651. * Terminates all workers and clears any pending actions.
  117652. */
  117653. dispose(): void;
  117654. /**
  117655. * Pushes an action to the worker pool. If all the workers are active, the action will be
  117656. * pended until a worker has completed its action.
  117657. * @param action The action to perform. Call onComplete when the action is complete.
  117658. */
  117659. push(action: (worker: Worker, onComplete: () => void) => void): void;
  117660. private _execute;
  117661. }
  117662. }
  117663. declare module BABYLON {
  117664. /**
  117665. * Configuration for Draco compression
  117666. */
  117667. export interface IDracoCompressionConfiguration {
  117668. /**
  117669. * Configuration for the decoder.
  117670. */
  117671. decoder: {
  117672. /**
  117673. * The url to the WebAssembly module.
  117674. */
  117675. wasmUrl?: string;
  117676. /**
  117677. * The url to the WebAssembly binary.
  117678. */
  117679. wasmBinaryUrl?: string;
  117680. /**
  117681. * The url to the fallback JavaScript module.
  117682. */
  117683. fallbackUrl?: string;
  117684. };
  117685. }
  117686. /**
  117687. * Draco compression (https://google.github.io/draco/)
  117688. *
  117689. * This class wraps the Draco module.
  117690. *
  117691. * **Encoder**
  117692. *
  117693. * The encoder is not currently implemented.
  117694. *
  117695. * **Decoder**
  117696. *
  117697. * 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.
  117698. *
  117699. * To update the configuration, use the following code:
  117700. * ```javascript
  117701. * DracoCompression.Configuration = {
  117702. * decoder: {
  117703. * wasmUrl: "<url to the WebAssembly library>",
  117704. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  117705. * fallbackUrl: "<url to the fallback JavaScript library>",
  117706. * }
  117707. * };
  117708. * ```
  117709. *
  117710. * 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.
  117711. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  117712. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  117713. *
  117714. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  117715. * ```javascript
  117716. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  117717. * ```
  117718. *
  117719. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  117720. */
  117721. export class DracoCompression implements IDisposable {
  117722. private _workerPoolPromise?;
  117723. private _decoderModulePromise?;
  117724. /**
  117725. * The configuration. Defaults to the following urls:
  117726. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  117727. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  117728. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  117729. */
  117730. static Configuration: IDracoCompressionConfiguration;
  117731. /**
  117732. * Returns true if the decoder configuration is available.
  117733. */
  117734. static readonly DecoderAvailable: boolean;
  117735. /**
  117736. * Default number of workers to create when creating the draco compression object.
  117737. */
  117738. static DefaultNumWorkers: number;
  117739. private static GetDefaultNumWorkers;
  117740. private static _Default;
  117741. /**
  117742. * Default instance for the draco compression object.
  117743. */
  117744. static readonly Default: DracoCompression;
  117745. /**
  117746. * Constructor
  117747. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  117748. */
  117749. constructor(numWorkers?: number);
  117750. /**
  117751. * Stop all async operations and release resources.
  117752. */
  117753. dispose(): void;
  117754. /**
  117755. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  117756. * @returns a promise that resolves when ready
  117757. */
  117758. whenReadyAsync(): Promise<void>;
  117759. /**
  117760. * Decode Draco compressed mesh data to vertex data.
  117761. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  117762. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  117763. * @returns A promise that resolves with the decoded vertex data
  117764. */
  117765. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  117766. [kind: string]: number;
  117767. }): Promise<VertexData>;
  117768. }
  117769. }
  117770. declare module BABYLON {
  117771. /**
  117772. * Class for building Constructive Solid Geometry
  117773. */
  117774. export class CSG {
  117775. private polygons;
  117776. /**
  117777. * The world matrix
  117778. */
  117779. matrix: Matrix;
  117780. /**
  117781. * Stores the position
  117782. */
  117783. position: Vector3;
  117784. /**
  117785. * Stores the rotation
  117786. */
  117787. rotation: Vector3;
  117788. /**
  117789. * Stores the rotation quaternion
  117790. */
  117791. rotationQuaternion: Nullable<Quaternion>;
  117792. /**
  117793. * Stores the scaling vector
  117794. */
  117795. scaling: Vector3;
  117796. /**
  117797. * Convert the Mesh to CSG
  117798. * @param mesh The Mesh to convert to CSG
  117799. * @returns A new CSG from the Mesh
  117800. */
  117801. static FromMesh(mesh: Mesh): CSG;
  117802. /**
  117803. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  117804. * @param polygons Polygons used to construct a CSG solid
  117805. */
  117806. private static FromPolygons;
  117807. /**
  117808. * Clones, or makes a deep copy, of the CSG
  117809. * @returns A new CSG
  117810. */
  117811. clone(): CSG;
  117812. /**
  117813. * Unions this CSG with another CSG
  117814. * @param csg The CSG to union against this CSG
  117815. * @returns The unioned CSG
  117816. */
  117817. union(csg: CSG): CSG;
  117818. /**
  117819. * Unions this CSG with another CSG in place
  117820. * @param csg The CSG to union against this CSG
  117821. */
  117822. unionInPlace(csg: CSG): void;
  117823. /**
  117824. * Subtracts this CSG with another CSG
  117825. * @param csg The CSG to subtract against this CSG
  117826. * @returns A new CSG
  117827. */
  117828. subtract(csg: CSG): CSG;
  117829. /**
  117830. * Subtracts this CSG with another CSG in place
  117831. * @param csg The CSG to subtact against this CSG
  117832. */
  117833. subtractInPlace(csg: CSG): void;
  117834. /**
  117835. * Intersect this CSG with another CSG
  117836. * @param csg The CSG to intersect against this CSG
  117837. * @returns A new CSG
  117838. */
  117839. intersect(csg: CSG): CSG;
  117840. /**
  117841. * Intersects this CSG with another CSG in place
  117842. * @param csg The CSG to intersect against this CSG
  117843. */
  117844. intersectInPlace(csg: CSG): void;
  117845. /**
  117846. * Return a new CSG solid with solid and empty space switched. This solid is
  117847. * not modified.
  117848. * @returns A new CSG solid with solid and empty space switched
  117849. */
  117850. inverse(): CSG;
  117851. /**
  117852. * Inverses the CSG in place
  117853. */
  117854. inverseInPlace(): void;
  117855. /**
  117856. * This is used to keep meshes transformations so they can be restored
  117857. * when we build back a Babylon Mesh
  117858. * NB : All CSG operations are performed in world coordinates
  117859. * @param csg The CSG to copy the transform attributes from
  117860. * @returns This CSG
  117861. */
  117862. copyTransformAttributes(csg: CSG): CSG;
  117863. /**
  117864. * Build Raw mesh from CSG
  117865. * Coordinates here are in world space
  117866. * @param name The name of the mesh geometry
  117867. * @param scene The Scene
  117868. * @param keepSubMeshes Specifies if the submeshes should be kept
  117869. * @returns A new Mesh
  117870. */
  117871. buildMeshGeometry(name: string, scene: Scene, keepSubMeshes: boolean): Mesh;
  117872. /**
  117873. * Build Mesh from CSG taking material and transforms into account
  117874. * @param name The name of the Mesh
  117875. * @param material The material of the Mesh
  117876. * @param scene The Scene
  117877. * @param keepSubMeshes Specifies if submeshes should be kept
  117878. * @returns The new Mesh
  117879. */
  117880. toMesh(name: string, material: Nullable<Material>, scene: Scene, keepSubMeshes: boolean): Mesh;
  117881. }
  117882. }
  117883. declare module BABYLON {
  117884. /**
  117885. * Class used to create a trail following a mesh
  117886. */
  117887. export class TrailMesh extends Mesh {
  117888. private _generator;
  117889. private _autoStart;
  117890. private _running;
  117891. private _diameter;
  117892. private _length;
  117893. private _sectionPolygonPointsCount;
  117894. private _sectionVectors;
  117895. private _sectionNormalVectors;
  117896. private _beforeRenderObserver;
  117897. /**
  117898. * @constructor
  117899. * @param name The value used by scene.getMeshByName() to do a lookup.
  117900. * @param generator The mesh to generate a trail.
  117901. * @param scene The scene to add this mesh to.
  117902. * @param diameter Diameter of trailing mesh. Default is 1.
  117903. * @param length Length of trailing mesh. Default is 60.
  117904. * @param autoStart Automatically start trailing mesh. Default true.
  117905. */
  117906. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  117907. /**
  117908. * "TrailMesh"
  117909. * @returns "TrailMesh"
  117910. */
  117911. getClassName(): string;
  117912. private _createMesh;
  117913. /**
  117914. * Start trailing mesh.
  117915. */
  117916. start(): void;
  117917. /**
  117918. * Stop trailing mesh.
  117919. */
  117920. stop(): void;
  117921. /**
  117922. * Update trailing mesh geometry.
  117923. */
  117924. update(): void;
  117925. /**
  117926. * Returns a new TrailMesh object.
  117927. * @param name is a string, the name given to the new mesh
  117928. * @param newGenerator use new generator object for cloned trail mesh
  117929. * @returns a new mesh
  117930. */
  117931. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  117932. /**
  117933. * Serializes this trail mesh
  117934. * @param serializationObject object to write serialization to
  117935. */
  117936. serialize(serializationObject: any): void;
  117937. /**
  117938. * Parses a serialized trail mesh
  117939. * @param parsedMesh the serialized mesh
  117940. * @param scene the scene to create the trail mesh in
  117941. * @returns the created trail mesh
  117942. */
  117943. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  117944. }
  117945. }
  117946. declare module BABYLON {
  117947. /**
  117948. * Class containing static functions to help procedurally build meshes
  117949. */
  117950. export class TiledBoxBuilder {
  117951. /**
  117952. * Creates a box mesh
  117953. * 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)
  117954. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  117955. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  117956. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  117957. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  117958. * @param name defines the name of the mesh
  117959. * @param options defines the options used to create the mesh
  117960. * @param scene defines the hosting scene
  117961. * @returns the box mesh
  117962. */
  117963. static CreateTiledBox(name: string, options: {
  117964. pattern?: number;
  117965. width?: number;
  117966. height?: number;
  117967. depth?: number;
  117968. tileSize?: number;
  117969. tileWidth?: number;
  117970. tileHeight?: number;
  117971. alignHorizontal?: number;
  117972. alignVertical?: number;
  117973. faceUV?: Vector4[];
  117974. faceColors?: Color4[];
  117975. sideOrientation?: number;
  117976. updatable?: boolean;
  117977. }, scene?: Nullable<Scene>): Mesh;
  117978. }
  117979. }
  117980. declare module BABYLON {
  117981. /**
  117982. * Class containing static functions to help procedurally build meshes
  117983. */
  117984. export class TorusKnotBuilder {
  117985. /**
  117986. * Creates a torus knot mesh
  117987. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  117988. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  117989. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  117990. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  117991. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  117992. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  117993. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  117994. * @param name defines the name of the mesh
  117995. * @param options defines the options used to create the mesh
  117996. * @param scene defines the hosting scene
  117997. * @returns the torus knot mesh
  117998. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  117999. */
  118000. static CreateTorusKnot(name: string, options: {
  118001. radius?: number;
  118002. tube?: number;
  118003. radialSegments?: number;
  118004. tubularSegments?: number;
  118005. p?: number;
  118006. q?: number;
  118007. updatable?: boolean;
  118008. sideOrientation?: number;
  118009. frontUVs?: Vector4;
  118010. backUVs?: Vector4;
  118011. }, scene: any): Mesh;
  118012. }
  118013. }
  118014. declare module BABYLON {
  118015. /**
  118016. * Polygon
  118017. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  118018. */
  118019. export class Polygon {
  118020. /**
  118021. * Creates a rectangle
  118022. * @param xmin bottom X coord
  118023. * @param ymin bottom Y coord
  118024. * @param xmax top X coord
  118025. * @param ymax top Y coord
  118026. * @returns points that make the resulting rectation
  118027. */
  118028. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  118029. /**
  118030. * Creates a circle
  118031. * @param radius radius of circle
  118032. * @param cx scale in x
  118033. * @param cy scale in y
  118034. * @param numberOfSides number of sides that make up the circle
  118035. * @returns points that make the resulting circle
  118036. */
  118037. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  118038. /**
  118039. * Creates a polygon from input string
  118040. * @param input Input polygon data
  118041. * @returns the parsed points
  118042. */
  118043. static Parse(input: string): Vector2[];
  118044. /**
  118045. * Starts building a polygon from x and y coordinates
  118046. * @param x x coordinate
  118047. * @param y y coordinate
  118048. * @returns the started path2
  118049. */
  118050. static StartingAt(x: number, y: number): Path2;
  118051. }
  118052. /**
  118053. * Builds a polygon
  118054. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  118055. */
  118056. export class PolygonMeshBuilder {
  118057. private _points;
  118058. private _outlinepoints;
  118059. private _holes;
  118060. private _name;
  118061. private _scene;
  118062. private _epoints;
  118063. private _eholes;
  118064. private _addToepoint;
  118065. /**
  118066. * Babylon reference to the earcut plugin.
  118067. */
  118068. bjsEarcut: any;
  118069. /**
  118070. * Creates a PolygonMeshBuilder
  118071. * @param name name of the builder
  118072. * @param contours Path of the polygon
  118073. * @param scene scene to add to when creating the mesh
  118074. * @param earcutInjection can be used to inject your own earcut reference
  118075. */
  118076. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  118077. /**
  118078. * Adds a whole within the polygon
  118079. * @param hole Array of points defining the hole
  118080. * @returns this
  118081. */
  118082. addHole(hole: Vector2[]): PolygonMeshBuilder;
  118083. /**
  118084. * Creates the polygon
  118085. * @param updatable If the mesh should be updatable
  118086. * @param depth The depth of the mesh created
  118087. * @returns the created mesh
  118088. */
  118089. build(updatable?: boolean, depth?: number): Mesh;
  118090. /**
  118091. * Creates the polygon
  118092. * @param depth The depth of the mesh created
  118093. * @returns the created VertexData
  118094. */
  118095. buildVertexData(depth?: number): VertexData;
  118096. /**
  118097. * Adds a side to the polygon
  118098. * @param positions points that make the polygon
  118099. * @param normals normals of the polygon
  118100. * @param uvs uvs of the polygon
  118101. * @param indices indices of the polygon
  118102. * @param bounds bounds of the polygon
  118103. * @param points points of the polygon
  118104. * @param depth depth of the polygon
  118105. * @param flip flip of the polygon
  118106. */
  118107. private addSide;
  118108. }
  118109. }
  118110. declare module BABYLON {
  118111. /**
  118112. * Class containing static functions to help procedurally build meshes
  118113. */
  118114. export class PolygonBuilder {
  118115. /**
  118116. * Creates a polygon mesh
  118117. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  118118. * * 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
  118119. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  118120. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118121. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  118122. * * Remember you can only change the shape positions, not their number when updating a polygon
  118123. * @param name defines the name of the mesh
  118124. * @param options defines the options used to create the mesh
  118125. * @param scene defines the hosting scene
  118126. * @param earcutInjection can be used to inject your own earcut reference
  118127. * @returns the polygon mesh
  118128. */
  118129. static CreatePolygon(name: string, options: {
  118130. shape: Vector3[];
  118131. holes?: Vector3[][];
  118132. depth?: number;
  118133. faceUV?: Vector4[];
  118134. faceColors?: Color4[];
  118135. updatable?: boolean;
  118136. sideOrientation?: number;
  118137. frontUVs?: Vector4;
  118138. backUVs?: Vector4;
  118139. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  118140. /**
  118141. * Creates an extruded polygon mesh, with depth in the Y direction.
  118142. * * 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)
  118143. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  118144. * @param name defines the name of the mesh
  118145. * @param options defines the options used to create the mesh
  118146. * @param scene defines the hosting scene
  118147. * @param earcutInjection can be used to inject your own earcut reference
  118148. * @returns the polygon mesh
  118149. */
  118150. static ExtrudePolygon(name: string, options: {
  118151. shape: Vector3[];
  118152. holes?: Vector3[][];
  118153. depth?: number;
  118154. faceUV?: Vector4[];
  118155. faceColors?: Color4[];
  118156. updatable?: boolean;
  118157. sideOrientation?: number;
  118158. frontUVs?: Vector4;
  118159. backUVs?: Vector4;
  118160. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  118161. }
  118162. }
  118163. declare module BABYLON {
  118164. /**
  118165. * Class containing static functions to help procedurally build meshes
  118166. */
  118167. export class LatheBuilder {
  118168. /**
  118169. * Creates lathe mesh.
  118170. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  118171. * * 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
  118172. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  118173. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  118174. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  118175. * * 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
  118176. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  118177. * * 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
  118178. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118179. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118180. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  118181. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118182. * @param name defines the name of the mesh
  118183. * @param options defines the options used to create the mesh
  118184. * @param scene defines the hosting scene
  118185. * @returns the lathe mesh
  118186. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  118187. */
  118188. static CreateLathe(name: string, options: {
  118189. shape: Vector3[];
  118190. radius?: number;
  118191. tessellation?: number;
  118192. clip?: number;
  118193. arc?: number;
  118194. closed?: boolean;
  118195. updatable?: boolean;
  118196. sideOrientation?: number;
  118197. frontUVs?: Vector4;
  118198. backUVs?: Vector4;
  118199. cap?: number;
  118200. invertUV?: boolean;
  118201. }, scene?: Nullable<Scene>): Mesh;
  118202. }
  118203. }
  118204. declare module BABYLON {
  118205. /**
  118206. * Class containing static functions to help procedurally build meshes
  118207. */
  118208. export class TiledPlaneBuilder {
  118209. /**
  118210. * Creates a tiled plane mesh
  118211. * * The parameter `pattern` will, depending on value, do nothing or
  118212. * * * flip (reflect about central vertical) alternate tiles across and up
  118213. * * * flip every tile on alternate rows
  118214. * * * rotate (180 degs) alternate tiles across and up
  118215. * * * rotate every tile on alternate rows
  118216. * * * flip and rotate alternate tiles across and up
  118217. * * * flip and rotate every tile on alternate rows
  118218. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  118219. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  118220. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118221. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  118222. * * 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)
  118223. * * 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)
  118224. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  118225. * @param name defines the name of the mesh
  118226. * @param options defines the options used to create the mesh
  118227. * @param scene defines the hosting scene
  118228. * @returns the box mesh
  118229. */
  118230. static CreateTiledPlane(name: string, options: {
  118231. pattern?: number;
  118232. tileSize?: number;
  118233. tileWidth?: number;
  118234. tileHeight?: number;
  118235. size?: number;
  118236. width?: number;
  118237. height?: number;
  118238. alignHorizontal?: number;
  118239. alignVertical?: number;
  118240. sideOrientation?: number;
  118241. frontUVs?: Vector4;
  118242. backUVs?: Vector4;
  118243. updatable?: boolean;
  118244. }, scene?: Nullable<Scene>): Mesh;
  118245. }
  118246. }
  118247. declare module BABYLON {
  118248. /**
  118249. * Class containing static functions to help procedurally build meshes
  118250. */
  118251. export class TubeBuilder {
  118252. /**
  118253. * Creates a tube mesh.
  118254. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  118255. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  118256. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  118257. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  118258. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  118259. * * 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)
  118260. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  118261. * * 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
  118262. * * 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
  118263. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118264. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118265. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  118266. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118267. * @param name defines the name of the mesh
  118268. * @param options defines the options used to create the mesh
  118269. * @param scene defines the hosting scene
  118270. * @returns the tube mesh
  118271. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  118272. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  118273. */
  118274. static CreateTube(name: string, options: {
  118275. path: Vector3[];
  118276. radius?: number;
  118277. tessellation?: number;
  118278. radiusFunction?: {
  118279. (i: number, distance: number): number;
  118280. };
  118281. cap?: number;
  118282. arc?: number;
  118283. updatable?: boolean;
  118284. sideOrientation?: number;
  118285. frontUVs?: Vector4;
  118286. backUVs?: Vector4;
  118287. instance?: Mesh;
  118288. invertUV?: boolean;
  118289. }, scene?: Nullable<Scene>): Mesh;
  118290. }
  118291. }
  118292. declare module BABYLON {
  118293. /**
  118294. * Class containing static functions to help procedurally build meshes
  118295. */
  118296. export class IcoSphereBuilder {
  118297. /**
  118298. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  118299. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  118300. * * 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`)
  118301. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  118302. * * 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
  118303. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118304. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118305. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118306. * @param name defines the name of the mesh
  118307. * @param options defines the options used to create the mesh
  118308. * @param scene defines the hosting scene
  118309. * @returns the icosahedron mesh
  118310. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  118311. */
  118312. static CreateIcoSphere(name: string, options: {
  118313. radius?: number;
  118314. radiusX?: number;
  118315. radiusY?: number;
  118316. radiusZ?: number;
  118317. flat?: boolean;
  118318. subdivisions?: number;
  118319. sideOrientation?: number;
  118320. frontUVs?: Vector4;
  118321. backUVs?: Vector4;
  118322. updatable?: boolean;
  118323. }, scene?: Nullable<Scene>): Mesh;
  118324. }
  118325. }
  118326. declare module BABYLON {
  118327. /**
  118328. * Class containing static functions to help procedurally build meshes
  118329. */
  118330. export class DecalBuilder {
  118331. /**
  118332. * Creates a decal mesh.
  118333. * 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
  118334. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  118335. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  118336. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  118337. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  118338. * @param name defines the name of the mesh
  118339. * @param sourceMesh defines the mesh where the decal must be applied
  118340. * @param options defines the options used to create the mesh
  118341. * @param scene defines the hosting scene
  118342. * @returns the decal mesh
  118343. * @see https://doc.babylonjs.com/how_to/decals
  118344. */
  118345. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  118346. position?: Vector3;
  118347. normal?: Vector3;
  118348. size?: Vector3;
  118349. angle?: number;
  118350. }): Mesh;
  118351. }
  118352. }
  118353. declare module BABYLON {
  118354. /**
  118355. * Class containing static functions to help procedurally build meshes
  118356. */
  118357. export class MeshBuilder {
  118358. /**
  118359. * Creates a box mesh
  118360. * * The parameter `size` sets the size (float) of each box side (default 1)
  118361. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  118362. * * 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)
  118363. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  118364. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118365. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118366. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118367. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  118368. * @param name defines the name of the mesh
  118369. * @param options defines the options used to create the mesh
  118370. * @param scene defines the hosting scene
  118371. * @returns the box mesh
  118372. */
  118373. static CreateBox(name: string, options: {
  118374. size?: number;
  118375. width?: number;
  118376. height?: number;
  118377. depth?: number;
  118378. faceUV?: Vector4[];
  118379. faceColors?: Color4[];
  118380. sideOrientation?: number;
  118381. frontUVs?: Vector4;
  118382. backUVs?: Vector4;
  118383. updatable?: boolean;
  118384. }, scene?: Nullable<Scene>): Mesh;
  118385. /**
  118386. * Creates a tiled box mesh
  118387. * * faceTiles sets the pattern, tile size and number of tiles for a face
  118388. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118389. * @param name defines the name of the mesh
  118390. * @param options defines the options used to create the mesh
  118391. * @param scene defines the hosting scene
  118392. * @returns the tiled box mesh
  118393. */
  118394. static CreateTiledBox(name: string, options: {
  118395. pattern?: number;
  118396. size?: number;
  118397. width?: number;
  118398. height?: number;
  118399. depth: number;
  118400. tileSize?: number;
  118401. tileWidth?: number;
  118402. tileHeight?: number;
  118403. faceUV?: Vector4[];
  118404. faceColors?: Color4[];
  118405. alignHorizontal?: number;
  118406. alignVertical?: number;
  118407. sideOrientation?: number;
  118408. updatable?: boolean;
  118409. }, scene?: Nullable<Scene>): Mesh;
  118410. /**
  118411. * Creates a sphere mesh
  118412. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  118413. * * 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`)
  118414. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  118415. * * 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
  118416. * * 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)
  118417. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118418. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118419. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118420. * @param name defines the name of the mesh
  118421. * @param options defines the options used to create the mesh
  118422. * @param scene defines the hosting scene
  118423. * @returns the sphere mesh
  118424. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  118425. */
  118426. static CreateSphere(name: string, options: {
  118427. segments?: number;
  118428. diameter?: number;
  118429. diameterX?: number;
  118430. diameterY?: number;
  118431. diameterZ?: number;
  118432. arc?: number;
  118433. slice?: number;
  118434. sideOrientation?: number;
  118435. frontUVs?: Vector4;
  118436. backUVs?: Vector4;
  118437. updatable?: boolean;
  118438. }, scene?: Nullable<Scene>): Mesh;
  118439. /**
  118440. * Creates a plane polygonal mesh. By default, this is a disc
  118441. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  118442. * * 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
  118443. * * 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
  118444. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118445. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118446. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118447. * @param name defines the name of the mesh
  118448. * @param options defines the options used to create the mesh
  118449. * @param scene defines the hosting scene
  118450. * @returns the plane polygonal mesh
  118451. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  118452. */
  118453. static CreateDisc(name: string, options: {
  118454. radius?: number;
  118455. tessellation?: number;
  118456. arc?: number;
  118457. updatable?: boolean;
  118458. sideOrientation?: number;
  118459. frontUVs?: Vector4;
  118460. backUVs?: Vector4;
  118461. }, scene?: Nullable<Scene>): Mesh;
  118462. /**
  118463. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  118464. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  118465. * * 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`)
  118466. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  118467. * * 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
  118468. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118469. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118470. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118471. * @param name defines the name of the mesh
  118472. * @param options defines the options used to create the mesh
  118473. * @param scene defines the hosting scene
  118474. * @returns the icosahedron mesh
  118475. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  118476. */
  118477. static CreateIcoSphere(name: string, options: {
  118478. radius?: number;
  118479. radiusX?: number;
  118480. radiusY?: number;
  118481. radiusZ?: number;
  118482. flat?: boolean;
  118483. subdivisions?: number;
  118484. sideOrientation?: number;
  118485. frontUVs?: Vector4;
  118486. backUVs?: Vector4;
  118487. updatable?: boolean;
  118488. }, scene?: Nullable<Scene>): Mesh;
  118489. /**
  118490. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  118491. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  118492. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  118493. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  118494. * * 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
  118495. * * 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
  118496. * * 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
  118497. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118498. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118499. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  118500. * * 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
  118501. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  118502. * * 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
  118503. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  118504. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118505. * @param name defines the name of the mesh
  118506. * @param options defines the options used to create the mesh
  118507. * @param scene defines the hosting scene
  118508. * @returns the ribbon mesh
  118509. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  118510. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  118511. */
  118512. static CreateRibbon(name: string, options: {
  118513. pathArray: Vector3[][];
  118514. closeArray?: boolean;
  118515. closePath?: boolean;
  118516. offset?: number;
  118517. updatable?: boolean;
  118518. sideOrientation?: number;
  118519. frontUVs?: Vector4;
  118520. backUVs?: Vector4;
  118521. instance?: Mesh;
  118522. invertUV?: boolean;
  118523. uvs?: Vector2[];
  118524. colors?: Color4[];
  118525. }, scene?: Nullable<Scene>): Mesh;
  118526. /**
  118527. * Creates a cylinder or a cone mesh
  118528. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  118529. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  118530. * * 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.
  118531. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  118532. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  118533. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  118534. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  118535. * * 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).
  118536. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  118537. * * 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).
  118538. * * 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
  118539. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  118540. * * 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
  118541. * * 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.
  118542. * * If `enclose` is false, a ring surface is one element.
  118543. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  118544. * * 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
  118545. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118546. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118547. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  118548. * @param name defines the name of the mesh
  118549. * @param options defines the options used to create the mesh
  118550. * @param scene defines the hosting scene
  118551. * @returns the cylinder mesh
  118552. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  118553. */
  118554. static CreateCylinder(name: string, options: {
  118555. height?: number;
  118556. diameterTop?: number;
  118557. diameterBottom?: number;
  118558. diameter?: number;
  118559. tessellation?: number;
  118560. subdivisions?: number;
  118561. arc?: number;
  118562. faceColors?: Color4[];
  118563. faceUV?: Vector4[];
  118564. updatable?: boolean;
  118565. hasRings?: boolean;
  118566. enclose?: boolean;
  118567. cap?: number;
  118568. sideOrientation?: number;
  118569. frontUVs?: Vector4;
  118570. backUVs?: Vector4;
  118571. }, scene?: Nullable<Scene>): Mesh;
  118572. /**
  118573. * Creates a torus mesh
  118574. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  118575. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  118576. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  118577. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118578. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118579. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  118580. * @param name defines the name of the mesh
  118581. * @param options defines the options used to create the mesh
  118582. * @param scene defines the hosting scene
  118583. * @returns the torus mesh
  118584. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  118585. */
  118586. static CreateTorus(name: string, options: {
  118587. diameter?: number;
  118588. thickness?: number;
  118589. tessellation?: number;
  118590. updatable?: boolean;
  118591. sideOrientation?: number;
  118592. frontUVs?: Vector4;
  118593. backUVs?: Vector4;
  118594. }, scene?: Nullable<Scene>): Mesh;
  118595. /**
  118596. * Creates a torus knot mesh
  118597. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  118598. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  118599. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  118600. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  118601. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118602. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118603. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  118604. * @param name defines the name of the mesh
  118605. * @param options defines the options used to create the mesh
  118606. * @param scene defines the hosting scene
  118607. * @returns the torus knot mesh
  118608. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  118609. */
  118610. static CreateTorusKnot(name: string, options: {
  118611. radius?: number;
  118612. tube?: number;
  118613. radialSegments?: number;
  118614. tubularSegments?: number;
  118615. p?: number;
  118616. q?: number;
  118617. updatable?: boolean;
  118618. sideOrientation?: number;
  118619. frontUVs?: Vector4;
  118620. backUVs?: Vector4;
  118621. }, scene?: Nullable<Scene>): Mesh;
  118622. /**
  118623. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  118624. * * 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
  118625. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  118626. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  118627. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  118628. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  118629. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  118630. * * 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
  118631. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  118632. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118633. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  118634. * @param name defines the name of the new line system
  118635. * @param options defines the options used to create the line system
  118636. * @param scene defines the hosting scene
  118637. * @returns a new line system mesh
  118638. */
  118639. static CreateLineSystem(name: string, options: {
  118640. lines: Vector3[][];
  118641. updatable?: boolean;
  118642. instance?: Nullable<LinesMesh>;
  118643. colors?: Nullable<Color4[][]>;
  118644. useVertexAlpha?: boolean;
  118645. }, scene: Nullable<Scene>): LinesMesh;
  118646. /**
  118647. * Creates a line mesh
  118648. * 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
  118649. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  118650. * * The parameter `points` is an array successive Vector3
  118651. * * 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
  118652. * * The optional parameter `colors` is an array of successive Color4, one per line point
  118653. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  118654. * * When updating an instance, remember that only point positions can change, not the number of points
  118655. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118656. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  118657. * @param name defines the name of the new line system
  118658. * @param options defines the options used to create the line system
  118659. * @param scene defines the hosting scene
  118660. * @returns a new line mesh
  118661. */
  118662. static CreateLines(name: string, options: {
  118663. points: Vector3[];
  118664. updatable?: boolean;
  118665. instance?: Nullable<LinesMesh>;
  118666. colors?: Color4[];
  118667. useVertexAlpha?: boolean;
  118668. }, scene?: Nullable<Scene>): LinesMesh;
  118669. /**
  118670. * Creates a dashed line mesh
  118671. * * 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
  118672. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  118673. * * The parameter `points` is an array successive Vector3
  118674. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  118675. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  118676. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  118677. * * 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
  118678. * * When updating an instance, remember that only point positions can change, not the number of points
  118679. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118680. * @param name defines the name of the mesh
  118681. * @param options defines the options used to create the mesh
  118682. * @param scene defines the hosting scene
  118683. * @returns the dashed line mesh
  118684. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  118685. */
  118686. static CreateDashedLines(name: string, options: {
  118687. points: Vector3[];
  118688. dashSize?: number;
  118689. gapSize?: number;
  118690. dashNb?: number;
  118691. updatable?: boolean;
  118692. instance?: LinesMesh;
  118693. }, scene?: Nullable<Scene>): LinesMesh;
  118694. /**
  118695. * 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.
  118696. * * 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.
  118697. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  118698. * * 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.
  118699. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  118700. * * 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
  118701. * * 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
  118702. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  118703. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118704. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118705. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  118706. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  118707. * @param name defines the name of the mesh
  118708. * @param options defines the options used to create the mesh
  118709. * @param scene defines the hosting scene
  118710. * @returns the extruded shape mesh
  118711. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  118712. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  118713. */
  118714. static ExtrudeShape(name: string, options: {
  118715. shape: Vector3[];
  118716. path: Vector3[];
  118717. scale?: number;
  118718. rotation?: number;
  118719. cap?: number;
  118720. updatable?: boolean;
  118721. sideOrientation?: number;
  118722. frontUVs?: Vector4;
  118723. backUVs?: Vector4;
  118724. instance?: Mesh;
  118725. invertUV?: boolean;
  118726. }, scene?: Nullable<Scene>): Mesh;
  118727. /**
  118728. * Creates an custom extruded shape mesh.
  118729. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  118730. * * 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.
  118731. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  118732. * * 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
  118733. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  118734. * * 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
  118735. * * It must returns a float value that will be the scale value applied to the shape on each path point
  118736. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  118737. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  118738. * * 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
  118739. * * 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
  118740. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  118741. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118742. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118743. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  118744. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118745. * @param name defines the name of the mesh
  118746. * @param options defines the options used to create the mesh
  118747. * @param scene defines the hosting scene
  118748. * @returns the custom extruded shape mesh
  118749. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  118750. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  118751. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  118752. */
  118753. static ExtrudeShapeCustom(name: string, options: {
  118754. shape: Vector3[];
  118755. path: Vector3[];
  118756. scaleFunction?: any;
  118757. rotationFunction?: any;
  118758. ribbonCloseArray?: boolean;
  118759. ribbonClosePath?: boolean;
  118760. cap?: number;
  118761. updatable?: boolean;
  118762. sideOrientation?: number;
  118763. frontUVs?: Vector4;
  118764. backUVs?: Vector4;
  118765. instance?: Mesh;
  118766. invertUV?: boolean;
  118767. }, scene?: Nullable<Scene>): Mesh;
  118768. /**
  118769. * Creates lathe mesh.
  118770. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  118771. * * 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
  118772. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  118773. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  118774. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  118775. * * 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
  118776. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  118777. * * 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
  118778. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118779. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118780. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  118781. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118782. * @param name defines the name of the mesh
  118783. * @param options defines the options used to create the mesh
  118784. * @param scene defines the hosting scene
  118785. * @returns the lathe mesh
  118786. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  118787. */
  118788. static CreateLathe(name: string, options: {
  118789. shape: Vector3[];
  118790. radius?: number;
  118791. tessellation?: number;
  118792. clip?: number;
  118793. arc?: number;
  118794. closed?: boolean;
  118795. updatable?: boolean;
  118796. sideOrientation?: number;
  118797. frontUVs?: Vector4;
  118798. backUVs?: Vector4;
  118799. cap?: number;
  118800. invertUV?: boolean;
  118801. }, scene?: Nullable<Scene>): Mesh;
  118802. /**
  118803. * Creates a tiled plane mesh
  118804. * * You can set a limited pattern arrangement with the tiles
  118805. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118806. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118807. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118808. * @param name defines the name of the mesh
  118809. * @param options defines the options used to create the mesh
  118810. * @param scene defines the hosting scene
  118811. * @returns the plane mesh
  118812. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  118813. */
  118814. static CreateTiledPlane(name: string, options: {
  118815. pattern?: number;
  118816. tileSize?: number;
  118817. tileWidth?: number;
  118818. tileHeight?: number;
  118819. size?: number;
  118820. width?: number;
  118821. height?: number;
  118822. alignHorizontal?: number;
  118823. alignVertical?: number;
  118824. sideOrientation?: number;
  118825. frontUVs?: Vector4;
  118826. backUVs?: Vector4;
  118827. updatable?: boolean;
  118828. }, scene?: Nullable<Scene>): Mesh;
  118829. /**
  118830. * Creates a plane mesh
  118831. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  118832. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  118833. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  118834. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118835. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118836. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118837. * @param name defines the name of the mesh
  118838. * @param options defines the options used to create the mesh
  118839. * @param scene defines the hosting scene
  118840. * @returns the plane mesh
  118841. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  118842. */
  118843. static CreatePlane(name: string, options: {
  118844. size?: number;
  118845. width?: number;
  118846. height?: number;
  118847. sideOrientation?: number;
  118848. frontUVs?: Vector4;
  118849. backUVs?: Vector4;
  118850. updatable?: boolean;
  118851. sourcePlane?: Plane;
  118852. }, scene?: Nullable<Scene>): Mesh;
  118853. /**
  118854. * Creates a ground mesh
  118855. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  118856. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  118857. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118858. * @param name defines the name of the mesh
  118859. * @param options defines the options used to create the mesh
  118860. * @param scene defines the hosting scene
  118861. * @returns the ground mesh
  118862. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  118863. */
  118864. static CreateGround(name: string, options: {
  118865. width?: number;
  118866. height?: number;
  118867. subdivisions?: number;
  118868. subdivisionsX?: number;
  118869. subdivisionsY?: number;
  118870. updatable?: boolean;
  118871. }, scene?: Nullable<Scene>): Mesh;
  118872. /**
  118873. * Creates a tiled ground mesh
  118874. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  118875. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  118876. * * 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
  118877. * * 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
  118878. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  118879. * @param name defines the name of the mesh
  118880. * @param options defines the options used to create the mesh
  118881. * @param scene defines the hosting scene
  118882. * @returns the tiled ground mesh
  118883. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  118884. */
  118885. static CreateTiledGround(name: string, options: {
  118886. xmin: number;
  118887. zmin: number;
  118888. xmax: number;
  118889. zmax: number;
  118890. subdivisions?: {
  118891. w: number;
  118892. h: number;
  118893. };
  118894. precision?: {
  118895. w: number;
  118896. h: number;
  118897. };
  118898. updatable?: boolean;
  118899. }, scene?: Nullable<Scene>): Mesh;
  118900. /**
  118901. * Creates a ground mesh from a height map
  118902. * * The parameter `url` sets the URL of the height map image resource.
  118903. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  118904. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  118905. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  118906. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  118907. * * 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.
  118908. * * 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).
  118909. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  118910. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  118911. * @param name defines the name of the mesh
  118912. * @param url defines the url to the height map
  118913. * @param options defines the options used to create the mesh
  118914. * @param scene defines the hosting scene
  118915. * @returns the ground mesh
  118916. * @see https://doc.babylonjs.com/babylon101/height_map
  118917. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  118918. */
  118919. static CreateGroundFromHeightMap(name: string, url: string, options: {
  118920. width?: number;
  118921. height?: number;
  118922. subdivisions?: number;
  118923. minHeight?: number;
  118924. maxHeight?: number;
  118925. colorFilter?: Color3;
  118926. alphaFilter?: number;
  118927. updatable?: boolean;
  118928. onReady?: (mesh: GroundMesh) => void;
  118929. }, scene?: Nullable<Scene>): GroundMesh;
  118930. /**
  118931. * Creates a polygon mesh
  118932. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  118933. * * 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
  118934. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  118935. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118936. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  118937. * * Remember you can only change the shape positions, not their number when updating a polygon
  118938. * @param name defines the name of the mesh
  118939. * @param options defines the options used to create the mesh
  118940. * @param scene defines the hosting scene
  118941. * @param earcutInjection can be used to inject your own earcut reference
  118942. * @returns the polygon mesh
  118943. */
  118944. static CreatePolygon(name: string, options: {
  118945. shape: Vector3[];
  118946. holes?: Vector3[][];
  118947. depth?: number;
  118948. faceUV?: Vector4[];
  118949. faceColors?: Color4[];
  118950. updatable?: boolean;
  118951. sideOrientation?: number;
  118952. frontUVs?: Vector4;
  118953. backUVs?: Vector4;
  118954. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  118955. /**
  118956. * Creates an extruded polygon mesh, with depth in the Y direction.
  118957. * * 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)
  118958. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  118959. * @param name defines the name of the mesh
  118960. * @param options defines the options used to create the mesh
  118961. * @param scene defines the hosting scene
  118962. * @param earcutInjection can be used to inject your own earcut reference
  118963. * @returns the polygon mesh
  118964. */
  118965. static ExtrudePolygon(name: string, options: {
  118966. shape: Vector3[];
  118967. holes?: Vector3[][];
  118968. depth?: number;
  118969. faceUV?: Vector4[];
  118970. faceColors?: Color4[];
  118971. updatable?: boolean;
  118972. sideOrientation?: number;
  118973. frontUVs?: Vector4;
  118974. backUVs?: Vector4;
  118975. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  118976. /**
  118977. * Creates a tube mesh.
  118978. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  118979. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  118980. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  118981. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  118982. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  118983. * * 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)
  118984. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  118985. * * 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
  118986. * * 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
  118987. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  118988. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  118989. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  118990. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  118991. * @param name defines the name of the mesh
  118992. * @param options defines the options used to create the mesh
  118993. * @param scene defines the hosting scene
  118994. * @returns the tube mesh
  118995. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  118996. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  118997. */
  118998. static CreateTube(name: string, options: {
  118999. path: Vector3[];
  119000. radius?: number;
  119001. tessellation?: number;
  119002. radiusFunction?: {
  119003. (i: number, distance: number): number;
  119004. };
  119005. cap?: number;
  119006. arc?: number;
  119007. updatable?: boolean;
  119008. sideOrientation?: number;
  119009. frontUVs?: Vector4;
  119010. backUVs?: Vector4;
  119011. instance?: Mesh;
  119012. invertUV?: boolean;
  119013. }, scene?: Nullable<Scene>): Mesh;
  119014. /**
  119015. * Creates a polyhedron mesh
  119016. * * 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
  119017. * * The parameter `size` (positive float, default 1) sets the polygon size
  119018. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  119019. * * 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`
  119020. * * 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
  119021. * * 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)`)
  119022. * * 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
  119023. * * 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
  119024. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119025. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119026. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119027. * @param name defines the name of the mesh
  119028. * @param options defines the options used to create the mesh
  119029. * @param scene defines the hosting scene
  119030. * @returns the polyhedron mesh
  119031. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  119032. */
  119033. static CreatePolyhedron(name: string, options: {
  119034. type?: number;
  119035. size?: number;
  119036. sizeX?: number;
  119037. sizeY?: number;
  119038. sizeZ?: number;
  119039. custom?: any;
  119040. faceUV?: Vector4[];
  119041. faceColors?: Color4[];
  119042. flat?: boolean;
  119043. updatable?: boolean;
  119044. sideOrientation?: number;
  119045. frontUVs?: Vector4;
  119046. backUVs?: Vector4;
  119047. }, scene?: Nullable<Scene>): Mesh;
  119048. /**
  119049. * Creates a decal mesh.
  119050. * 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
  119051. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  119052. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  119053. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  119054. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  119055. * @param name defines the name of the mesh
  119056. * @param sourceMesh defines the mesh where the decal must be applied
  119057. * @param options defines the options used to create the mesh
  119058. * @param scene defines the hosting scene
  119059. * @returns the decal mesh
  119060. * @see https://doc.babylonjs.com/how_to/decals
  119061. */
  119062. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  119063. position?: Vector3;
  119064. normal?: Vector3;
  119065. size?: Vector3;
  119066. angle?: number;
  119067. }): Mesh;
  119068. }
  119069. }
  119070. declare module BABYLON {
  119071. /**
  119072. * A simplifier interface for future simplification implementations
  119073. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  119074. */
  119075. export interface ISimplifier {
  119076. /**
  119077. * Simplification of a given mesh according to the given settings.
  119078. * Since this requires computation, it is assumed that the function runs async.
  119079. * @param settings The settings of the simplification, including quality and distance
  119080. * @param successCallback A callback that will be called after the mesh was simplified.
  119081. * @param errorCallback in case of an error, this callback will be called. optional.
  119082. */
  119083. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  119084. }
  119085. /**
  119086. * Expected simplification settings.
  119087. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  119088. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  119089. */
  119090. export interface ISimplificationSettings {
  119091. /**
  119092. * Gets or sets the expected quality
  119093. */
  119094. quality: number;
  119095. /**
  119096. * Gets or sets the distance when this optimized version should be used
  119097. */
  119098. distance: number;
  119099. /**
  119100. * Gets an already optimized mesh
  119101. */
  119102. optimizeMesh?: boolean;
  119103. }
  119104. /**
  119105. * Class used to specify simplification options
  119106. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  119107. */
  119108. export class SimplificationSettings implements ISimplificationSettings {
  119109. /** expected quality */
  119110. quality: number;
  119111. /** distance when this optimized version should be used */
  119112. distance: number;
  119113. /** already optimized mesh */
  119114. optimizeMesh?: boolean | undefined;
  119115. /**
  119116. * Creates a SimplificationSettings
  119117. * @param quality expected quality
  119118. * @param distance distance when this optimized version should be used
  119119. * @param optimizeMesh already optimized mesh
  119120. */
  119121. constructor(
  119122. /** expected quality */
  119123. quality: number,
  119124. /** distance when this optimized version should be used */
  119125. distance: number,
  119126. /** already optimized mesh */
  119127. optimizeMesh?: boolean | undefined);
  119128. }
  119129. /**
  119130. * Interface used to define a simplification task
  119131. */
  119132. export interface ISimplificationTask {
  119133. /**
  119134. * Array of settings
  119135. */
  119136. settings: Array<ISimplificationSettings>;
  119137. /**
  119138. * Simplification type
  119139. */
  119140. simplificationType: SimplificationType;
  119141. /**
  119142. * Mesh to simplify
  119143. */
  119144. mesh: Mesh;
  119145. /**
  119146. * Callback called on success
  119147. */
  119148. successCallback?: () => void;
  119149. /**
  119150. * Defines if parallel processing can be used
  119151. */
  119152. parallelProcessing: boolean;
  119153. }
  119154. /**
  119155. * Queue used to order the simplification tasks
  119156. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  119157. */
  119158. export class SimplificationQueue {
  119159. private _simplificationArray;
  119160. /**
  119161. * Gets a boolean indicating that the process is still running
  119162. */
  119163. running: boolean;
  119164. /**
  119165. * Creates a new queue
  119166. */
  119167. constructor();
  119168. /**
  119169. * Adds a new simplification task
  119170. * @param task defines a task to add
  119171. */
  119172. addTask(task: ISimplificationTask): void;
  119173. /**
  119174. * Execute next task
  119175. */
  119176. executeNext(): void;
  119177. /**
  119178. * Execute a simplification task
  119179. * @param task defines the task to run
  119180. */
  119181. runSimplification(task: ISimplificationTask): void;
  119182. private getSimplifier;
  119183. }
  119184. /**
  119185. * The implemented types of simplification
  119186. * At the moment only Quadratic Error Decimation is implemented
  119187. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  119188. */
  119189. export enum SimplificationType {
  119190. /** Quadratic error decimation */
  119191. QUADRATIC = 0
  119192. }
  119193. }
  119194. declare module BABYLON {
  119195. interface Scene {
  119196. /** @hidden (Backing field) */
  119197. _simplificationQueue: SimplificationQueue;
  119198. /**
  119199. * Gets or sets the simplification queue attached to the scene
  119200. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  119201. */
  119202. simplificationQueue: SimplificationQueue;
  119203. }
  119204. interface Mesh {
  119205. /**
  119206. * Simplify the mesh according to the given array of settings.
  119207. * Function will return immediately and will simplify async
  119208. * @param settings a collection of simplification settings
  119209. * @param parallelProcessing should all levels calculate parallel or one after the other
  119210. * @param simplificationType the type of simplification to run
  119211. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  119212. * @returns the current mesh
  119213. */
  119214. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  119215. }
  119216. /**
  119217. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  119218. * created in a scene
  119219. */
  119220. export class SimplicationQueueSceneComponent implements ISceneComponent {
  119221. /**
  119222. * The component name helpfull to identify the component in the list of scene components.
  119223. */
  119224. readonly name: string;
  119225. /**
  119226. * The scene the component belongs to.
  119227. */
  119228. scene: Scene;
  119229. /**
  119230. * Creates a new instance of the component for the given scene
  119231. * @param scene Defines the scene to register the component in
  119232. */
  119233. constructor(scene: Scene);
  119234. /**
  119235. * Registers the component in a given scene
  119236. */
  119237. register(): void;
  119238. /**
  119239. * Rebuilds the elements related to this component in case of
  119240. * context lost for instance.
  119241. */
  119242. rebuild(): void;
  119243. /**
  119244. * Disposes the component and the associated ressources
  119245. */
  119246. dispose(): void;
  119247. private _beforeCameraUpdate;
  119248. }
  119249. }
  119250. declare module BABYLON {
  119251. /**
  119252. * Navigation plugin interface to add navigation constrained by a navigation mesh
  119253. */
  119254. export interface INavigationEnginePlugin {
  119255. /**
  119256. * plugin name
  119257. */
  119258. name: string;
  119259. /**
  119260. * Creates a navigation mesh
  119261. * @param meshes array of all the geometry used to compute the navigatio mesh
  119262. * @param parameters bunch of parameters used to filter geometry
  119263. */
  119264. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  119265. /**
  119266. * Create a navigation mesh debug mesh
  119267. * @param scene is where the mesh will be added
  119268. * @returns debug display mesh
  119269. */
  119270. createDebugNavMesh(scene: Scene): Mesh;
  119271. /**
  119272. * Get a navigation mesh constrained position, closest to the parameter position
  119273. * @param position world position
  119274. * @returns the closest point to position constrained by the navigation mesh
  119275. */
  119276. getClosestPoint(position: Vector3): Vector3;
  119277. /**
  119278. * Get a navigation mesh constrained position, within a particular radius
  119279. * @param position world position
  119280. * @param maxRadius the maximum distance to the constrained world position
  119281. * @returns the closest point to position constrained by the navigation mesh
  119282. */
  119283. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  119284. /**
  119285. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  119286. * @param start world position
  119287. * @param end world position
  119288. * @returns array containing world position composing the path
  119289. */
  119290. computePath(start: Vector3, end: Vector3): Vector3[];
  119291. /**
  119292. * If this plugin is supported
  119293. * @returns true if plugin is supported
  119294. */
  119295. isSupported(): boolean;
  119296. /**
  119297. * Create a new Crowd so you can add agents
  119298. * @param maxAgents the maximum agent count in the crowd
  119299. * @param maxAgentRadius the maximum radius an agent can have
  119300. * @param scene to attach the crowd to
  119301. * @returns the crowd you can add agents to
  119302. */
  119303. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  119304. /**
  119305. * Release all resources
  119306. */
  119307. dispose(): void;
  119308. }
  119309. /**
  119310. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  119311. */
  119312. export interface ICrowd {
  119313. /**
  119314. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  119315. * You can attach anything to that node. The node position is updated in the scene update tick.
  119316. * @param pos world position that will be constrained by the navigation mesh
  119317. * @param parameters agent parameters
  119318. * @param transform hooked to the agent that will be update by the scene
  119319. * @returns agent index
  119320. */
  119321. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  119322. /**
  119323. * Returns the agent position in world space
  119324. * @param index agent index returned by addAgent
  119325. * @returns world space position
  119326. */
  119327. getAgentPosition(index: number): Vector3;
  119328. /**
  119329. * Gets the agent velocity in world space
  119330. * @param index agent index returned by addAgent
  119331. * @returns world space velocity
  119332. */
  119333. getAgentVelocity(index: number): Vector3;
  119334. /**
  119335. * remove a particular agent previously created
  119336. * @param index agent index returned by addAgent
  119337. */
  119338. removeAgent(index: number): void;
  119339. /**
  119340. * get the list of all agents attached to this crowd
  119341. * @returns list of agent indices
  119342. */
  119343. getAgents(): number[];
  119344. /**
  119345. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  119346. * @param deltaTime in seconds
  119347. */
  119348. update(deltaTime: number): void;
  119349. /**
  119350. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  119351. * @param index agent index returned by addAgent
  119352. * @param destination targeted world position
  119353. */
  119354. agentGoto(index: number, destination: Vector3): void;
  119355. /**
  119356. * Release all resources
  119357. */
  119358. dispose(): void;
  119359. }
  119360. /**
  119361. * Configures an agent
  119362. */
  119363. export interface IAgentParameters {
  119364. /**
  119365. * Agent radius. [Limit: >= 0]
  119366. */
  119367. radius: number;
  119368. /**
  119369. * Agent height. [Limit: > 0]
  119370. */
  119371. height: number;
  119372. /**
  119373. * Maximum allowed acceleration. [Limit: >= 0]
  119374. */
  119375. maxAcceleration: number;
  119376. /**
  119377. * Maximum allowed speed. [Limit: >= 0]
  119378. */
  119379. maxSpeed: number;
  119380. /**
  119381. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  119382. */
  119383. collisionQueryRange: number;
  119384. /**
  119385. * The path visibility optimization range. [Limit: > 0]
  119386. */
  119387. pathOptimizationRange: number;
  119388. /**
  119389. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  119390. */
  119391. separationWeight: number;
  119392. }
  119393. /**
  119394. * Configures the navigation mesh creation
  119395. */
  119396. export interface INavMeshParameters {
  119397. /**
  119398. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  119399. */
  119400. cs: number;
  119401. /**
  119402. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  119403. */
  119404. ch: number;
  119405. /**
  119406. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  119407. */
  119408. walkableSlopeAngle: number;
  119409. /**
  119410. * Minimum floor to 'ceiling' height that will still allow the floor area to
  119411. * be considered walkable. [Limit: >= 3] [Units: vx]
  119412. */
  119413. walkableHeight: number;
  119414. /**
  119415. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  119416. */
  119417. walkableClimb: number;
  119418. /**
  119419. * The distance to erode/shrink the walkable area of the heightfield away from
  119420. * obstructions. [Limit: >=0] [Units: vx]
  119421. */
  119422. walkableRadius: number;
  119423. /**
  119424. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  119425. */
  119426. maxEdgeLen: number;
  119427. /**
  119428. * The maximum distance a simplfied contour's border edges should deviate
  119429. * the original raw contour. [Limit: >=0] [Units: vx]
  119430. */
  119431. maxSimplificationError: number;
  119432. /**
  119433. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  119434. */
  119435. minRegionArea: number;
  119436. /**
  119437. * Any regions with a span count smaller than this value will, if possible,
  119438. * be merged with larger regions. [Limit: >=0] [Units: vx]
  119439. */
  119440. mergeRegionArea: number;
  119441. /**
  119442. * The maximum number of vertices allowed for polygons generated during the
  119443. * contour to polygon conversion process. [Limit: >= 3]
  119444. */
  119445. maxVertsPerPoly: number;
  119446. /**
  119447. * Sets the sampling distance to use when generating the detail mesh.
  119448. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  119449. */
  119450. detailSampleDist: number;
  119451. /**
  119452. * The maximum distance the detail mesh surface should deviate from heightfield
  119453. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  119454. */
  119455. detailSampleMaxError: number;
  119456. }
  119457. }
  119458. declare module BABYLON {
  119459. /**
  119460. * RecastJS navigation plugin
  119461. */
  119462. export class RecastJSPlugin implements INavigationEnginePlugin {
  119463. /**
  119464. * Reference to the Recast library
  119465. */
  119466. bjsRECAST: any;
  119467. /**
  119468. * plugin name
  119469. */
  119470. name: string;
  119471. /**
  119472. * the first navmesh created. We might extend this to support multiple navmeshes
  119473. */
  119474. navMesh: any;
  119475. /**
  119476. * Initializes the recastJS plugin
  119477. * @param recastInjection can be used to inject your own recast reference
  119478. */
  119479. constructor(recastInjection?: any);
  119480. /**
  119481. * Creates a navigation mesh
  119482. * @param meshes array of all the geometry used to compute the navigatio mesh
  119483. * @param parameters bunch of parameters used to filter geometry
  119484. */
  119485. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  119486. /**
  119487. * Create a navigation mesh debug mesh
  119488. * @param scene is where the mesh will be added
  119489. * @returns debug display mesh
  119490. */
  119491. createDebugNavMesh(scene: Scene): Mesh;
  119492. /**
  119493. * Get a navigation mesh constrained position, closest to the parameter position
  119494. * @param position world position
  119495. * @returns the closest point to position constrained by the navigation mesh
  119496. */
  119497. getClosestPoint(position: Vector3): Vector3;
  119498. /**
  119499. * Get a navigation mesh constrained position, within a particular radius
  119500. * @param position world position
  119501. * @param maxRadius the maximum distance to the constrained world position
  119502. * @returns the closest point to position constrained by the navigation mesh
  119503. */
  119504. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  119505. /**
  119506. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  119507. * @param start world position
  119508. * @param end world position
  119509. * @returns array containing world position composing the path
  119510. */
  119511. computePath(start: Vector3, end: Vector3): Vector3[];
  119512. /**
  119513. * Create a new Crowd so you can add agents
  119514. * @param maxAgents the maximum agent count in the crowd
  119515. * @param maxAgentRadius the maximum radius an agent can have
  119516. * @param scene to attach the crowd to
  119517. * @returns the crowd you can add agents to
  119518. */
  119519. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  119520. /**
  119521. * Disposes
  119522. */
  119523. dispose(): void;
  119524. /**
  119525. * If this plugin is supported
  119526. * @returns true if plugin is supported
  119527. */
  119528. isSupported(): boolean;
  119529. }
  119530. /**
  119531. * Recast detour crowd implementation
  119532. */
  119533. export class RecastJSCrowd implements ICrowd {
  119534. /**
  119535. * Recast/detour plugin
  119536. */
  119537. bjsRECASTPlugin: RecastJSPlugin;
  119538. /**
  119539. * Link to the detour crowd
  119540. */
  119541. recastCrowd: any;
  119542. /**
  119543. * One transform per agent
  119544. */
  119545. transforms: TransformNode[];
  119546. /**
  119547. * All agents created
  119548. */
  119549. agents: number[];
  119550. /**
  119551. * Link to the scene is kept to unregister the crowd from the scene
  119552. */
  119553. private _scene;
  119554. /**
  119555. * Observer for crowd updates
  119556. */
  119557. private _onBeforeAnimationsObserver;
  119558. /**
  119559. * Constructor
  119560. * @param plugin recastJS plugin
  119561. * @param maxAgents the maximum agent count in the crowd
  119562. * @param maxAgentRadius the maximum radius an agent can have
  119563. * @param scene to attach the crowd to
  119564. * @returns the crowd you can add agents to
  119565. */
  119566. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  119567. /**
  119568. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  119569. * You can attach anything to that node. The node position is updated in the scene update tick.
  119570. * @param pos world position that will be constrained by the navigation mesh
  119571. * @param parameters agent parameters
  119572. * @param transform hooked to the agent that will be update by the scene
  119573. * @returns agent index
  119574. */
  119575. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  119576. /**
  119577. * Returns the agent position in world space
  119578. * @param index agent index returned by addAgent
  119579. * @returns world space position
  119580. */
  119581. getAgentPosition(index: number): Vector3;
  119582. /**
  119583. * Returns the agent velocity in world space
  119584. * @param index agent index returned by addAgent
  119585. * @returns world space velocity
  119586. */
  119587. getAgentVelocity(index: number): Vector3;
  119588. /**
  119589. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  119590. * @param index agent index returned by addAgent
  119591. * @param destination targeted world position
  119592. */
  119593. agentGoto(index: number, destination: Vector3): void;
  119594. /**
  119595. * remove a particular agent previously created
  119596. * @param index agent index returned by addAgent
  119597. */
  119598. removeAgent(index: number): void;
  119599. /**
  119600. * get the list of all agents attached to this crowd
  119601. * @returns list of agent indices
  119602. */
  119603. getAgents(): number[];
  119604. /**
  119605. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  119606. * @param deltaTime in seconds
  119607. */
  119608. update(deltaTime: number): void;
  119609. /**
  119610. * Release all resources
  119611. */
  119612. dispose(): void;
  119613. }
  119614. }
  119615. declare module BABYLON {
  119616. /**
  119617. * Class used to enable access to IndexedDB
  119618. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119619. */
  119620. export class Database implements IOfflineProvider {
  119621. private _callbackManifestChecked;
  119622. private _currentSceneUrl;
  119623. private _db;
  119624. private _enableSceneOffline;
  119625. private _enableTexturesOffline;
  119626. private _manifestVersionFound;
  119627. private _mustUpdateRessources;
  119628. private _hasReachedQuota;
  119629. private _isSupported;
  119630. private _idbFactory;
  119631. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  119632. private static IsUASupportingBlobStorage;
  119633. /**
  119634. * Gets a boolean indicating if Database storate is enabled (off by default)
  119635. */
  119636. static IDBStorageEnabled: boolean;
  119637. /**
  119638. * Gets a boolean indicating if scene must be saved in the database
  119639. */
  119640. readonly enableSceneOffline: boolean;
  119641. /**
  119642. * Gets a boolean indicating if textures must be saved in the database
  119643. */
  119644. readonly enableTexturesOffline: boolean;
  119645. /**
  119646. * Creates a new Database
  119647. * @param urlToScene defines the url to load the scene
  119648. * @param callbackManifestChecked defines the callback to use when manifest is checked
  119649. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  119650. */
  119651. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  119652. private static _ParseURL;
  119653. private static _ReturnFullUrlLocation;
  119654. private _checkManifestFile;
  119655. /**
  119656. * Open the database and make it available
  119657. * @param successCallback defines the callback to call on success
  119658. * @param errorCallback defines the callback to call on error
  119659. */
  119660. open(successCallback: () => void, errorCallback: () => void): void;
  119661. /**
  119662. * Loads an image from the database
  119663. * @param url defines the url to load from
  119664. * @param image defines the target DOM image
  119665. */
  119666. loadImage(url: string, image: HTMLImageElement): void;
  119667. private _loadImageFromDBAsync;
  119668. private _saveImageIntoDBAsync;
  119669. private _checkVersionFromDB;
  119670. private _loadVersionFromDBAsync;
  119671. private _saveVersionIntoDBAsync;
  119672. /**
  119673. * Loads a file from database
  119674. * @param url defines the URL to load from
  119675. * @param sceneLoaded defines a callback to call on success
  119676. * @param progressCallBack defines a callback to call when progress changed
  119677. * @param errorCallback defines a callback to call on error
  119678. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  119679. */
  119680. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  119681. private _loadFileAsync;
  119682. private _saveFileAsync;
  119683. /**
  119684. * Validates if xhr data is correct
  119685. * @param xhr defines the request to validate
  119686. * @param dataType defines the expected data type
  119687. * @returns true if data is correct
  119688. */
  119689. private static _ValidateXHRData;
  119690. }
  119691. }
  119692. declare module BABYLON {
  119693. /** @hidden */
  119694. export var gpuUpdateParticlesPixelShader: {
  119695. name: string;
  119696. shader: string;
  119697. };
  119698. }
  119699. declare module BABYLON {
  119700. /** @hidden */
  119701. export var gpuUpdateParticlesVertexShader: {
  119702. name: string;
  119703. shader: string;
  119704. };
  119705. }
  119706. declare module BABYLON {
  119707. /** @hidden */
  119708. export var clipPlaneFragmentDeclaration2: {
  119709. name: string;
  119710. shader: string;
  119711. };
  119712. }
  119713. declare module BABYLON {
  119714. /** @hidden */
  119715. export var gpuRenderParticlesPixelShader: {
  119716. name: string;
  119717. shader: string;
  119718. };
  119719. }
  119720. declare module BABYLON {
  119721. /** @hidden */
  119722. export var clipPlaneVertexDeclaration2: {
  119723. name: string;
  119724. shader: string;
  119725. };
  119726. }
  119727. declare module BABYLON {
  119728. /** @hidden */
  119729. export var gpuRenderParticlesVertexShader: {
  119730. name: string;
  119731. shader: string;
  119732. };
  119733. }
  119734. declare module BABYLON {
  119735. /**
  119736. * This represents a GPU particle system in Babylon
  119737. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  119738. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  119739. */
  119740. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  119741. /**
  119742. * The layer mask we are rendering the particles through.
  119743. */
  119744. layerMask: number;
  119745. private _capacity;
  119746. private _activeCount;
  119747. private _currentActiveCount;
  119748. private _accumulatedCount;
  119749. private _renderEffect;
  119750. private _updateEffect;
  119751. private _buffer0;
  119752. private _buffer1;
  119753. private _spriteBuffer;
  119754. private _updateVAO;
  119755. private _renderVAO;
  119756. private _targetIndex;
  119757. private _sourceBuffer;
  119758. private _targetBuffer;
  119759. private _engine;
  119760. private _currentRenderId;
  119761. private _started;
  119762. private _stopped;
  119763. private _timeDelta;
  119764. private _randomTexture;
  119765. private _randomTexture2;
  119766. private _attributesStrideSize;
  119767. private _updateEffectOptions;
  119768. private _randomTextureSize;
  119769. private _actualFrame;
  119770. private readonly _rawTextureWidth;
  119771. /**
  119772. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  119773. */
  119774. static readonly IsSupported: boolean;
  119775. /**
  119776. * An event triggered when the system is disposed.
  119777. */
  119778. onDisposeObservable: Observable<GPUParticleSystem>;
  119779. /**
  119780. * Gets the maximum number of particles active at the same time.
  119781. * @returns The max number of active particles.
  119782. */
  119783. getCapacity(): number;
  119784. /**
  119785. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  119786. * to override the particles.
  119787. */
  119788. forceDepthWrite: boolean;
  119789. /**
  119790. * Gets or set the number of active particles
  119791. */
  119792. activeParticleCount: number;
  119793. private _preWarmDone;
  119794. /**
  119795. * Is this system ready to be used/rendered
  119796. * @return true if the system is ready
  119797. */
  119798. isReady(): boolean;
  119799. /**
  119800. * Gets if the system has been started. (Note: this will still be true after stop is called)
  119801. * @returns True if it has been started, otherwise false.
  119802. */
  119803. isStarted(): boolean;
  119804. /**
  119805. * Starts the particle system and begins to emit
  119806. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  119807. */
  119808. start(delay?: number): void;
  119809. /**
  119810. * Stops the particle system.
  119811. */
  119812. stop(): void;
  119813. /**
  119814. * Remove all active particles
  119815. */
  119816. reset(): void;
  119817. /**
  119818. * Returns the string "GPUParticleSystem"
  119819. * @returns a string containing the class name
  119820. */
  119821. getClassName(): string;
  119822. private _colorGradientsTexture;
  119823. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  119824. /**
  119825. * Adds a new color gradient
  119826. * @param gradient defines the gradient to use (between 0 and 1)
  119827. * @param color1 defines the color to affect to the specified gradient
  119828. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  119829. * @returns the current particle system
  119830. */
  119831. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  119832. /**
  119833. * Remove a specific color gradient
  119834. * @param gradient defines the gradient to remove
  119835. * @returns the current particle system
  119836. */
  119837. removeColorGradient(gradient: number): GPUParticleSystem;
  119838. private _angularSpeedGradientsTexture;
  119839. private _sizeGradientsTexture;
  119840. private _velocityGradientsTexture;
  119841. private _limitVelocityGradientsTexture;
  119842. private _dragGradientsTexture;
  119843. private _addFactorGradient;
  119844. /**
  119845. * Adds a new size gradient
  119846. * @param gradient defines the gradient to use (between 0 and 1)
  119847. * @param factor defines the size factor to affect to the specified gradient
  119848. * @returns the current particle system
  119849. */
  119850. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  119851. /**
  119852. * Remove a specific size gradient
  119853. * @param gradient defines the gradient to remove
  119854. * @returns the current particle system
  119855. */
  119856. removeSizeGradient(gradient: number): GPUParticleSystem;
  119857. /**
  119858. * Adds a new angular speed gradient
  119859. * @param gradient defines the gradient to use (between 0 and 1)
  119860. * @param factor defines the angular speed to affect to the specified gradient
  119861. * @returns the current particle system
  119862. */
  119863. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  119864. /**
  119865. * Remove a specific angular speed gradient
  119866. * @param gradient defines the gradient to remove
  119867. * @returns the current particle system
  119868. */
  119869. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  119870. /**
  119871. * Adds a new velocity gradient
  119872. * @param gradient defines the gradient to use (between 0 and 1)
  119873. * @param factor defines the velocity to affect to the specified gradient
  119874. * @returns the current particle system
  119875. */
  119876. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  119877. /**
  119878. * Remove a specific velocity gradient
  119879. * @param gradient defines the gradient to remove
  119880. * @returns the current particle system
  119881. */
  119882. removeVelocityGradient(gradient: number): GPUParticleSystem;
  119883. /**
  119884. * Adds a new limit velocity gradient
  119885. * @param gradient defines the gradient to use (between 0 and 1)
  119886. * @param factor defines the limit velocity value to affect to the specified gradient
  119887. * @returns the current particle system
  119888. */
  119889. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  119890. /**
  119891. * Remove a specific limit velocity gradient
  119892. * @param gradient defines the gradient to remove
  119893. * @returns the current particle system
  119894. */
  119895. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  119896. /**
  119897. * Adds a new drag gradient
  119898. * @param gradient defines the gradient to use (between 0 and 1)
  119899. * @param factor defines the drag value to affect to the specified gradient
  119900. * @returns the current particle system
  119901. */
  119902. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  119903. /**
  119904. * Remove a specific drag gradient
  119905. * @param gradient defines the gradient to remove
  119906. * @returns the current particle system
  119907. */
  119908. removeDragGradient(gradient: number): GPUParticleSystem;
  119909. /**
  119910. * Not supported by GPUParticleSystem
  119911. * @param gradient defines the gradient to use (between 0 and 1)
  119912. * @param factor defines the emit rate value to affect to the specified gradient
  119913. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  119914. * @returns the current particle system
  119915. */
  119916. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  119917. /**
  119918. * Not supported by GPUParticleSystem
  119919. * @param gradient defines the gradient to remove
  119920. * @returns the current particle system
  119921. */
  119922. removeEmitRateGradient(gradient: number): IParticleSystem;
  119923. /**
  119924. * Not supported by GPUParticleSystem
  119925. * @param gradient defines the gradient to use (between 0 and 1)
  119926. * @param factor defines the start size value to affect to the specified gradient
  119927. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  119928. * @returns the current particle system
  119929. */
  119930. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  119931. /**
  119932. * Not supported by GPUParticleSystem
  119933. * @param gradient defines the gradient to remove
  119934. * @returns the current particle system
  119935. */
  119936. removeStartSizeGradient(gradient: number): IParticleSystem;
  119937. /**
  119938. * Not supported by GPUParticleSystem
  119939. * @param gradient defines the gradient to use (between 0 and 1)
  119940. * @param min defines the color remap minimal range
  119941. * @param max defines the color remap maximal range
  119942. * @returns the current particle system
  119943. */
  119944. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  119945. /**
  119946. * Not supported by GPUParticleSystem
  119947. * @param gradient defines the gradient to remove
  119948. * @returns the current particle system
  119949. */
  119950. removeColorRemapGradient(): IParticleSystem;
  119951. /**
  119952. * Not supported by GPUParticleSystem
  119953. * @param gradient defines the gradient to use (between 0 and 1)
  119954. * @param min defines the alpha remap minimal range
  119955. * @param max defines the alpha remap maximal range
  119956. * @returns the current particle system
  119957. */
  119958. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  119959. /**
  119960. * Not supported by GPUParticleSystem
  119961. * @param gradient defines the gradient to remove
  119962. * @returns the current particle system
  119963. */
  119964. removeAlphaRemapGradient(): IParticleSystem;
  119965. /**
  119966. * Not supported by GPUParticleSystem
  119967. * @param gradient defines the gradient to use (between 0 and 1)
  119968. * @param color defines the color to affect to the specified gradient
  119969. * @returns the current particle system
  119970. */
  119971. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  119972. /**
  119973. * Not supported by GPUParticleSystem
  119974. * @param gradient defines the gradient to remove
  119975. * @returns the current particle system
  119976. */
  119977. removeRampGradient(): IParticleSystem;
  119978. /**
  119979. * Not supported by GPUParticleSystem
  119980. * @returns the list of ramp gradients
  119981. */
  119982. getRampGradients(): Nullable<Array<Color3Gradient>>;
  119983. /**
  119984. * Not supported by GPUParticleSystem
  119985. * Gets or sets a boolean indicating that ramp gradients must be used
  119986. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  119987. */
  119988. useRampGradients: boolean;
  119989. /**
  119990. * Not supported by GPUParticleSystem
  119991. * @param gradient defines the gradient to use (between 0 and 1)
  119992. * @param factor defines the life time factor to affect to the specified gradient
  119993. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  119994. * @returns the current particle system
  119995. */
  119996. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  119997. /**
  119998. * Not supported by GPUParticleSystem
  119999. * @param gradient defines the gradient to remove
  120000. * @returns the current particle system
  120001. */
  120002. removeLifeTimeGradient(gradient: number): IParticleSystem;
  120003. /**
  120004. * Instantiates a GPU particle system.
  120005. * 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.
  120006. * @param name The name of the particle system
  120007. * @param options The options used to create the system
  120008. * @param scene The scene the particle system belongs to
  120009. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  120010. */
  120011. constructor(name: string, options: Partial<{
  120012. capacity: number;
  120013. randomTextureSize: number;
  120014. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  120015. protected _reset(): void;
  120016. private _createUpdateVAO;
  120017. private _createRenderVAO;
  120018. private _initialize;
  120019. /** @hidden */
  120020. _recreateUpdateEffect(): void;
  120021. /** @hidden */
  120022. _recreateRenderEffect(): void;
  120023. /**
  120024. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  120025. * @param preWarm defines if we are in the pre-warmimg phase
  120026. */
  120027. animate(preWarm?: boolean): void;
  120028. private _createFactorGradientTexture;
  120029. private _createSizeGradientTexture;
  120030. private _createAngularSpeedGradientTexture;
  120031. private _createVelocityGradientTexture;
  120032. private _createLimitVelocityGradientTexture;
  120033. private _createDragGradientTexture;
  120034. private _createColorGradientTexture;
  120035. /**
  120036. * Renders the particle system in its current state
  120037. * @param preWarm defines if the system should only update the particles but not render them
  120038. * @returns the current number of particles
  120039. */
  120040. render(preWarm?: boolean): number;
  120041. /**
  120042. * Rebuilds the particle system
  120043. */
  120044. rebuild(): void;
  120045. private _releaseBuffers;
  120046. private _releaseVAOs;
  120047. /**
  120048. * Disposes the particle system and free the associated resources
  120049. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  120050. */
  120051. dispose(disposeTexture?: boolean): void;
  120052. /**
  120053. * Clones the particle system.
  120054. * @param name The name of the cloned object
  120055. * @param newEmitter The new emitter to use
  120056. * @returns the cloned particle system
  120057. */
  120058. clone(name: string, newEmitter: any): GPUParticleSystem;
  120059. /**
  120060. * Serializes the particle system to a JSON object.
  120061. * @returns the JSON object
  120062. */
  120063. serialize(): any;
  120064. /**
  120065. * Parses a JSON object to create a GPU particle system.
  120066. * @param parsedParticleSystem The JSON object to parse
  120067. * @param scene The scene to create the particle system in
  120068. * @param rootUrl The root url to use to load external dependencies like texture
  120069. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  120070. * @returns the parsed GPU particle system
  120071. */
  120072. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  120073. }
  120074. }
  120075. declare module BABYLON {
  120076. /**
  120077. * Represents a set of particle systems working together to create a specific effect
  120078. */
  120079. export class ParticleSystemSet implements IDisposable {
  120080. private _emitterCreationOptions;
  120081. private _emitterNode;
  120082. /**
  120083. * Gets the particle system list
  120084. */
  120085. systems: IParticleSystem[];
  120086. /**
  120087. * Gets the emitter node used with this set
  120088. */
  120089. readonly emitterNode: Nullable<TransformNode>;
  120090. /**
  120091. * Creates a new emitter mesh as a sphere
  120092. * @param options defines the options used to create the sphere
  120093. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  120094. * @param scene defines the hosting scene
  120095. */
  120096. setEmitterAsSphere(options: {
  120097. diameter: number;
  120098. segments: number;
  120099. color: Color3;
  120100. }, renderingGroupId: number, scene: Scene): void;
  120101. /**
  120102. * Starts all particle systems of the set
  120103. * @param emitter defines an optional mesh to use as emitter for the particle systems
  120104. */
  120105. start(emitter?: AbstractMesh): void;
  120106. /**
  120107. * Release all associated resources
  120108. */
  120109. dispose(): void;
  120110. /**
  120111. * Serialize the set into a JSON compatible object
  120112. * @returns a JSON compatible representation of the set
  120113. */
  120114. serialize(): any;
  120115. /**
  120116. * Parse a new ParticleSystemSet from a serialized source
  120117. * @param data defines a JSON compatible representation of the set
  120118. * @param scene defines the hosting scene
  120119. * @param gpu defines if we want GPU particles or CPU particles
  120120. * @returns a new ParticleSystemSet
  120121. */
  120122. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  120123. }
  120124. }
  120125. declare module BABYLON {
  120126. /**
  120127. * This class is made for on one-liner static method to help creating particle system set.
  120128. */
  120129. export class ParticleHelper {
  120130. /**
  120131. * Gets or sets base Assets URL
  120132. */
  120133. static BaseAssetsUrl: string;
  120134. /**
  120135. * Create a default particle system that you can tweak
  120136. * @param emitter defines the emitter to use
  120137. * @param capacity defines the system capacity (default is 500 particles)
  120138. * @param scene defines the hosting scene
  120139. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  120140. * @returns the new Particle system
  120141. */
  120142. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  120143. /**
  120144. * This is the main static method (one-liner) of this helper to create different particle systems
  120145. * @param type This string represents the type to the particle system to create
  120146. * @param scene The scene where the particle system should live
  120147. * @param gpu If the system will use gpu
  120148. * @returns the ParticleSystemSet created
  120149. */
  120150. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  120151. /**
  120152. * Static function used to export a particle system to a ParticleSystemSet variable.
  120153. * Please note that the emitter shape is not exported
  120154. * @param systems defines the particle systems to export
  120155. * @returns the created particle system set
  120156. */
  120157. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  120158. }
  120159. }
  120160. declare module BABYLON {
  120161. interface Engine {
  120162. /**
  120163. * Create an effect to use with particle systems.
  120164. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  120165. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  120166. * @param uniformsNames defines a list of attribute names
  120167. * @param samplers defines an array of string used to represent textures
  120168. * @param defines defines the string containing the defines to use to compile the shaders
  120169. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  120170. * @param onCompiled defines a function to call when the effect creation is successful
  120171. * @param onError defines a function to call when the effect creation has failed
  120172. * @returns the new Effect
  120173. */
  120174. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  120175. }
  120176. interface Mesh {
  120177. /**
  120178. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  120179. * @returns an array of IParticleSystem
  120180. */
  120181. getEmittedParticleSystems(): IParticleSystem[];
  120182. /**
  120183. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  120184. * @returns an array of IParticleSystem
  120185. */
  120186. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  120187. }
  120188. /**
  120189. * @hidden
  120190. */
  120191. export var _IDoNeedToBeInTheBuild: number;
  120192. }
  120193. declare module BABYLON {
  120194. interface Scene {
  120195. /** @hidden (Backing field) */
  120196. _physicsEngine: Nullable<IPhysicsEngine>;
  120197. /**
  120198. * Gets the current physics engine
  120199. * @returns a IPhysicsEngine or null if none attached
  120200. */
  120201. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  120202. /**
  120203. * Enables physics to the current scene
  120204. * @param gravity defines the scene's gravity for the physics engine
  120205. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  120206. * @return a boolean indicating if the physics engine was initialized
  120207. */
  120208. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  120209. /**
  120210. * Disables and disposes the physics engine associated with the scene
  120211. */
  120212. disablePhysicsEngine(): void;
  120213. /**
  120214. * Gets a boolean indicating if there is an active physics engine
  120215. * @returns a boolean indicating if there is an active physics engine
  120216. */
  120217. isPhysicsEnabled(): boolean;
  120218. /**
  120219. * Deletes a physics compound impostor
  120220. * @param compound defines the compound to delete
  120221. */
  120222. deleteCompoundImpostor(compound: any): void;
  120223. /**
  120224. * An event triggered when physic simulation is about to be run
  120225. */
  120226. onBeforePhysicsObservable: Observable<Scene>;
  120227. /**
  120228. * An event triggered when physic simulation has been done
  120229. */
  120230. onAfterPhysicsObservable: Observable<Scene>;
  120231. }
  120232. interface AbstractMesh {
  120233. /** @hidden */
  120234. _physicsImpostor: Nullable<PhysicsImpostor>;
  120235. /**
  120236. * Gets or sets impostor used for physic simulation
  120237. * @see http://doc.babylonjs.com/features/physics_engine
  120238. */
  120239. physicsImpostor: Nullable<PhysicsImpostor>;
  120240. /**
  120241. * Gets the current physics impostor
  120242. * @see http://doc.babylonjs.com/features/physics_engine
  120243. * @returns a physics impostor or null
  120244. */
  120245. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  120246. /** Apply a physic impulse to the mesh
  120247. * @param force defines the force to apply
  120248. * @param contactPoint defines where to apply the force
  120249. * @returns the current mesh
  120250. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  120251. */
  120252. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  120253. /**
  120254. * Creates a physic joint between two meshes
  120255. * @param otherMesh defines the other mesh to use
  120256. * @param pivot1 defines the pivot to use on this mesh
  120257. * @param pivot2 defines the pivot to use on the other mesh
  120258. * @param options defines additional options (can be plugin dependent)
  120259. * @returns the current mesh
  120260. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  120261. */
  120262. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  120263. /** @hidden */
  120264. _disposePhysicsObserver: Nullable<Observer<Node>>;
  120265. }
  120266. /**
  120267. * Defines the physics engine scene component responsible to manage a physics engine
  120268. */
  120269. export class PhysicsEngineSceneComponent implements ISceneComponent {
  120270. /**
  120271. * The component name helpful to identify the component in the list of scene components.
  120272. */
  120273. readonly name: string;
  120274. /**
  120275. * The scene the component belongs to.
  120276. */
  120277. scene: Scene;
  120278. /**
  120279. * Creates a new instance of the component for the given scene
  120280. * @param scene Defines the scene to register the component in
  120281. */
  120282. constructor(scene: Scene);
  120283. /**
  120284. * Registers the component in a given scene
  120285. */
  120286. register(): void;
  120287. /**
  120288. * Rebuilds the elements related to this component in case of
  120289. * context lost for instance.
  120290. */
  120291. rebuild(): void;
  120292. /**
  120293. * Disposes the component and the associated ressources
  120294. */
  120295. dispose(): void;
  120296. }
  120297. }
  120298. declare module BABYLON {
  120299. /**
  120300. * A helper for physics simulations
  120301. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120302. */
  120303. export class PhysicsHelper {
  120304. private _scene;
  120305. private _physicsEngine;
  120306. /**
  120307. * Initializes the Physics helper
  120308. * @param scene Babylon.js scene
  120309. */
  120310. constructor(scene: Scene);
  120311. /**
  120312. * Applies a radial explosion impulse
  120313. * @param origin the origin of the explosion
  120314. * @param radiusOrEventOptions the radius or the options of radial explosion
  120315. * @param strength the explosion strength
  120316. * @param falloff possible options: Constant & Linear. Defaults to Constant
  120317. * @returns A physics radial explosion event, or null
  120318. */
  120319. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  120320. /**
  120321. * Applies a radial explosion force
  120322. * @param origin the origin of the explosion
  120323. * @param radiusOrEventOptions the radius or the options of radial explosion
  120324. * @param strength the explosion strength
  120325. * @param falloff possible options: Constant & Linear. Defaults to Constant
  120326. * @returns A physics radial explosion event, or null
  120327. */
  120328. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  120329. /**
  120330. * Creates a gravitational field
  120331. * @param origin the origin of the explosion
  120332. * @param radiusOrEventOptions the radius or the options of radial explosion
  120333. * @param strength the explosion strength
  120334. * @param falloff possible options: Constant & Linear. Defaults to Constant
  120335. * @returns A physics gravitational field event, or null
  120336. */
  120337. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  120338. /**
  120339. * Creates a physics updraft event
  120340. * @param origin the origin of the updraft
  120341. * @param radiusOrEventOptions the radius or the options of the updraft
  120342. * @param strength the strength of the updraft
  120343. * @param height the height of the updraft
  120344. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  120345. * @returns A physics updraft event, or null
  120346. */
  120347. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  120348. /**
  120349. * Creates a physics vortex event
  120350. * @param origin the of the vortex
  120351. * @param radiusOrEventOptions the radius or the options of the vortex
  120352. * @param strength the strength of the vortex
  120353. * @param height the height of the vortex
  120354. * @returns a Physics vortex event, or null
  120355. * A physics vortex event or null
  120356. */
  120357. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  120358. }
  120359. /**
  120360. * Represents a physics radial explosion event
  120361. */
  120362. class PhysicsRadialExplosionEvent {
  120363. private _scene;
  120364. private _options;
  120365. private _sphere;
  120366. private _dataFetched;
  120367. /**
  120368. * Initializes a radial explosioin event
  120369. * @param _scene BabylonJS scene
  120370. * @param _options The options for the vortex event
  120371. */
  120372. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  120373. /**
  120374. * Returns the data related to the radial explosion event (sphere).
  120375. * @returns The radial explosion event data
  120376. */
  120377. getData(): PhysicsRadialExplosionEventData;
  120378. /**
  120379. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  120380. * @param impostor A physics imposter
  120381. * @param origin the origin of the explosion
  120382. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  120383. */
  120384. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  120385. /**
  120386. * Triggers affecterd impostors callbacks
  120387. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  120388. */
  120389. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  120390. /**
  120391. * Disposes the sphere.
  120392. * @param force Specifies if the sphere should be disposed by force
  120393. */
  120394. dispose(force?: boolean): void;
  120395. /*** Helpers ***/
  120396. private _prepareSphere;
  120397. private _intersectsWithSphere;
  120398. }
  120399. /**
  120400. * Represents a gravitational field event
  120401. */
  120402. class PhysicsGravitationalFieldEvent {
  120403. private _physicsHelper;
  120404. private _scene;
  120405. private _origin;
  120406. private _options;
  120407. private _tickCallback;
  120408. private _sphere;
  120409. private _dataFetched;
  120410. /**
  120411. * Initializes the physics gravitational field event
  120412. * @param _physicsHelper A physics helper
  120413. * @param _scene BabylonJS scene
  120414. * @param _origin The origin position of the gravitational field event
  120415. * @param _options The options for the vortex event
  120416. */
  120417. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  120418. /**
  120419. * Returns the data related to the gravitational field event (sphere).
  120420. * @returns A gravitational field event
  120421. */
  120422. getData(): PhysicsGravitationalFieldEventData;
  120423. /**
  120424. * Enables the gravitational field.
  120425. */
  120426. enable(): void;
  120427. /**
  120428. * Disables the gravitational field.
  120429. */
  120430. disable(): void;
  120431. /**
  120432. * Disposes the sphere.
  120433. * @param force The force to dispose from the gravitational field event
  120434. */
  120435. dispose(force?: boolean): void;
  120436. private _tick;
  120437. }
  120438. /**
  120439. * Represents a physics updraft event
  120440. */
  120441. class PhysicsUpdraftEvent {
  120442. private _scene;
  120443. private _origin;
  120444. private _options;
  120445. private _physicsEngine;
  120446. private _originTop;
  120447. private _originDirection;
  120448. private _tickCallback;
  120449. private _cylinder;
  120450. private _cylinderPosition;
  120451. private _dataFetched;
  120452. /**
  120453. * Initializes the physics updraft event
  120454. * @param _scene BabylonJS scene
  120455. * @param _origin The origin position of the updraft
  120456. * @param _options The options for the updraft event
  120457. */
  120458. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  120459. /**
  120460. * Returns the data related to the updraft event (cylinder).
  120461. * @returns A physics updraft event
  120462. */
  120463. getData(): PhysicsUpdraftEventData;
  120464. /**
  120465. * Enables the updraft.
  120466. */
  120467. enable(): void;
  120468. /**
  120469. * Disables the updraft.
  120470. */
  120471. disable(): void;
  120472. /**
  120473. * Disposes the cylinder.
  120474. * @param force Specifies if the updraft should be disposed by force
  120475. */
  120476. dispose(force?: boolean): void;
  120477. private getImpostorHitData;
  120478. private _tick;
  120479. /*** Helpers ***/
  120480. private _prepareCylinder;
  120481. private _intersectsWithCylinder;
  120482. }
  120483. /**
  120484. * Represents a physics vortex event
  120485. */
  120486. class PhysicsVortexEvent {
  120487. private _scene;
  120488. private _origin;
  120489. private _options;
  120490. private _physicsEngine;
  120491. private _originTop;
  120492. private _tickCallback;
  120493. private _cylinder;
  120494. private _cylinderPosition;
  120495. private _dataFetched;
  120496. /**
  120497. * Initializes the physics vortex event
  120498. * @param _scene The BabylonJS scene
  120499. * @param _origin The origin position of the vortex
  120500. * @param _options The options for the vortex event
  120501. */
  120502. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  120503. /**
  120504. * Returns the data related to the vortex event (cylinder).
  120505. * @returns The physics vortex event data
  120506. */
  120507. getData(): PhysicsVortexEventData;
  120508. /**
  120509. * Enables the vortex.
  120510. */
  120511. enable(): void;
  120512. /**
  120513. * Disables the cortex.
  120514. */
  120515. disable(): void;
  120516. /**
  120517. * Disposes the sphere.
  120518. * @param force
  120519. */
  120520. dispose(force?: boolean): void;
  120521. private getImpostorHitData;
  120522. private _tick;
  120523. /*** Helpers ***/
  120524. private _prepareCylinder;
  120525. private _intersectsWithCylinder;
  120526. }
  120527. /**
  120528. * Options fot the radial explosion event
  120529. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120530. */
  120531. export class PhysicsRadialExplosionEventOptions {
  120532. /**
  120533. * The radius of the sphere for the radial explosion.
  120534. */
  120535. radius: number;
  120536. /**
  120537. * The strenth of the explosion.
  120538. */
  120539. strength: number;
  120540. /**
  120541. * The strenght of the force in correspondence to the distance of the affected object
  120542. */
  120543. falloff: PhysicsRadialImpulseFalloff;
  120544. /**
  120545. * Sphere options for the radial explosion.
  120546. */
  120547. sphere: {
  120548. segments: number;
  120549. diameter: number;
  120550. };
  120551. /**
  120552. * Sphere options for the radial explosion.
  120553. */
  120554. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  120555. }
  120556. /**
  120557. * Options fot the updraft event
  120558. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120559. */
  120560. export class PhysicsUpdraftEventOptions {
  120561. /**
  120562. * The radius of the cylinder for the vortex
  120563. */
  120564. radius: number;
  120565. /**
  120566. * The strenth of the updraft.
  120567. */
  120568. strength: number;
  120569. /**
  120570. * The height of the cylinder for the updraft.
  120571. */
  120572. height: number;
  120573. /**
  120574. * The mode for the the updraft.
  120575. */
  120576. updraftMode: PhysicsUpdraftMode;
  120577. }
  120578. /**
  120579. * Options fot the vortex event
  120580. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120581. */
  120582. export class PhysicsVortexEventOptions {
  120583. /**
  120584. * The radius of the cylinder for the vortex
  120585. */
  120586. radius: number;
  120587. /**
  120588. * The strenth of the vortex.
  120589. */
  120590. strength: number;
  120591. /**
  120592. * The height of the cylinder for the vortex.
  120593. */
  120594. height: number;
  120595. /**
  120596. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  120597. */
  120598. centripetalForceThreshold: number;
  120599. /**
  120600. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  120601. */
  120602. centripetalForceMultiplier: number;
  120603. /**
  120604. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  120605. */
  120606. centrifugalForceMultiplier: number;
  120607. /**
  120608. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  120609. */
  120610. updraftForceMultiplier: number;
  120611. }
  120612. /**
  120613. * The strenght of the force in correspondence to the distance of the affected object
  120614. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120615. */
  120616. export enum PhysicsRadialImpulseFalloff {
  120617. /** Defines that impulse is constant in strength across it's whole radius */
  120618. Constant = 0,
  120619. /** Defines that impulse gets weaker if it's further from the origin */
  120620. Linear = 1
  120621. }
  120622. /**
  120623. * The strength of the force in correspondence to the distance of the affected object
  120624. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120625. */
  120626. export enum PhysicsUpdraftMode {
  120627. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  120628. Center = 0,
  120629. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  120630. Perpendicular = 1
  120631. }
  120632. /**
  120633. * Interface for a physics hit data
  120634. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120635. */
  120636. export interface PhysicsHitData {
  120637. /**
  120638. * The force applied at the contact point
  120639. */
  120640. force: Vector3;
  120641. /**
  120642. * The contact point
  120643. */
  120644. contactPoint: Vector3;
  120645. /**
  120646. * The distance from the origin to the contact point
  120647. */
  120648. distanceFromOrigin: number;
  120649. }
  120650. /**
  120651. * Interface for radial explosion event data
  120652. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120653. */
  120654. export interface PhysicsRadialExplosionEventData {
  120655. /**
  120656. * A sphere used for the radial explosion event
  120657. */
  120658. sphere: Mesh;
  120659. }
  120660. /**
  120661. * Interface for gravitational field event data
  120662. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120663. */
  120664. export interface PhysicsGravitationalFieldEventData {
  120665. /**
  120666. * A sphere mesh used for the gravitational field event
  120667. */
  120668. sphere: Mesh;
  120669. }
  120670. /**
  120671. * Interface for updraft event data
  120672. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120673. */
  120674. export interface PhysicsUpdraftEventData {
  120675. /**
  120676. * A cylinder used for the updraft event
  120677. */
  120678. cylinder: Mesh;
  120679. }
  120680. /**
  120681. * Interface for vortex event data
  120682. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120683. */
  120684. export interface PhysicsVortexEventData {
  120685. /**
  120686. * A cylinder used for the vortex event
  120687. */
  120688. cylinder: Mesh;
  120689. }
  120690. /**
  120691. * Interface for an affected physics impostor
  120692. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  120693. */
  120694. export interface PhysicsAffectedImpostorWithData {
  120695. /**
  120696. * The impostor affected by the effect
  120697. */
  120698. impostor: PhysicsImpostor;
  120699. /**
  120700. * The data about the hit/horce from the explosion
  120701. */
  120702. hitData: PhysicsHitData;
  120703. }
  120704. }
  120705. declare module BABYLON {
  120706. /** @hidden */
  120707. export var blackAndWhitePixelShader: {
  120708. name: string;
  120709. shader: string;
  120710. };
  120711. }
  120712. declare module BABYLON {
  120713. /**
  120714. * Post process used to render in black and white
  120715. */
  120716. export class BlackAndWhitePostProcess extends PostProcess {
  120717. /**
  120718. * Linear about to convert he result to black and white (default: 1)
  120719. */
  120720. degree: number;
  120721. /**
  120722. * Creates a black and white post process
  120723. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  120724. * @param name The name of the effect.
  120725. * @param options The required width/height ratio to downsize to before computing the render pass.
  120726. * @param camera The camera to apply the render pass to.
  120727. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  120728. * @param engine The engine which the post process will be applied. (default: current engine)
  120729. * @param reusable If the post process can be reused on the same frame. (default: false)
  120730. */
  120731. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  120732. }
  120733. }
  120734. declare module BABYLON {
  120735. /**
  120736. * This represents a set of one or more post processes in Babylon.
  120737. * A post process can be used to apply a shader to a texture after it is rendered.
  120738. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  120739. */
  120740. export class PostProcessRenderEffect {
  120741. private _postProcesses;
  120742. private _getPostProcesses;
  120743. private _singleInstance;
  120744. private _cameras;
  120745. private _indicesForCamera;
  120746. /**
  120747. * Name of the effect
  120748. * @hidden
  120749. */
  120750. _name: string;
  120751. /**
  120752. * Instantiates a post process render effect.
  120753. * A post process can be used to apply a shader to a texture after it is rendered.
  120754. * @param engine The engine the effect is tied to
  120755. * @param name The name of the effect
  120756. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  120757. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  120758. */
  120759. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  120760. /**
  120761. * Checks if all the post processes in the effect are supported.
  120762. */
  120763. readonly isSupported: boolean;
  120764. /**
  120765. * Updates the current state of the effect
  120766. * @hidden
  120767. */
  120768. _update(): void;
  120769. /**
  120770. * Attaches the effect on cameras
  120771. * @param cameras The camera to attach to.
  120772. * @hidden
  120773. */
  120774. _attachCameras(cameras: Camera): void;
  120775. /**
  120776. * Attaches the effect on cameras
  120777. * @param cameras The camera to attach to.
  120778. * @hidden
  120779. */
  120780. _attachCameras(cameras: Camera[]): void;
  120781. /**
  120782. * Detaches the effect on cameras
  120783. * @param cameras The camera to detatch from.
  120784. * @hidden
  120785. */
  120786. _detachCameras(cameras: Camera): void;
  120787. /**
  120788. * Detatches the effect on cameras
  120789. * @param cameras The camera to detatch from.
  120790. * @hidden
  120791. */
  120792. _detachCameras(cameras: Camera[]): void;
  120793. /**
  120794. * Enables the effect on given cameras
  120795. * @param cameras The camera to enable.
  120796. * @hidden
  120797. */
  120798. _enable(cameras: Camera): void;
  120799. /**
  120800. * Enables the effect on given cameras
  120801. * @param cameras The camera to enable.
  120802. * @hidden
  120803. */
  120804. _enable(cameras: Nullable<Camera[]>): void;
  120805. /**
  120806. * Disables the effect on the given cameras
  120807. * @param cameras The camera to disable.
  120808. * @hidden
  120809. */
  120810. _disable(cameras: Camera): void;
  120811. /**
  120812. * Disables the effect on the given cameras
  120813. * @param cameras The camera to disable.
  120814. * @hidden
  120815. */
  120816. _disable(cameras: Nullable<Camera[]>): void;
  120817. /**
  120818. * Gets a list of the post processes contained in the effect.
  120819. * @param camera The camera to get the post processes on.
  120820. * @returns The list of the post processes in the effect.
  120821. */
  120822. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  120823. }
  120824. }
  120825. declare module BABYLON {
  120826. /** @hidden */
  120827. export var extractHighlightsPixelShader: {
  120828. name: string;
  120829. shader: string;
  120830. };
  120831. }
  120832. declare module BABYLON {
  120833. /**
  120834. * 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.
  120835. */
  120836. export class ExtractHighlightsPostProcess extends PostProcess {
  120837. /**
  120838. * The luminance threshold, pixels below this value will be set to black.
  120839. */
  120840. threshold: number;
  120841. /** @hidden */
  120842. _exposure: number;
  120843. /**
  120844. * Post process which has the input texture to be used when performing highlight extraction
  120845. * @hidden
  120846. */
  120847. _inputPostProcess: Nullable<PostProcess>;
  120848. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  120849. }
  120850. }
  120851. declare module BABYLON {
  120852. /** @hidden */
  120853. export var bloomMergePixelShader: {
  120854. name: string;
  120855. shader: string;
  120856. };
  120857. }
  120858. declare module BABYLON {
  120859. /**
  120860. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  120861. */
  120862. export class BloomMergePostProcess extends PostProcess {
  120863. /** Weight of the bloom to be added to the original input. */
  120864. weight: number;
  120865. /**
  120866. * Creates a new instance of @see BloomMergePostProcess
  120867. * @param name The name of the effect.
  120868. * @param originalFromInput Post process which's input will be used for the merge.
  120869. * @param blurred Blurred highlights post process which's output will be used.
  120870. * @param weight Weight of the bloom to be added to the original input.
  120871. * @param options The required width/height ratio to downsize to before computing the render pass.
  120872. * @param camera The camera to apply the render pass to.
  120873. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  120874. * @param engine The engine which the post process will be applied. (default: current engine)
  120875. * @param reusable If the post process can be reused on the same frame. (default: false)
  120876. * @param textureType Type of textures used when performing the post process. (default: 0)
  120877. * @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)
  120878. */
  120879. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  120880. /** Weight of the bloom to be added to the original input. */
  120881. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  120882. }
  120883. }
  120884. declare module BABYLON {
  120885. /**
  120886. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  120887. */
  120888. export class BloomEffect extends PostProcessRenderEffect {
  120889. private bloomScale;
  120890. /**
  120891. * @hidden Internal
  120892. */
  120893. _effects: Array<PostProcess>;
  120894. /**
  120895. * @hidden Internal
  120896. */
  120897. _downscale: ExtractHighlightsPostProcess;
  120898. private _blurX;
  120899. private _blurY;
  120900. private _merge;
  120901. /**
  120902. * The luminance threshold to find bright areas of the image to bloom.
  120903. */
  120904. threshold: number;
  120905. /**
  120906. * The strength of the bloom.
  120907. */
  120908. weight: number;
  120909. /**
  120910. * Specifies the size of the bloom blur kernel, relative to the final output size
  120911. */
  120912. kernel: number;
  120913. /**
  120914. * Creates a new instance of @see BloomEffect
  120915. * @param scene The scene the effect belongs to.
  120916. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  120917. * @param bloomKernel The size of the kernel to be used when applying the blur.
  120918. * @param bloomWeight The the strength of bloom.
  120919. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  120920. * @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)
  120921. */
  120922. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  120923. /**
  120924. * Disposes each of the internal effects for a given camera.
  120925. * @param camera The camera to dispose the effect on.
  120926. */
  120927. disposeEffects(camera: Camera): void;
  120928. /**
  120929. * @hidden Internal
  120930. */
  120931. _updateEffects(): void;
  120932. /**
  120933. * Internal
  120934. * @returns if all the contained post processes are ready.
  120935. * @hidden
  120936. */
  120937. _isReady(): boolean;
  120938. }
  120939. }
  120940. declare module BABYLON {
  120941. /** @hidden */
  120942. export var chromaticAberrationPixelShader: {
  120943. name: string;
  120944. shader: string;
  120945. };
  120946. }
  120947. declare module BABYLON {
  120948. /**
  120949. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  120950. */
  120951. export class ChromaticAberrationPostProcess extends PostProcess {
  120952. /**
  120953. * The amount of seperation of rgb channels (default: 30)
  120954. */
  120955. aberrationAmount: number;
  120956. /**
  120957. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  120958. */
  120959. radialIntensity: number;
  120960. /**
  120961. * 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))
  120962. */
  120963. direction: Vector2;
  120964. /**
  120965. * 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))
  120966. */
  120967. centerPosition: Vector2;
  120968. /**
  120969. * Creates a new instance ChromaticAberrationPostProcess
  120970. * @param name The name of the effect.
  120971. * @param screenWidth The width of the screen to apply the effect on.
  120972. * @param screenHeight The height of the screen to apply the effect on.
  120973. * @param options The required width/height ratio to downsize to before computing the render pass.
  120974. * @param camera The camera to apply the render pass to.
  120975. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  120976. * @param engine The engine which the post process will be applied. (default: current engine)
  120977. * @param reusable If the post process can be reused on the same frame. (default: false)
  120978. * @param textureType Type of textures used when performing the post process. (default: 0)
  120979. * @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)
  120980. */
  120981. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  120982. }
  120983. }
  120984. declare module BABYLON {
  120985. /** @hidden */
  120986. export var circleOfConfusionPixelShader: {
  120987. name: string;
  120988. shader: string;
  120989. };
  120990. }
  120991. declare module BABYLON {
  120992. /**
  120993. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  120994. */
  120995. export class CircleOfConfusionPostProcess extends PostProcess {
  120996. /**
  120997. * 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.
  120998. */
  120999. lensSize: number;
  121000. /**
  121001. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  121002. */
  121003. fStop: number;
  121004. /**
  121005. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  121006. */
  121007. focusDistance: number;
  121008. /**
  121009. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  121010. */
  121011. focalLength: number;
  121012. private _depthTexture;
  121013. /**
  121014. * Creates a new instance CircleOfConfusionPostProcess
  121015. * @param name The name of the effect.
  121016. * @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.
  121017. * @param options The required width/height ratio to downsize to before computing the render pass.
  121018. * @param camera The camera to apply the render pass to.
  121019. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121020. * @param engine The engine which the post process will be applied. (default: current engine)
  121021. * @param reusable If the post process can be reused on the same frame. (default: false)
  121022. * @param textureType Type of textures used when performing the post process. (default: 0)
  121023. * @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)
  121024. */
  121025. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  121026. /**
  121027. * 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.
  121028. */
  121029. depthTexture: RenderTargetTexture;
  121030. }
  121031. }
  121032. declare module BABYLON {
  121033. /** @hidden */
  121034. export var colorCorrectionPixelShader: {
  121035. name: string;
  121036. shader: string;
  121037. };
  121038. }
  121039. declare module BABYLON {
  121040. /**
  121041. *
  121042. * This post-process allows the modification of rendered colors by using
  121043. * a 'look-up table' (LUT). This effect is also called Color Grading.
  121044. *
  121045. * The object needs to be provided an url to a texture containing the color
  121046. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  121047. * Use an image editing software to tweak the LUT to match your needs.
  121048. *
  121049. * For an example of a color LUT, see here:
  121050. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  121051. * For explanations on color grading, see here:
  121052. * @see http://udn.epicgames.com/Three/ColorGrading.html
  121053. *
  121054. */
  121055. export class ColorCorrectionPostProcess extends PostProcess {
  121056. private _colorTableTexture;
  121057. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  121058. }
  121059. }
  121060. declare module BABYLON {
  121061. /** @hidden */
  121062. export var convolutionPixelShader: {
  121063. name: string;
  121064. shader: string;
  121065. };
  121066. }
  121067. declare module BABYLON {
  121068. /**
  121069. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  121070. * input texture to perform effects such as edge detection or sharpening
  121071. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  121072. */
  121073. export class ConvolutionPostProcess extends PostProcess {
  121074. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  121075. kernel: number[];
  121076. /**
  121077. * Creates a new instance ConvolutionPostProcess
  121078. * @param name The name of the effect.
  121079. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  121080. * @param options The required width/height ratio to downsize to before computing the render pass.
  121081. * @param camera The camera to apply the render pass to.
  121082. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121083. * @param engine The engine which the post process will be applied. (default: current engine)
  121084. * @param reusable If the post process can be reused on the same frame. (default: false)
  121085. * @param textureType Type of textures used when performing the post process. (default: 0)
  121086. */
  121087. constructor(name: string,
  121088. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  121089. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  121090. /**
  121091. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  121092. */
  121093. static EdgeDetect0Kernel: number[];
  121094. /**
  121095. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  121096. */
  121097. static EdgeDetect1Kernel: number[];
  121098. /**
  121099. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  121100. */
  121101. static EdgeDetect2Kernel: number[];
  121102. /**
  121103. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  121104. */
  121105. static SharpenKernel: number[];
  121106. /**
  121107. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  121108. */
  121109. static EmbossKernel: number[];
  121110. /**
  121111. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  121112. */
  121113. static GaussianKernel: number[];
  121114. }
  121115. }
  121116. declare module BABYLON {
  121117. /**
  121118. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  121119. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  121120. * based on samples that have a large difference in distance than the center pixel.
  121121. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  121122. */
  121123. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  121124. direction: Vector2;
  121125. /**
  121126. * Creates a new instance CircleOfConfusionPostProcess
  121127. * @param name The name of the effect.
  121128. * @param scene The scene the effect belongs to.
  121129. * @param direction The direction the blur should be applied.
  121130. * @param kernel The size of the kernel used to blur.
  121131. * @param options The required width/height ratio to downsize to before computing the render pass.
  121132. * @param camera The camera to apply the render pass to.
  121133. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  121134. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  121135. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121136. * @param engine The engine which the post process will be applied. (default: current engine)
  121137. * @param reusable If the post process can be reused on the same frame. (default: false)
  121138. * @param textureType Type of textures used when performing the post process. (default: 0)
  121139. * @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)
  121140. */
  121141. 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);
  121142. }
  121143. }
  121144. declare module BABYLON {
  121145. /** @hidden */
  121146. export var depthOfFieldMergePixelShader: {
  121147. name: string;
  121148. shader: string;
  121149. };
  121150. }
  121151. declare module BABYLON {
  121152. /**
  121153. * Options to be set when merging outputs from the default pipeline.
  121154. */
  121155. export class DepthOfFieldMergePostProcessOptions {
  121156. /**
  121157. * The original image to merge on top of
  121158. */
  121159. originalFromInput: PostProcess;
  121160. /**
  121161. * Parameters to perform the merge of the depth of field effect
  121162. */
  121163. depthOfField?: {
  121164. circleOfConfusion: PostProcess;
  121165. blurSteps: Array<PostProcess>;
  121166. };
  121167. /**
  121168. * Parameters to perform the merge of bloom effect
  121169. */
  121170. bloom?: {
  121171. blurred: PostProcess;
  121172. weight: number;
  121173. };
  121174. }
  121175. /**
  121176. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  121177. */
  121178. export class DepthOfFieldMergePostProcess extends PostProcess {
  121179. private blurSteps;
  121180. /**
  121181. * Creates a new instance of DepthOfFieldMergePostProcess
  121182. * @param name The name of the effect.
  121183. * @param originalFromInput Post process which's input will be used for the merge.
  121184. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  121185. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  121186. * @param options The required width/height ratio to downsize to before computing the render pass.
  121187. * @param camera The camera to apply the render pass to.
  121188. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121189. * @param engine The engine which the post process will be applied. (default: current engine)
  121190. * @param reusable If the post process can be reused on the same frame. (default: false)
  121191. * @param textureType Type of textures used when performing the post process. (default: 0)
  121192. * @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)
  121193. */
  121194. 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);
  121195. /**
  121196. * Updates the effect with the current post process compile time values and recompiles the shader.
  121197. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  121198. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  121199. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  121200. * @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
  121201. * @param onCompiled Called when the shader has been compiled.
  121202. * @param onError Called if there is an error when compiling a shader.
  121203. */
  121204. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  121205. }
  121206. }
  121207. declare module BABYLON {
  121208. /**
  121209. * Specifies the level of max blur that should be applied when using the depth of field effect
  121210. */
  121211. export enum DepthOfFieldEffectBlurLevel {
  121212. /**
  121213. * Subtle blur
  121214. */
  121215. Low = 0,
  121216. /**
  121217. * Medium blur
  121218. */
  121219. Medium = 1,
  121220. /**
  121221. * Large blur
  121222. */
  121223. High = 2
  121224. }
  121225. /**
  121226. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  121227. */
  121228. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  121229. private _circleOfConfusion;
  121230. /**
  121231. * @hidden Internal, blurs from high to low
  121232. */
  121233. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  121234. private _depthOfFieldBlurY;
  121235. private _dofMerge;
  121236. /**
  121237. * @hidden Internal post processes in depth of field effect
  121238. */
  121239. _effects: Array<PostProcess>;
  121240. /**
  121241. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  121242. */
  121243. focalLength: number;
  121244. /**
  121245. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  121246. */
  121247. fStop: number;
  121248. /**
  121249. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  121250. */
  121251. focusDistance: number;
  121252. /**
  121253. * 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.
  121254. */
  121255. lensSize: number;
  121256. /**
  121257. * Creates a new instance DepthOfFieldEffect
  121258. * @param scene The scene the effect belongs to.
  121259. * @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.
  121260. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  121261. * @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)
  121262. */
  121263. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  121264. /**
  121265. * Get the current class name of the current effet
  121266. * @returns "DepthOfFieldEffect"
  121267. */
  121268. getClassName(): string;
  121269. /**
  121270. * 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.
  121271. */
  121272. depthTexture: RenderTargetTexture;
  121273. /**
  121274. * Disposes each of the internal effects for a given camera.
  121275. * @param camera The camera to dispose the effect on.
  121276. */
  121277. disposeEffects(camera: Camera): void;
  121278. /**
  121279. * @hidden Internal
  121280. */
  121281. _updateEffects(): void;
  121282. /**
  121283. * Internal
  121284. * @returns if all the contained post processes are ready.
  121285. * @hidden
  121286. */
  121287. _isReady(): boolean;
  121288. }
  121289. }
  121290. declare module BABYLON {
  121291. /** @hidden */
  121292. export var displayPassPixelShader: {
  121293. name: string;
  121294. shader: string;
  121295. };
  121296. }
  121297. declare module BABYLON {
  121298. /**
  121299. * DisplayPassPostProcess which produces an output the same as it's input
  121300. */
  121301. export class DisplayPassPostProcess extends PostProcess {
  121302. /**
  121303. * Creates the DisplayPassPostProcess
  121304. * @param name The name of the effect.
  121305. * @param options The required width/height ratio to downsize to before computing the render pass.
  121306. * @param camera The camera to apply the render pass to.
  121307. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121308. * @param engine The engine which the post process will be applied. (default: current engine)
  121309. * @param reusable If the post process can be reused on the same frame. (default: false)
  121310. */
  121311. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  121312. }
  121313. }
  121314. declare module BABYLON {
  121315. /** @hidden */
  121316. export var filterPixelShader: {
  121317. name: string;
  121318. shader: string;
  121319. };
  121320. }
  121321. declare module BABYLON {
  121322. /**
  121323. * Applies a kernel filter to the image
  121324. */
  121325. export class FilterPostProcess extends PostProcess {
  121326. /** The matrix to be applied to the image */
  121327. kernelMatrix: Matrix;
  121328. /**
  121329. *
  121330. * @param name The name of the effect.
  121331. * @param kernelMatrix The matrix to be applied to the image
  121332. * @param options The required width/height ratio to downsize to before computing the render pass.
  121333. * @param camera The camera to apply the render pass to.
  121334. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121335. * @param engine The engine which the post process will be applied. (default: current engine)
  121336. * @param reusable If the post process can be reused on the same frame. (default: false)
  121337. */
  121338. constructor(name: string,
  121339. /** The matrix to be applied to the image */
  121340. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  121341. }
  121342. }
  121343. declare module BABYLON {
  121344. /** @hidden */
  121345. export var fxaaPixelShader: {
  121346. name: string;
  121347. shader: string;
  121348. };
  121349. }
  121350. declare module BABYLON {
  121351. /** @hidden */
  121352. export var fxaaVertexShader: {
  121353. name: string;
  121354. shader: string;
  121355. };
  121356. }
  121357. declare module BABYLON {
  121358. /**
  121359. * Fxaa post process
  121360. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  121361. */
  121362. export class FxaaPostProcess extends PostProcess {
  121363. /** @hidden */
  121364. texelWidth: number;
  121365. /** @hidden */
  121366. texelHeight: number;
  121367. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  121368. private _getDefines;
  121369. }
  121370. }
  121371. declare module BABYLON {
  121372. /** @hidden */
  121373. export var grainPixelShader: {
  121374. name: string;
  121375. shader: string;
  121376. };
  121377. }
  121378. declare module BABYLON {
  121379. /**
  121380. * The GrainPostProcess adds noise to the image at mid luminance levels
  121381. */
  121382. export class GrainPostProcess extends PostProcess {
  121383. /**
  121384. * The intensity of the grain added (default: 30)
  121385. */
  121386. intensity: number;
  121387. /**
  121388. * If the grain should be randomized on every frame
  121389. */
  121390. animated: boolean;
  121391. /**
  121392. * Creates a new instance of @see GrainPostProcess
  121393. * @param name The name of the effect.
  121394. * @param options The required width/height ratio to downsize to before computing the render pass.
  121395. * @param camera The camera to apply the render pass to.
  121396. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121397. * @param engine The engine which the post process will be applied. (default: current engine)
  121398. * @param reusable If the post process can be reused on the same frame. (default: false)
  121399. * @param textureType Type of textures used when performing the post process. (default: 0)
  121400. * @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)
  121401. */
  121402. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  121403. }
  121404. }
  121405. declare module BABYLON {
  121406. /** @hidden */
  121407. export var highlightsPixelShader: {
  121408. name: string;
  121409. shader: string;
  121410. };
  121411. }
  121412. declare module BABYLON {
  121413. /**
  121414. * Extracts highlights from the image
  121415. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  121416. */
  121417. export class HighlightsPostProcess extends PostProcess {
  121418. /**
  121419. * Extracts highlights from the image
  121420. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  121421. * @param name The name of the effect.
  121422. * @param options The required width/height ratio to downsize to before computing the render pass.
  121423. * @param camera The camera to apply the render pass to.
  121424. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121425. * @param engine The engine which the post process will be applied. (default: current engine)
  121426. * @param reusable If the post process can be reused on the same frame. (default: false)
  121427. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  121428. */
  121429. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  121430. }
  121431. }
  121432. declare module BABYLON {
  121433. /** @hidden */
  121434. export var mrtFragmentDeclaration: {
  121435. name: string;
  121436. shader: string;
  121437. };
  121438. }
  121439. declare module BABYLON {
  121440. /** @hidden */
  121441. export var geometryPixelShader: {
  121442. name: string;
  121443. shader: string;
  121444. };
  121445. }
  121446. declare module BABYLON {
  121447. /** @hidden */
  121448. export var geometryVertexShader: {
  121449. name: string;
  121450. shader: string;
  121451. };
  121452. }
  121453. declare module BABYLON {
  121454. /** @hidden */
  121455. interface ISavedTransformationMatrix {
  121456. world: Matrix;
  121457. viewProjection: Matrix;
  121458. }
  121459. /**
  121460. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  121461. */
  121462. export class GeometryBufferRenderer {
  121463. /**
  121464. * Constant used to retrieve the position texture index in the G-Buffer textures array
  121465. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  121466. */
  121467. static readonly POSITION_TEXTURE_TYPE: number;
  121468. /**
  121469. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  121470. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  121471. */
  121472. static readonly VELOCITY_TEXTURE_TYPE: number;
  121473. /**
  121474. * Dictionary used to store the previous transformation matrices of each rendered mesh
  121475. * in order to compute objects velocities when enableVelocity is set to "true"
  121476. * @hidden
  121477. */
  121478. _previousTransformationMatrices: {
  121479. [index: number]: ISavedTransformationMatrix;
  121480. };
  121481. /**
  121482. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  121483. * in order to compute objects velocities when enableVelocity is set to "true"
  121484. * @hidden
  121485. */
  121486. _previousBonesTransformationMatrices: {
  121487. [index: number]: Float32Array;
  121488. };
  121489. /**
  121490. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  121491. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  121492. */
  121493. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  121494. private _scene;
  121495. private _multiRenderTarget;
  121496. private _ratio;
  121497. private _enablePosition;
  121498. private _enableVelocity;
  121499. private _positionIndex;
  121500. private _velocityIndex;
  121501. protected _effect: Effect;
  121502. protected _cachedDefines: string;
  121503. /**
  121504. * Set the render list (meshes to be rendered) used in the G buffer.
  121505. */
  121506. renderList: Mesh[];
  121507. /**
  121508. * Gets wether or not G buffer are supported by the running hardware.
  121509. * This requires draw buffer supports
  121510. */
  121511. readonly isSupported: boolean;
  121512. /**
  121513. * Returns the index of the given texture type in the G-Buffer textures array
  121514. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  121515. * @returns the index of the given texture type in the G-Buffer textures array
  121516. */
  121517. getTextureIndex(textureType: number): number;
  121518. /**
  121519. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  121520. */
  121521. /**
  121522. * Sets whether or not objects positions are enabled for the G buffer.
  121523. */
  121524. enablePosition: boolean;
  121525. /**
  121526. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  121527. */
  121528. /**
  121529. * Sets wether or not objects velocities are enabled for the G buffer.
  121530. */
  121531. enableVelocity: boolean;
  121532. /**
  121533. * Gets the scene associated with the buffer.
  121534. */
  121535. readonly scene: Scene;
  121536. /**
  121537. * Gets the ratio used by the buffer during its creation.
  121538. * How big is the buffer related to the main canvas.
  121539. */
  121540. readonly ratio: number;
  121541. /** @hidden */
  121542. static _SceneComponentInitialization: (scene: Scene) => void;
  121543. /**
  121544. * Creates a new G Buffer for the scene
  121545. * @param scene The scene the buffer belongs to
  121546. * @param ratio How big is the buffer related to the main canvas.
  121547. */
  121548. constructor(scene: Scene, ratio?: number);
  121549. /**
  121550. * Checks wether everything is ready to render a submesh to the G buffer.
  121551. * @param subMesh the submesh to check readiness for
  121552. * @param useInstances is the mesh drawn using instance or not
  121553. * @returns true if ready otherwise false
  121554. */
  121555. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  121556. /**
  121557. * Gets the current underlying G Buffer.
  121558. * @returns the buffer
  121559. */
  121560. getGBuffer(): MultiRenderTarget;
  121561. /**
  121562. * Gets the number of samples used to render the buffer (anti aliasing).
  121563. */
  121564. /**
  121565. * Sets the number of samples used to render the buffer (anti aliasing).
  121566. */
  121567. samples: number;
  121568. /**
  121569. * Disposes the renderer and frees up associated resources.
  121570. */
  121571. dispose(): void;
  121572. protected _createRenderTargets(): void;
  121573. private _copyBonesTransformationMatrices;
  121574. }
  121575. }
  121576. declare module BABYLON {
  121577. interface Scene {
  121578. /** @hidden (Backing field) */
  121579. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  121580. /**
  121581. * Gets or Sets the current geometry buffer associated to the scene.
  121582. */
  121583. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  121584. /**
  121585. * Enables a GeometryBufferRender and associates it with the scene
  121586. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  121587. * @returns the GeometryBufferRenderer
  121588. */
  121589. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  121590. /**
  121591. * Disables the GeometryBufferRender associated with the scene
  121592. */
  121593. disableGeometryBufferRenderer(): void;
  121594. }
  121595. /**
  121596. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  121597. * in several rendering techniques.
  121598. */
  121599. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  121600. /**
  121601. * The component name helpful to identify the component in the list of scene components.
  121602. */
  121603. readonly name: string;
  121604. /**
  121605. * The scene the component belongs to.
  121606. */
  121607. scene: Scene;
  121608. /**
  121609. * Creates a new instance of the component for the given scene
  121610. * @param scene Defines the scene to register the component in
  121611. */
  121612. constructor(scene: Scene);
  121613. /**
  121614. * Registers the component in a given scene
  121615. */
  121616. register(): void;
  121617. /**
  121618. * Rebuilds the elements related to this component in case of
  121619. * context lost for instance.
  121620. */
  121621. rebuild(): void;
  121622. /**
  121623. * Disposes the component and the associated ressources
  121624. */
  121625. dispose(): void;
  121626. private _gatherRenderTargets;
  121627. }
  121628. }
  121629. declare module BABYLON {
  121630. /** @hidden */
  121631. export var motionBlurPixelShader: {
  121632. name: string;
  121633. shader: string;
  121634. };
  121635. }
  121636. declare module BABYLON {
  121637. /**
  121638. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  121639. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  121640. * As an example, all you have to do is to create the post-process:
  121641. * var mb = new BABYLON.MotionBlurPostProcess(
  121642. * 'mb', // The name of the effect.
  121643. * scene, // The scene containing the objects to blur according to their velocity.
  121644. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  121645. * camera // The camera to apply the render pass to.
  121646. * );
  121647. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  121648. */
  121649. export class MotionBlurPostProcess extends PostProcess {
  121650. /**
  121651. * Defines how much the image is blurred by the movement. Default value is equal to 1
  121652. */
  121653. motionStrength: number;
  121654. /**
  121655. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  121656. */
  121657. /**
  121658. * Sets the number of iterations to be used for motion blur quality
  121659. */
  121660. motionBlurSamples: number;
  121661. private _motionBlurSamples;
  121662. private _geometryBufferRenderer;
  121663. /**
  121664. * Creates a new instance MotionBlurPostProcess
  121665. * @param name The name of the effect.
  121666. * @param scene The scene containing the objects to blur according to their velocity.
  121667. * @param options The required width/height ratio to downsize to before computing the render pass.
  121668. * @param camera The camera to apply the render pass to.
  121669. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121670. * @param engine The engine which the post process will be applied. (default: current engine)
  121671. * @param reusable If the post process can be reused on the same frame. (default: false)
  121672. * @param textureType Type of textures used when performing the post process. (default: 0)
  121673. * @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)
  121674. */
  121675. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  121676. /**
  121677. * Excludes the given skinned mesh from computing bones velocities.
  121678. * 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.
  121679. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  121680. */
  121681. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  121682. /**
  121683. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  121684. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  121685. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  121686. */
  121687. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  121688. /**
  121689. * Disposes the post process.
  121690. * @param camera The camera to dispose the post process on.
  121691. */
  121692. dispose(camera?: Camera): void;
  121693. }
  121694. }
  121695. declare module BABYLON {
  121696. /** @hidden */
  121697. export var refractionPixelShader: {
  121698. name: string;
  121699. shader: string;
  121700. };
  121701. }
  121702. declare module BABYLON {
  121703. /**
  121704. * Post process which applies a refractin texture
  121705. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  121706. */
  121707. export class RefractionPostProcess extends PostProcess {
  121708. /** the base color of the refraction (used to taint the rendering) */
  121709. color: Color3;
  121710. /** simulated refraction depth */
  121711. depth: number;
  121712. /** the coefficient of the base color (0 to remove base color tainting) */
  121713. colorLevel: number;
  121714. private _refTexture;
  121715. private _ownRefractionTexture;
  121716. /**
  121717. * Gets or sets the refraction texture
  121718. * Please note that you are responsible for disposing the texture if you set it manually
  121719. */
  121720. refractionTexture: Texture;
  121721. /**
  121722. * Initializes the RefractionPostProcess
  121723. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  121724. * @param name The name of the effect.
  121725. * @param refractionTextureUrl Url of the refraction texture to use
  121726. * @param color the base color of the refraction (used to taint the rendering)
  121727. * @param depth simulated refraction depth
  121728. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  121729. * @param camera The camera to apply the render pass to.
  121730. * @param options The required width/height ratio to downsize to before computing the render pass.
  121731. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121732. * @param engine The engine which the post process will be applied. (default: current engine)
  121733. * @param reusable If the post process can be reused on the same frame. (default: false)
  121734. */
  121735. constructor(name: string, refractionTextureUrl: string,
  121736. /** the base color of the refraction (used to taint the rendering) */
  121737. color: Color3,
  121738. /** simulated refraction depth */
  121739. depth: number,
  121740. /** the coefficient of the base color (0 to remove base color tainting) */
  121741. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  121742. /**
  121743. * Disposes of the post process
  121744. * @param camera Camera to dispose post process on
  121745. */
  121746. dispose(camera: Camera): void;
  121747. }
  121748. }
  121749. declare module BABYLON {
  121750. /** @hidden */
  121751. export var sharpenPixelShader: {
  121752. name: string;
  121753. shader: string;
  121754. };
  121755. }
  121756. declare module BABYLON {
  121757. /**
  121758. * The SharpenPostProcess applies a sharpen kernel to every pixel
  121759. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  121760. */
  121761. export class SharpenPostProcess extends PostProcess {
  121762. /**
  121763. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  121764. */
  121765. colorAmount: number;
  121766. /**
  121767. * How much sharpness should be applied (default: 0.3)
  121768. */
  121769. edgeAmount: number;
  121770. /**
  121771. * Creates a new instance ConvolutionPostProcess
  121772. * @param name The name of the effect.
  121773. * @param options The required width/height ratio to downsize to before computing the render pass.
  121774. * @param camera The camera to apply the render pass to.
  121775. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  121776. * @param engine The engine which the post process will be applied. (default: current engine)
  121777. * @param reusable If the post process can be reused on the same frame. (default: false)
  121778. * @param textureType Type of textures used when performing the post process. (default: 0)
  121779. * @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)
  121780. */
  121781. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  121782. }
  121783. }
  121784. declare module BABYLON {
  121785. /**
  121786. * PostProcessRenderPipeline
  121787. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  121788. */
  121789. export class PostProcessRenderPipeline {
  121790. private engine;
  121791. private _renderEffects;
  121792. private _renderEffectsForIsolatedPass;
  121793. /**
  121794. * List of inspectable custom properties (used by the Inspector)
  121795. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  121796. */
  121797. inspectableCustomProperties: IInspectable[];
  121798. /**
  121799. * @hidden
  121800. */
  121801. protected _cameras: Camera[];
  121802. /** @hidden */
  121803. _name: string;
  121804. /**
  121805. * Gets pipeline name
  121806. */
  121807. readonly name: string;
  121808. /**
  121809. * Initializes a PostProcessRenderPipeline
  121810. * @param engine engine to add the pipeline to
  121811. * @param name name of the pipeline
  121812. */
  121813. constructor(engine: Engine, name: string);
  121814. /**
  121815. * Gets the class name
  121816. * @returns "PostProcessRenderPipeline"
  121817. */
  121818. getClassName(): string;
  121819. /**
  121820. * If all the render effects in the pipeline are supported
  121821. */
  121822. readonly isSupported: boolean;
  121823. /**
  121824. * Adds an effect to the pipeline
  121825. * @param renderEffect the effect to add
  121826. */
  121827. addEffect(renderEffect: PostProcessRenderEffect): void;
  121828. /** @hidden */
  121829. _rebuild(): void;
  121830. /** @hidden */
  121831. _enableEffect(renderEffectName: string, cameras: Camera): void;
  121832. /** @hidden */
  121833. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  121834. /** @hidden */
  121835. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  121836. /** @hidden */
  121837. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  121838. /** @hidden */
  121839. _attachCameras(cameras: Camera, unique: boolean): void;
  121840. /** @hidden */
  121841. _attachCameras(cameras: Camera[], unique: boolean): void;
  121842. /** @hidden */
  121843. _detachCameras(cameras: Camera): void;
  121844. /** @hidden */
  121845. _detachCameras(cameras: Nullable<Camera[]>): void;
  121846. /** @hidden */
  121847. _update(): void;
  121848. /** @hidden */
  121849. _reset(): void;
  121850. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  121851. /**
  121852. * Disposes of the pipeline
  121853. */
  121854. dispose(): void;
  121855. }
  121856. }
  121857. declare module BABYLON {
  121858. /**
  121859. * PostProcessRenderPipelineManager class
  121860. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  121861. */
  121862. export class PostProcessRenderPipelineManager {
  121863. private _renderPipelines;
  121864. /**
  121865. * Initializes a PostProcessRenderPipelineManager
  121866. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  121867. */
  121868. constructor();
  121869. /**
  121870. * Gets the list of supported render pipelines
  121871. */
  121872. readonly supportedPipelines: PostProcessRenderPipeline[];
  121873. /**
  121874. * Adds a pipeline to the manager
  121875. * @param renderPipeline The pipeline to add
  121876. */
  121877. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  121878. /**
  121879. * Attaches a camera to the pipeline
  121880. * @param renderPipelineName The name of the pipeline to attach to
  121881. * @param cameras the camera to attach
  121882. * @param unique if the camera can be attached multiple times to the pipeline
  121883. */
  121884. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  121885. /**
  121886. * Detaches a camera from the pipeline
  121887. * @param renderPipelineName The name of the pipeline to detach from
  121888. * @param cameras the camera to detach
  121889. */
  121890. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  121891. /**
  121892. * Enables an effect by name on a pipeline
  121893. * @param renderPipelineName the name of the pipeline to enable the effect in
  121894. * @param renderEffectName the name of the effect to enable
  121895. * @param cameras the cameras that the effect should be enabled on
  121896. */
  121897. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  121898. /**
  121899. * Disables an effect by name on a pipeline
  121900. * @param renderPipelineName the name of the pipeline to disable the effect in
  121901. * @param renderEffectName the name of the effect to disable
  121902. * @param cameras the cameras that the effect should be disabled on
  121903. */
  121904. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  121905. /**
  121906. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  121907. */
  121908. update(): void;
  121909. /** @hidden */
  121910. _rebuild(): void;
  121911. /**
  121912. * Disposes of the manager and pipelines
  121913. */
  121914. dispose(): void;
  121915. }
  121916. }
  121917. declare module BABYLON {
  121918. interface Scene {
  121919. /** @hidden (Backing field) */
  121920. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  121921. /**
  121922. * Gets the postprocess render pipeline manager
  121923. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  121924. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  121925. */
  121926. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  121927. }
  121928. /**
  121929. * Defines the Render Pipeline scene component responsible to rendering pipelines
  121930. */
  121931. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  121932. /**
  121933. * The component name helpfull to identify the component in the list of scene components.
  121934. */
  121935. readonly name: string;
  121936. /**
  121937. * The scene the component belongs to.
  121938. */
  121939. scene: Scene;
  121940. /**
  121941. * Creates a new instance of the component for the given scene
  121942. * @param scene Defines the scene to register the component in
  121943. */
  121944. constructor(scene: Scene);
  121945. /**
  121946. * Registers the component in a given scene
  121947. */
  121948. register(): void;
  121949. /**
  121950. * Rebuilds the elements related to this component in case of
  121951. * context lost for instance.
  121952. */
  121953. rebuild(): void;
  121954. /**
  121955. * Disposes the component and the associated ressources
  121956. */
  121957. dispose(): void;
  121958. private _gatherRenderTargets;
  121959. }
  121960. }
  121961. declare module BABYLON {
  121962. /**
  121963. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  121964. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  121965. */
  121966. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  121967. private _scene;
  121968. private _camerasToBeAttached;
  121969. /**
  121970. * ID of the sharpen post process,
  121971. */
  121972. private readonly SharpenPostProcessId;
  121973. /**
  121974. * @ignore
  121975. * ID of the image processing post process;
  121976. */
  121977. readonly ImageProcessingPostProcessId: string;
  121978. /**
  121979. * @ignore
  121980. * ID of the Fast Approximate Anti-Aliasing post process;
  121981. */
  121982. readonly FxaaPostProcessId: string;
  121983. /**
  121984. * ID of the chromatic aberration post process,
  121985. */
  121986. private readonly ChromaticAberrationPostProcessId;
  121987. /**
  121988. * ID of the grain post process
  121989. */
  121990. private readonly GrainPostProcessId;
  121991. /**
  121992. * Sharpen post process which will apply a sharpen convolution to enhance edges
  121993. */
  121994. sharpen: SharpenPostProcess;
  121995. private _sharpenEffect;
  121996. private bloom;
  121997. /**
  121998. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  121999. */
  122000. depthOfField: DepthOfFieldEffect;
  122001. /**
  122002. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  122003. */
  122004. fxaa: FxaaPostProcess;
  122005. /**
  122006. * Image post processing pass used to perform operations such as tone mapping or color grading.
  122007. */
  122008. imageProcessing: ImageProcessingPostProcess;
  122009. /**
  122010. * Chromatic aberration post process which will shift rgb colors in the image
  122011. */
  122012. chromaticAberration: ChromaticAberrationPostProcess;
  122013. private _chromaticAberrationEffect;
  122014. /**
  122015. * Grain post process which add noise to the image
  122016. */
  122017. grain: GrainPostProcess;
  122018. private _grainEffect;
  122019. /**
  122020. * Glow post process which adds a glow to emissive areas of the image
  122021. */
  122022. private _glowLayer;
  122023. /**
  122024. * Animations which can be used to tweak settings over a period of time
  122025. */
  122026. animations: Animation[];
  122027. private _imageProcessingConfigurationObserver;
  122028. private _sharpenEnabled;
  122029. private _bloomEnabled;
  122030. private _depthOfFieldEnabled;
  122031. private _depthOfFieldBlurLevel;
  122032. private _fxaaEnabled;
  122033. private _imageProcessingEnabled;
  122034. private _defaultPipelineTextureType;
  122035. private _bloomScale;
  122036. private _chromaticAberrationEnabled;
  122037. private _grainEnabled;
  122038. private _buildAllowed;
  122039. /**
  122040. * Gets active scene
  122041. */
  122042. readonly scene: Scene;
  122043. /**
  122044. * Enable or disable the sharpen process from the pipeline
  122045. */
  122046. sharpenEnabled: boolean;
  122047. private _resizeObserver;
  122048. private _hardwareScaleLevel;
  122049. private _bloomKernel;
  122050. /**
  122051. * Specifies the size of the bloom blur kernel, relative to the final output size
  122052. */
  122053. bloomKernel: number;
  122054. /**
  122055. * Specifies the weight of the bloom in the final rendering
  122056. */
  122057. private _bloomWeight;
  122058. /**
  122059. * Specifies the luma threshold for the area that will be blurred by the bloom
  122060. */
  122061. private _bloomThreshold;
  122062. private _hdr;
  122063. /**
  122064. * The strength of the bloom.
  122065. */
  122066. bloomWeight: number;
  122067. /**
  122068. * The strength of the bloom.
  122069. */
  122070. bloomThreshold: number;
  122071. /**
  122072. * The scale of the bloom, lower value will provide better performance.
  122073. */
  122074. bloomScale: number;
  122075. /**
  122076. * Enable or disable the bloom from the pipeline
  122077. */
  122078. bloomEnabled: boolean;
  122079. private _rebuildBloom;
  122080. /**
  122081. * If the depth of field is enabled.
  122082. */
  122083. depthOfFieldEnabled: boolean;
  122084. /**
  122085. * Blur level of the depth of field effect. (Higher blur will effect performance)
  122086. */
  122087. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  122088. /**
  122089. * If the anti aliasing is enabled.
  122090. */
  122091. fxaaEnabled: boolean;
  122092. private _samples;
  122093. /**
  122094. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  122095. */
  122096. samples: number;
  122097. /**
  122098. * If image processing is enabled.
  122099. */
  122100. imageProcessingEnabled: boolean;
  122101. /**
  122102. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  122103. */
  122104. glowLayerEnabled: boolean;
  122105. /**
  122106. * Gets the glow layer (or null if not defined)
  122107. */
  122108. readonly glowLayer: Nullable<GlowLayer>;
  122109. /**
  122110. * Enable or disable the chromaticAberration process from the pipeline
  122111. */
  122112. chromaticAberrationEnabled: boolean;
  122113. /**
  122114. * Enable or disable the grain process from the pipeline
  122115. */
  122116. grainEnabled: boolean;
  122117. /**
  122118. * @constructor
  122119. * @param name - The rendering pipeline name (default: "")
  122120. * @param hdr - If high dynamic range textures should be used (default: true)
  122121. * @param scene - The scene linked to this pipeline (default: the last created scene)
  122122. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  122123. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  122124. */
  122125. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  122126. /**
  122127. * Get the class name
  122128. * @returns "DefaultRenderingPipeline"
  122129. */
  122130. getClassName(): string;
  122131. /**
  122132. * Force the compilation of the entire pipeline.
  122133. */
  122134. prepare(): void;
  122135. private _hasCleared;
  122136. private _prevPostProcess;
  122137. private _prevPrevPostProcess;
  122138. private _setAutoClearAndTextureSharing;
  122139. private _depthOfFieldSceneObserver;
  122140. private _buildPipeline;
  122141. private _disposePostProcesses;
  122142. /**
  122143. * Adds a camera to the pipeline
  122144. * @param camera the camera to be added
  122145. */
  122146. addCamera(camera: Camera): void;
  122147. /**
  122148. * Removes a camera from the pipeline
  122149. * @param camera the camera to remove
  122150. */
  122151. removeCamera(camera: Camera): void;
  122152. /**
  122153. * Dispose of the pipeline and stop all post processes
  122154. */
  122155. dispose(): void;
  122156. /**
  122157. * Serialize the rendering pipeline (Used when exporting)
  122158. * @returns the serialized object
  122159. */
  122160. serialize(): any;
  122161. /**
  122162. * Parse the serialized pipeline
  122163. * @param source Source pipeline.
  122164. * @param scene The scene to load the pipeline to.
  122165. * @param rootUrl The URL of the serialized pipeline.
  122166. * @returns An instantiated pipeline from the serialized object.
  122167. */
  122168. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  122169. }
  122170. }
  122171. declare module BABYLON {
  122172. /** @hidden */
  122173. export var lensHighlightsPixelShader: {
  122174. name: string;
  122175. shader: string;
  122176. };
  122177. }
  122178. declare module BABYLON {
  122179. /** @hidden */
  122180. export var depthOfFieldPixelShader: {
  122181. name: string;
  122182. shader: string;
  122183. };
  122184. }
  122185. declare module BABYLON {
  122186. /**
  122187. * BABYLON.JS Chromatic Aberration GLSL Shader
  122188. * Author: Olivier Guyot
  122189. * Separates very slightly R, G and B colors on the edges of the screen
  122190. * Inspired by Francois Tarlier & Martins Upitis
  122191. */
  122192. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  122193. /**
  122194. * @ignore
  122195. * The chromatic aberration PostProcess id in the pipeline
  122196. */
  122197. LensChromaticAberrationEffect: string;
  122198. /**
  122199. * @ignore
  122200. * The highlights enhancing PostProcess id in the pipeline
  122201. */
  122202. HighlightsEnhancingEffect: string;
  122203. /**
  122204. * @ignore
  122205. * The depth-of-field PostProcess id in the pipeline
  122206. */
  122207. LensDepthOfFieldEffect: string;
  122208. private _scene;
  122209. private _depthTexture;
  122210. private _grainTexture;
  122211. private _chromaticAberrationPostProcess;
  122212. private _highlightsPostProcess;
  122213. private _depthOfFieldPostProcess;
  122214. private _edgeBlur;
  122215. private _grainAmount;
  122216. private _chromaticAberration;
  122217. private _distortion;
  122218. private _highlightsGain;
  122219. private _highlightsThreshold;
  122220. private _dofDistance;
  122221. private _dofAperture;
  122222. private _dofDarken;
  122223. private _dofPentagon;
  122224. private _blurNoise;
  122225. /**
  122226. * @constructor
  122227. *
  122228. * Effect parameters are as follow:
  122229. * {
  122230. * chromatic_aberration: number; // from 0 to x (1 for realism)
  122231. * edge_blur: number; // from 0 to x (1 for realism)
  122232. * distortion: number; // from 0 to x (1 for realism)
  122233. * grain_amount: number; // from 0 to 1
  122234. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  122235. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  122236. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  122237. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  122238. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  122239. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  122240. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  122241. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  122242. * }
  122243. * Note: if an effect parameter is unset, effect is disabled
  122244. *
  122245. * @param name The rendering pipeline name
  122246. * @param parameters - An object containing all parameters (see above)
  122247. * @param scene The scene linked to this pipeline
  122248. * @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)
  122249. * @param cameras The array of cameras that the rendering pipeline will be attached to
  122250. */
  122251. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  122252. /**
  122253. * Get the class name
  122254. * @returns "LensRenderingPipeline"
  122255. */
  122256. getClassName(): string;
  122257. /**
  122258. * Gets associated scene
  122259. */
  122260. readonly scene: Scene;
  122261. /**
  122262. * Gets or sets the edge blur
  122263. */
  122264. edgeBlur: number;
  122265. /**
  122266. * Gets or sets the grain amount
  122267. */
  122268. grainAmount: number;
  122269. /**
  122270. * Gets or sets the chromatic aberration amount
  122271. */
  122272. chromaticAberration: number;
  122273. /**
  122274. * Gets or sets the depth of field aperture
  122275. */
  122276. dofAperture: number;
  122277. /**
  122278. * Gets or sets the edge distortion
  122279. */
  122280. edgeDistortion: number;
  122281. /**
  122282. * Gets or sets the depth of field distortion
  122283. */
  122284. dofDistortion: number;
  122285. /**
  122286. * Gets or sets the darken out of focus amount
  122287. */
  122288. darkenOutOfFocus: number;
  122289. /**
  122290. * Gets or sets a boolean indicating if blur noise is enabled
  122291. */
  122292. blurNoise: boolean;
  122293. /**
  122294. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  122295. */
  122296. pentagonBokeh: boolean;
  122297. /**
  122298. * Gets or sets the highlight grain amount
  122299. */
  122300. highlightsGain: number;
  122301. /**
  122302. * Gets or sets the highlight threshold
  122303. */
  122304. highlightsThreshold: number;
  122305. /**
  122306. * Sets the amount of blur at the edges
  122307. * @param amount blur amount
  122308. */
  122309. setEdgeBlur(amount: number): void;
  122310. /**
  122311. * Sets edge blur to 0
  122312. */
  122313. disableEdgeBlur(): void;
  122314. /**
  122315. * Sets the amout of grain
  122316. * @param amount Amount of grain
  122317. */
  122318. setGrainAmount(amount: number): void;
  122319. /**
  122320. * Set grain amount to 0
  122321. */
  122322. disableGrain(): void;
  122323. /**
  122324. * Sets the chromatic aberration amount
  122325. * @param amount amount of chromatic aberration
  122326. */
  122327. setChromaticAberration(amount: number): void;
  122328. /**
  122329. * Sets chromatic aberration amount to 0
  122330. */
  122331. disableChromaticAberration(): void;
  122332. /**
  122333. * Sets the EdgeDistortion amount
  122334. * @param amount amount of EdgeDistortion
  122335. */
  122336. setEdgeDistortion(amount: number): void;
  122337. /**
  122338. * Sets edge distortion to 0
  122339. */
  122340. disableEdgeDistortion(): void;
  122341. /**
  122342. * Sets the FocusDistance amount
  122343. * @param amount amount of FocusDistance
  122344. */
  122345. setFocusDistance(amount: number): void;
  122346. /**
  122347. * Disables depth of field
  122348. */
  122349. disableDepthOfField(): void;
  122350. /**
  122351. * Sets the Aperture amount
  122352. * @param amount amount of Aperture
  122353. */
  122354. setAperture(amount: number): void;
  122355. /**
  122356. * Sets the DarkenOutOfFocus amount
  122357. * @param amount amount of DarkenOutOfFocus
  122358. */
  122359. setDarkenOutOfFocus(amount: number): void;
  122360. private _pentagonBokehIsEnabled;
  122361. /**
  122362. * Creates a pentagon bokeh effect
  122363. */
  122364. enablePentagonBokeh(): void;
  122365. /**
  122366. * Disables the pentagon bokeh effect
  122367. */
  122368. disablePentagonBokeh(): void;
  122369. /**
  122370. * Enables noise blur
  122371. */
  122372. enableNoiseBlur(): void;
  122373. /**
  122374. * Disables noise blur
  122375. */
  122376. disableNoiseBlur(): void;
  122377. /**
  122378. * Sets the HighlightsGain amount
  122379. * @param amount amount of HighlightsGain
  122380. */
  122381. setHighlightsGain(amount: number): void;
  122382. /**
  122383. * Sets the HighlightsThreshold amount
  122384. * @param amount amount of HighlightsThreshold
  122385. */
  122386. setHighlightsThreshold(amount: number): void;
  122387. /**
  122388. * Disables highlights
  122389. */
  122390. disableHighlights(): void;
  122391. /**
  122392. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  122393. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  122394. */
  122395. dispose(disableDepthRender?: boolean): void;
  122396. private _createChromaticAberrationPostProcess;
  122397. private _createHighlightsPostProcess;
  122398. private _createDepthOfFieldPostProcess;
  122399. private _createGrainTexture;
  122400. }
  122401. }
  122402. declare module BABYLON {
  122403. /** @hidden */
  122404. export var ssao2PixelShader: {
  122405. name: string;
  122406. shader: string;
  122407. };
  122408. }
  122409. declare module BABYLON {
  122410. /** @hidden */
  122411. export var ssaoCombinePixelShader: {
  122412. name: string;
  122413. shader: string;
  122414. };
  122415. }
  122416. declare module BABYLON {
  122417. /**
  122418. * Render pipeline to produce ssao effect
  122419. */
  122420. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  122421. /**
  122422. * @ignore
  122423. * The PassPostProcess id in the pipeline that contains the original scene color
  122424. */
  122425. SSAOOriginalSceneColorEffect: string;
  122426. /**
  122427. * @ignore
  122428. * The SSAO PostProcess id in the pipeline
  122429. */
  122430. SSAORenderEffect: string;
  122431. /**
  122432. * @ignore
  122433. * The horizontal blur PostProcess id in the pipeline
  122434. */
  122435. SSAOBlurHRenderEffect: string;
  122436. /**
  122437. * @ignore
  122438. * The vertical blur PostProcess id in the pipeline
  122439. */
  122440. SSAOBlurVRenderEffect: string;
  122441. /**
  122442. * @ignore
  122443. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  122444. */
  122445. SSAOCombineRenderEffect: string;
  122446. /**
  122447. * The output strength of the SSAO post-process. Default value is 1.0.
  122448. */
  122449. totalStrength: number;
  122450. /**
  122451. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  122452. */
  122453. maxZ: number;
  122454. /**
  122455. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  122456. */
  122457. minZAspect: number;
  122458. private _samples;
  122459. /**
  122460. * Number of samples used for the SSAO calculations. Default value is 8
  122461. */
  122462. samples: number;
  122463. private _textureSamples;
  122464. /**
  122465. * Number of samples to use for antialiasing
  122466. */
  122467. textureSamples: number;
  122468. /**
  122469. * Ratio object used for SSAO ratio and blur ratio
  122470. */
  122471. private _ratio;
  122472. /**
  122473. * Dynamically generated sphere sampler.
  122474. */
  122475. private _sampleSphere;
  122476. /**
  122477. * Blur filter offsets
  122478. */
  122479. private _samplerOffsets;
  122480. private _expensiveBlur;
  122481. /**
  122482. * If bilateral blur should be used
  122483. */
  122484. expensiveBlur: boolean;
  122485. /**
  122486. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  122487. */
  122488. radius: number;
  122489. /**
  122490. * The base color of the SSAO post-process
  122491. * The final result is "base + ssao" between [0, 1]
  122492. */
  122493. base: number;
  122494. /**
  122495. * Support test.
  122496. */
  122497. static readonly IsSupported: boolean;
  122498. private _scene;
  122499. private _depthTexture;
  122500. private _normalTexture;
  122501. private _randomTexture;
  122502. private _originalColorPostProcess;
  122503. private _ssaoPostProcess;
  122504. private _blurHPostProcess;
  122505. private _blurVPostProcess;
  122506. private _ssaoCombinePostProcess;
  122507. private _firstUpdate;
  122508. /**
  122509. * Gets active scene
  122510. */
  122511. readonly scene: Scene;
  122512. /**
  122513. * @constructor
  122514. * @param name The rendering pipeline name
  122515. * @param scene The scene linked to this pipeline
  122516. * @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 }
  122517. * @param cameras The array of cameras that the rendering pipeline will be attached to
  122518. */
  122519. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  122520. /**
  122521. * Get the class name
  122522. * @returns "SSAO2RenderingPipeline"
  122523. */
  122524. getClassName(): string;
  122525. /**
  122526. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  122527. */
  122528. dispose(disableGeometryBufferRenderer?: boolean): void;
  122529. private _createBlurPostProcess;
  122530. /** @hidden */
  122531. _rebuild(): void;
  122532. private _bits;
  122533. private _radicalInverse_VdC;
  122534. private _hammersley;
  122535. private _hemisphereSample_uniform;
  122536. private _generateHemisphere;
  122537. private _createSSAOPostProcess;
  122538. private _createSSAOCombinePostProcess;
  122539. private _createRandomTexture;
  122540. /**
  122541. * Serialize the rendering pipeline (Used when exporting)
  122542. * @returns the serialized object
  122543. */
  122544. serialize(): any;
  122545. /**
  122546. * Parse the serialized pipeline
  122547. * @param source Source pipeline.
  122548. * @param scene The scene to load the pipeline to.
  122549. * @param rootUrl The URL of the serialized pipeline.
  122550. * @returns An instantiated pipeline from the serialized object.
  122551. */
  122552. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  122553. }
  122554. }
  122555. declare module BABYLON {
  122556. /** @hidden */
  122557. export var ssaoPixelShader: {
  122558. name: string;
  122559. shader: string;
  122560. };
  122561. }
  122562. declare module BABYLON {
  122563. /**
  122564. * Render pipeline to produce ssao effect
  122565. */
  122566. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  122567. /**
  122568. * @ignore
  122569. * The PassPostProcess id in the pipeline that contains the original scene color
  122570. */
  122571. SSAOOriginalSceneColorEffect: string;
  122572. /**
  122573. * @ignore
  122574. * The SSAO PostProcess id in the pipeline
  122575. */
  122576. SSAORenderEffect: string;
  122577. /**
  122578. * @ignore
  122579. * The horizontal blur PostProcess id in the pipeline
  122580. */
  122581. SSAOBlurHRenderEffect: string;
  122582. /**
  122583. * @ignore
  122584. * The vertical blur PostProcess id in the pipeline
  122585. */
  122586. SSAOBlurVRenderEffect: string;
  122587. /**
  122588. * @ignore
  122589. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  122590. */
  122591. SSAOCombineRenderEffect: string;
  122592. /**
  122593. * The output strength of the SSAO post-process. Default value is 1.0.
  122594. */
  122595. totalStrength: number;
  122596. /**
  122597. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  122598. */
  122599. radius: number;
  122600. /**
  122601. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  122602. * Must not be equal to fallOff and superior to fallOff.
  122603. * Default value is 0.0075
  122604. */
  122605. area: number;
  122606. /**
  122607. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  122608. * Must not be equal to area and inferior to area.
  122609. * Default value is 0.000001
  122610. */
  122611. fallOff: number;
  122612. /**
  122613. * The base color of the SSAO post-process
  122614. * The final result is "base + ssao" between [0, 1]
  122615. */
  122616. base: number;
  122617. private _scene;
  122618. private _depthTexture;
  122619. private _randomTexture;
  122620. private _originalColorPostProcess;
  122621. private _ssaoPostProcess;
  122622. private _blurHPostProcess;
  122623. private _blurVPostProcess;
  122624. private _ssaoCombinePostProcess;
  122625. private _firstUpdate;
  122626. /**
  122627. * Gets active scene
  122628. */
  122629. readonly scene: Scene;
  122630. /**
  122631. * @constructor
  122632. * @param name - The rendering pipeline name
  122633. * @param scene - The scene linked to this pipeline
  122634. * @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 }
  122635. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  122636. */
  122637. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  122638. /**
  122639. * Get the class name
  122640. * @returns "SSAORenderingPipeline"
  122641. */
  122642. getClassName(): string;
  122643. /**
  122644. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  122645. */
  122646. dispose(disableDepthRender?: boolean): void;
  122647. private _createBlurPostProcess;
  122648. /** @hidden */
  122649. _rebuild(): void;
  122650. private _createSSAOPostProcess;
  122651. private _createSSAOCombinePostProcess;
  122652. private _createRandomTexture;
  122653. }
  122654. }
  122655. declare module BABYLON {
  122656. /** @hidden */
  122657. export var standardPixelShader: {
  122658. name: string;
  122659. shader: string;
  122660. };
  122661. }
  122662. declare module BABYLON {
  122663. /**
  122664. * Standard rendering pipeline
  122665. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  122666. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  122667. */
  122668. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  122669. /**
  122670. * Public members
  122671. */
  122672. /**
  122673. * Post-process which contains the original scene color before the pipeline applies all the effects
  122674. */
  122675. originalPostProcess: Nullable<PostProcess>;
  122676. /**
  122677. * Post-process used to down scale an image x4
  122678. */
  122679. downSampleX4PostProcess: Nullable<PostProcess>;
  122680. /**
  122681. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  122682. */
  122683. brightPassPostProcess: Nullable<PostProcess>;
  122684. /**
  122685. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  122686. */
  122687. blurHPostProcesses: PostProcess[];
  122688. /**
  122689. * Post-process array storing all the vertical blur post-processes used by the pipeline
  122690. */
  122691. blurVPostProcesses: PostProcess[];
  122692. /**
  122693. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  122694. */
  122695. textureAdderPostProcess: Nullable<PostProcess>;
  122696. /**
  122697. * Post-process used to create volumetric lighting effect
  122698. */
  122699. volumetricLightPostProcess: Nullable<PostProcess>;
  122700. /**
  122701. * Post-process used to smooth the previous volumetric light post-process on the X axis
  122702. */
  122703. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  122704. /**
  122705. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  122706. */
  122707. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  122708. /**
  122709. * Post-process used to merge the volumetric light effect and the real scene color
  122710. */
  122711. volumetricLightMergePostProces: Nullable<PostProcess>;
  122712. /**
  122713. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  122714. */
  122715. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  122716. /**
  122717. * Base post-process used to calculate the average luminance of the final image for HDR
  122718. */
  122719. luminancePostProcess: Nullable<PostProcess>;
  122720. /**
  122721. * Post-processes used to create down sample post-processes in order to get
  122722. * the average luminance of the final image for HDR
  122723. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  122724. */
  122725. luminanceDownSamplePostProcesses: PostProcess[];
  122726. /**
  122727. * Post-process used to create a HDR effect (light adaptation)
  122728. */
  122729. hdrPostProcess: Nullable<PostProcess>;
  122730. /**
  122731. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  122732. */
  122733. textureAdderFinalPostProcess: Nullable<PostProcess>;
  122734. /**
  122735. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  122736. */
  122737. lensFlareFinalPostProcess: Nullable<PostProcess>;
  122738. /**
  122739. * Post-process used to merge the final HDR post-process and the real scene color
  122740. */
  122741. hdrFinalPostProcess: Nullable<PostProcess>;
  122742. /**
  122743. * Post-process used to create a lens flare effect
  122744. */
  122745. lensFlarePostProcess: Nullable<PostProcess>;
  122746. /**
  122747. * Post-process that merges the result of the lens flare post-process and the real scene color
  122748. */
  122749. lensFlareComposePostProcess: Nullable<PostProcess>;
  122750. /**
  122751. * Post-process used to create a motion blur effect
  122752. */
  122753. motionBlurPostProcess: Nullable<PostProcess>;
  122754. /**
  122755. * Post-process used to create a depth of field effect
  122756. */
  122757. depthOfFieldPostProcess: Nullable<PostProcess>;
  122758. /**
  122759. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  122760. */
  122761. fxaaPostProcess: Nullable<FxaaPostProcess>;
  122762. /**
  122763. * Represents the brightness threshold in order to configure the illuminated surfaces
  122764. */
  122765. brightThreshold: number;
  122766. /**
  122767. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  122768. */
  122769. blurWidth: number;
  122770. /**
  122771. * Sets if the blur for highlighted surfaces must be only horizontal
  122772. */
  122773. horizontalBlur: boolean;
  122774. /**
  122775. * Gets the overall exposure used by the pipeline
  122776. */
  122777. /**
  122778. * Sets the overall exposure used by the pipeline
  122779. */
  122780. exposure: number;
  122781. /**
  122782. * Texture used typically to simulate "dirty" on camera lens
  122783. */
  122784. lensTexture: Nullable<Texture>;
  122785. /**
  122786. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  122787. */
  122788. volumetricLightCoefficient: number;
  122789. /**
  122790. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  122791. */
  122792. volumetricLightPower: number;
  122793. /**
  122794. * Used the set the blur intensity to smooth the volumetric lights
  122795. */
  122796. volumetricLightBlurScale: number;
  122797. /**
  122798. * Light (spot or directional) used to generate the volumetric lights rays
  122799. * The source light must have a shadow generate so the pipeline can get its
  122800. * depth map
  122801. */
  122802. sourceLight: Nullable<SpotLight | DirectionalLight>;
  122803. /**
  122804. * For eye adaptation, represents the minimum luminance the eye can see
  122805. */
  122806. hdrMinimumLuminance: number;
  122807. /**
  122808. * For eye adaptation, represents the decrease luminance speed
  122809. */
  122810. hdrDecreaseRate: number;
  122811. /**
  122812. * For eye adaptation, represents the increase luminance speed
  122813. */
  122814. hdrIncreaseRate: number;
  122815. /**
  122816. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  122817. */
  122818. /**
  122819. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  122820. */
  122821. hdrAutoExposure: boolean;
  122822. /**
  122823. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  122824. */
  122825. lensColorTexture: Nullable<Texture>;
  122826. /**
  122827. * The overall strengh for the lens flare effect
  122828. */
  122829. lensFlareStrength: number;
  122830. /**
  122831. * Dispersion coefficient for lens flare ghosts
  122832. */
  122833. lensFlareGhostDispersal: number;
  122834. /**
  122835. * Main lens flare halo width
  122836. */
  122837. lensFlareHaloWidth: number;
  122838. /**
  122839. * Based on the lens distortion effect, defines how much the lens flare result
  122840. * is distorted
  122841. */
  122842. lensFlareDistortionStrength: number;
  122843. /**
  122844. * Lens star texture must be used to simulate rays on the flares and is available
  122845. * in the documentation
  122846. */
  122847. lensStarTexture: Nullable<Texture>;
  122848. /**
  122849. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  122850. * flare effect by taking account of the dirt texture
  122851. */
  122852. lensFlareDirtTexture: Nullable<Texture>;
  122853. /**
  122854. * Represents the focal length for the depth of field effect
  122855. */
  122856. depthOfFieldDistance: number;
  122857. /**
  122858. * Represents the blur intensity for the blurred part of the depth of field effect
  122859. */
  122860. depthOfFieldBlurWidth: number;
  122861. /**
  122862. * Gets how much the image is blurred by the movement while using the motion blur post-process
  122863. */
  122864. /**
  122865. * Sets how much the image is blurred by the movement while using the motion blur post-process
  122866. */
  122867. motionStrength: number;
  122868. /**
  122869. * Gets wether or not the motion blur post-process is object based or screen based.
  122870. */
  122871. /**
  122872. * Sets wether or not the motion blur post-process should be object based or screen based
  122873. */
  122874. objectBasedMotionBlur: boolean;
  122875. /**
  122876. * List of animations for the pipeline (IAnimatable implementation)
  122877. */
  122878. animations: Animation[];
  122879. /**
  122880. * Private members
  122881. */
  122882. private _scene;
  122883. private _currentDepthOfFieldSource;
  122884. private _basePostProcess;
  122885. private _fixedExposure;
  122886. private _currentExposure;
  122887. private _hdrAutoExposure;
  122888. private _hdrCurrentLuminance;
  122889. private _motionStrength;
  122890. private _isObjectBasedMotionBlur;
  122891. private _floatTextureType;
  122892. private _ratio;
  122893. private _bloomEnabled;
  122894. private _depthOfFieldEnabled;
  122895. private _vlsEnabled;
  122896. private _lensFlareEnabled;
  122897. private _hdrEnabled;
  122898. private _motionBlurEnabled;
  122899. private _fxaaEnabled;
  122900. private _motionBlurSamples;
  122901. private _volumetricLightStepsCount;
  122902. private _samples;
  122903. /**
  122904. * @ignore
  122905. * Specifies if the bloom pipeline is enabled
  122906. */
  122907. BloomEnabled: boolean;
  122908. /**
  122909. * @ignore
  122910. * Specifies if the depth of field pipeline is enabed
  122911. */
  122912. DepthOfFieldEnabled: boolean;
  122913. /**
  122914. * @ignore
  122915. * Specifies if the lens flare pipeline is enabed
  122916. */
  122917. LensFlareEnabled: boolean;
  122918. /**
  122919. * @ignore
  122920. * Specifies if the HDR pipeline is enabled
  122921. */
  122922. HDREnabled: boolean;
  122923. /**
  122924. * @ignore
  122925. * Specifies if the volumetric lights scattering effect is enabled
  122926. */
  122927. VLSEnabled: boolean;
  122928. /**
  122929. * @ignore
  122930. * Specifies if the motion blur effect is enabled
  122931. */
  122932. MotionBlurEnabled: boolean;
  122933. /**
  122934. * Specifies if anti-aliasing is enabled
  122935. */
  122936. fxaaEnabled: boolean;
  122937. /**
  122938. * Specifies the number of steps used to calculate the volumetric lights
  122939. * Typically in interval [50, 200]
  122940. */
  122941. volumetricLightStepsCount: number;
  122942. /**
  122943. * Specifies the number of samples used for the motion blur effect
  122944. * Typically in interval [16, 64]
  122945. */
  122946. motionBlurSamples: number;
  122947. /**
  122948. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  122949. */
  122950. samples: number;
  122951. /**
  122952. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  122953. * @constructor
  122954. * @param name The rendering pipeline name
  122955. * @param scene The scene linked to this pipeline
  122956. * @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)
  122957. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  122958. * @param cameras The array of cameras that the rendering pipeline will be attached to
  122959. */
  122960. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  122961. private _buildPipeline;
  122962. private _createDownSampleX4PostProcess;
  122963. private _createBrightPassPostProcess;
  122964. private _createBlurPostProcesses;
  122965. private _createTextureAdderPostProcess;
  122966. private _createVolumetricLightPostProcess;
  122967. private _createLuminancePostProcesses;
  122968. private _createHdrPostProcess;
  122969. private _createLensFlarePostProcess;
  122970. private _createDepthOfFieldPostProcess;
  122971. private _createMotionBlurPostProcess;
  122972. private _getDepthTexture;
  122973. private _disposePostProcesses;
  122974. /**
  122975. * Dispose of the pipeline and stop all post processes
  122976. */
  122977. dispose(): void;
  122978. /**
  122979. * Serialize the rendering pipeline (Used when exporting)
  122980. * @returns the serialized object
  122981. */
  122982. serialize(): any;
  122983. /**
  122984. * Parse the serialized pipeline
  122985. * @param source Source pipeline.
  122986. * @param scene The scene to load the pipeline to.
  122987. * @param rootUrl The URL of the serialized pipeline.
  122988. * @returns An instantiated pipeline from the serialized object.
  122989. */
  122990. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  122991. /**
  122992. * Luminance steps
  122993. */
  122994. static LuminanceSteps: number;
  122995. }
  122996. }
  122997. declare module BABYLON {
  122998. /** @hidden */
  122999. export var tonemapPixelShader: {
  123000. name: string;
  123001. shader: string;
  123002. };
  123003. }
  123004. declare module BABYLON {
  123005. /** Defines operator used for tonemapping */
  123006. export enum TonemappingOperator {
  123007. /** Hable */
  123008. Hable = 0,
  123009. /** Reinhard */
  123010. Reinhard = 1,
  123011. /** HejiDawson */
  123012. HejiDawson = 2,
  123013. /** Photographic */
  123014. Photographic = 3
  123015. }
  123016. /**
  123017. * Defines a post process to apply tone mapping
  123018. */
  123019. export class TonemapPostProcess extends PostProcess {
  123020. private _operator;
  123021. /** Defines the required exposure adjustement */
  123022. exposureAdjustment: number;
  123023. /**
  123024. * Creates a new TonemapPostProcess
  123025. * @param name defines the name of the postprocess
  123026. * @param _operator defines the operator to use
  123027. * @param exposureAdjustment defines the required exposure adjustement
  123028. * @param camera defines the camera to use (can be null)
  123029. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  123030. * @param engine defines the hosting engine (can be ignore if camera is set)
  123031. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  123032. */
  123033. constructor(name: string, _operator: TonemappingOperator,
  123034. /** Defines the required exposure adjustement */
  123035. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  123036. }
  123037. }
  123038. declare module BABYLON {
  123039. /** @hidden */
  123040. export var depthVertexShader: {
  123041. name: string;
  123042. shader: string;
  123043. };
  123044. }
  123045. declare module BABYLON {
  123046. /** @hidden */
  123047. export var volumetricLightScatteringPixelShader: {
  123048. name: string;
  123049. shader: string;
  123050. };
  123051. }
  123052. declare module BABYLON {
  123053. /** @hidden */
  123054. export var volumetricLightScatteringPassVertexShader: {
  123055. name: string;
  123056. shader: string;
  123057. };
  123058. }
  123059. declare module BABYLON {
  123060. /** @hidden */
  123061. export var volumetricLightScatteringPassPixelShader: {
  123062. name: string;
  123063. shader: string;
  123064. };
  123065. }
  123066. declare module BABYLON {
  123067. /**
  123068. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  123069. */
  123070. export class VolumetricLightScatteringPostProcess extends PostProcess {
  123071. private _volumetricLightScatteringPass;
  123072. private _volumetricLightScatteringRTT;
  123073. private _viewPort;
  123074. private _screenCoordinates;
  123075. private _cachedDefines;
  123076. /**
  123077. * If not undefined, the mesh position is computed from the attached node position
  123078. */
  123079. attachedNode: {
  123080. position: Vector3;
  123081. };
  123082. /**
  123083. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  123084. */
  123085. customMeshPosition: Vector3;
  123086. /**
  123087. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  123088. */
  123089. useCustomMeshPosition: boolean;
  123090. /**
  123091. * If the post-process should inverse the light scattering direction
  123092. */
  123093. invert: boolean;
  123094. /**
  123095. * The internal mesh used by the post-process
  123096. */
  123097. mesh: Mesh;
  123098. /**
  123099. * @hidden
  123100. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  123101. */
  123102. useDiffuseColor: boolean;
  123103. /**
  123104. * Array containing the excluded meshes not rendered in the internal pass
  123105. */
  123106. excludedMeshes: AbstractMesh[];
  123107. /**
  123108. * Controls the overall intensity of the post-process
  123109. */
  123110. exposure: number;
  123111. /**
  123112. * Dissipates each sample's contribution in range [0, 1]
  123113. */
  123114. decay: number;
  123115. /**
  123116. * Controls the overall intensity of each sample
  123117. */
  123118. weight: number;
  123119. /**
  123120. * Controls the density of each sample
  123121. */
  123122. density: number;
  123123. /**
  123124. * @constructor
  123125. * @param name The post-process name
  123126. * @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)
  123127. * @param camera The camera that the post-process will be attached to
  123128. * @param mesh The mesh used to create the light scattering
  123129. * @param samples The post-process quality, default 100
  123130. * @param samplingModeThe post-process filtering mode
  123131. * @param engine The babylon engine
  123132. * @param reusable If the post-process is reusable
  123133. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  123134. */
  123135. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  123136. /**
  123137. * Returns the string "VolumetricLightScatteringPostProcess"
  123138. * @returns "VolumetricLightScatteringPostProcess"
  123139. */
  123140. getClassName(): string;
  123141. private _isReady;
  123142. /**
  123143. * Sets the new light position for light scattering effect
  123144. * @param position The new custom light position
  123145. */
  123146. setCustomMeshPosition(position: Vector3): void;
  123147. /**
  123148. * Returns the light position for light scattering effect
  123149. * @return Vector3 The custom light position
  123150. */
  123151. getCustomMeshPosition(): Vector3;
  123152. /**
  123153. * Disposes the internal assets and detaches the post-process from the camera
  123154. */
  123155. dispose(camera: Camera): void;
  123156. /**
  123157. * Returns the render target texture used by the post-process
  123158. * @return the render target texture used by the post-process
  123159. */
  123160. getPass(): RenderTargetTexture;
  123161. private _meshExcluded;
  123162. private _createPass;
  123163. private _updateMeshScreenCoordinates;
  123164. /**
  123165. * Creates a default mesh for the Volumeric Light Scattering post-process
  123166. * @param name The mesh name
  123167. * @param scene The scene where to create the mesh
  123168. * @return the default mesh
  123169. */
  123170. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  123171. }
  123172. }
  123173. declare module BABYLON {
  123174. interface Scene {
  123175. /** @hidden (Backing field) */
  123176. _boundingBoxRenderer: BoundingBoxRenderer;
  123177. /** @hidden (Backing field) */
  123178. _forceShowBoundingBoxes: boolean;
  123179. /**
  123180. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  123181. */
  123182. forceShowBoundingBoxes: boolean;
  123183. /**
  123184. * Gets the bounding box renderer associated with the scene
  123185. * @returns a BoundingBoxRenderer
  123186. */
  123187. getBoundingBoxRenderer(): BoundingBoxRenderer;
  123188. }
  123189. interface AbstractMesh {
  123190. /** @hidden (Backing field) */
  123191. _showBoundingBox: boolean;
  123192. /**
  123193. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  123194. */
  123195. showBoundingBox: boolean;
  123196. }
  123197. /**
  123198. * Component responsible of rendering the bounding box of the meshes in a scene.
  123199. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  123200. */
  123201. export class BoundingBoxRenderer implements ISceneComponent {
  123202. /**
  123203. * The component name helpfull to identify the component in the list of scene components.
  123204. */
  123205. readonly name: string;
  123206. /**
  123207. * The scene the component belongs to.
  123208. */
  123209. scene: Scene;
  123210. /**
  123211. * Color of the bounding box lines placed in front of an object
  123212. */
  123213. frontColor: Color3;
  123214. /**
  123215. * Color of the bounding box lines placed behind an object
  123216. */
  123217. backColor: Color3;
  123218. /**
  123219. * Defines if the renderer should show the back lines or not
  123220. */
  123221. showBackLines: boolean;
  123222. /**
  123223. * @hidden
  123224. */
  123225. renderList: SmartArray<BoundingBox>;
  123226. private _colorShader;
  123227. private _vertexBuffers;
  123228. private _indexBuffer;
  123229. private _fillIndexBuffer;
  123230. private _fillIndexData;
  123231. /**
  123232. * Instantiates a new bounding box renderer in a scene.
  123233. * @param scene the scene the renderer renders in
  123234. */
  123235. constructor(scene: Scene);
  123236. /**
  123237. * Registers the component in a given scene
  123238. */
  123239. register(): void;
  123240. private _evaluateSubMesh;
  123241. private _activeMesh;
  123242. private _prepareRessources;
  123243. private _createIndexBuffer;
  123244. /**
  123245. * Rebuilds the elements related to this component in case of
  123246. * context lost for instance.
  123247. */
  123248. rebuild(): void;
  123249. /**
  123250. * @hidden
  123251. */
  123252. reset(): void;
  123253. /**
  123254. * Render the bounding boxes of a specific rendering group
  123255. * @param renderingGroupId defines the rendering group to render
  123256. */
  123257. render(renderingGroupId: number): void;
  123258. /**
  123259. * In case of occlusion queries, we can render the occlusion bounding box through this method
  123260. * @param mesh Define the mesh to render the occlusion bounding box for
  123261. */
  123262. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  123263. /**
  123264. * Dispose and release the resources attached to this renderer.
  123265. */
  123266. dispose(): void;
  123267. }
  123268. }
  123269. declare module BABYLON {
  123270. /** @hidden */
  123271. export var depthPixelShader: {
  123272. name: string;
  123273. shader: string;
  123274. };
  123275. }
  123276. declare module BABYLON {
  123277. /**
  123278. * This represents a depth renderer in Babylon.
  123279. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  123280. */
  123281. export class DepthRenderer {
  123282. private _scene;
  123283. private _depthMap;
  123284. private _effect;
  123285. private readonly _storeNonLinearDepth;
  123286. private readonly _clearColor;
  123287. /** Get if the depth renderer is using packed depth or not */
  123288. readonly isPacked: boolean;
  123289. private _cachedDefines;
  123290. private _camera;
  123291. /**
  123292. * Specifiess that the depth renderer will only be used within
  123293. * the camera it is created for.
  123294. * This can help forcing its rendering during the camera processing.
  123295. */
  123296. useOnlyInActiveCamera: boolean;
  123297. /** @hidden */
  123298. static _SceneComponentInitialization: (scene: Scene) => void;
  123299. /**
  123300. * Instantiates a depth renderer
  123301. * @param scene The scene the renderer belongs to
  123302. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  123303. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  123304. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  123305. */
  123306. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  123307. /**
  123308. * Creates the depth rendering effect and checks if the effect is ready.
  123309. * @param subMesh The submesh to be used to render the depth map of
  123310. * @param useInstances If multiple world instances should be used
  123311. * @returns if the depth renderer is ready to render the depth map
  123312. */
  123313. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  123314. /**
  123315. * Gets the texture which the depth map will be written to.
  123316. * @returns The depth map texture
  123317. */
  123318. getDepthMap(): RenderTargetTexture;
  123319. /**
  123320. * Disposes of the depth renderer.
  123321. */
  123322. dispose(): void;
  123323. }
  123324. }
  123325. declare module BABYLON {
  123326. interface Scene {
  123327. /** @hidden (Backing field) */
  123328. _depthRenderer: {
  123329. [id: string]: DepthRenderer;
  123330. };
  123331. /**
  123332. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  123333. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  123334. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  123335. * @returns the created depth renderer
  123336. */
  123337. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  123338. /**
  123339. * Disables a depth renderer for a given camera
  123340. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  123341. */
  123342. disableDepthRenderer(camera?: Nullable<Camera>): void;
  123343. }
  123344. /**
  123345. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  123346. * in several rendering techniques.
  123347. */
  123348. export class DepthRendererSceneComponent implements ISceneComponent {
  123349. /**
  123350. * The component name helpfull to identify the component in the list of scene components.
  123351. */
  123352. readonly name: string;
  123353. /**
  123354. * The scene the component belongs to.
  123355. */
  123356. scene: Scene;
  123357. /**
  123358. * Creates a new instance of the component for the given scene
  123359. * @param scene Defines the scene to register the component in
  123360. */
  123361. constructor(scene: Scene);
  123362. /**
  123363. * Registers the component in a given scene
  123364. */
  123365. register(): void;
  123366. /**
  123367. * Rebuilds the elements related to this component in case of
  123368. * context lost for instance.
  123369. */
  123370. rebuild(): void;
  123371. /**
  123372. * Disposes the component and the associated ressources
  123373. */
  123374. dispose(): void;
  123375. private _gatherRenderTargets;
  123376. private _gatherActiveCameraRenderTargets;
  123377. }
  123378. }
  123379. declare module BABYLON {
  123380. /** @hidden */
  123381. export var outlinePixelShader: {
  123382. name: string;
  123383. shader: string;
  123384. };
  123385. }
  123386. declare module BABYLON {
  123387. /** @hidden */
  123388. export var outlineVertexShader: {
  123389. name: string;
  123390. shader: string;
  123391. };
  123392. }
  123393. declare module BABYLON {
  123394. interface Scene {
  123395. /** @hidden */
  123396. _outlineRenderer: OutlineRenderer;
  123397. /**
  123398. * Gets the outline renderer associated with the scene
  123399. * @returns a OutlineRenderer
  123400. */
  123401. getOutlineRenderer(): OutlineRenderer;
  123402. }
  123403. interface AbstractMesh {
  123404. /** @hidden (Backing field) */
  123405. _renderOutline: boolean;
  123406. /**
  123407. * Gets or sets a boolean indicating if the outline must be rendered as well
  123408. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  123409. */
  123410. renderOutline: boolean;
  123411. /** @hidden (Backing field) */
  123412. _renderOverlay: boolean;
  123413. /**
  123414. * Gets or sets a boolean indicating if the overlay must be rendered as well
  123415. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  123416. */
  123417. renderOverlay: boolean;
  123418. }
  123419. /**
  123420. * This class is responsible to draw bothe outline/overlay of meshes.
  123421. * It should not be used directly but through the available method on mesh.
  123422. */
  123423. export class OutlineRenderer implements ISceneComponent {
  123424. /**
  123425. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  123426. */
  123427. private static _StencilReference;
  123428. /**
  123429. * The name of the component. Each component must have a unique name.
  123430. */
  123431. name: string;
  123432. /**
  123433. * The scene the component belongs to.
  123434. */
  123435. scene: Scene;
  123436. /**
  123437. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  123438. */
  123439. zOffset: number;
  123440. private _engine;
  123441. private _effect;
  123442. private _cachedDefines;
  123443. private _savedDepthWrite;
  123444. /**
  123445. * Instantiates a new outline renderer. (There could be only one per scene).
  123446. * @param scene Defines the scene it belongs to
  123447. */
  123448. constructor(scene: Scene);
  123449. /**
  123450. * Register the component to one instance of a scene.
  123451. */
  123452. register(): void;
  123453. /**
  123454. * Rebuilds the elements related to this component in case of
  123455. * context lost for instance.
  123456. */
  123457. rebuild(): void;
  123458. /**
  123459. * Disposes the component and the associated ressources.
  123460. */
  123461. dispose(): void;
  123462. /**
  123463. * Renders the outline in the canvas.
  123464. * @param subMesh Defines the sumesh to render
  123465. * @param batch Defines the batch of meshes in case of instances
  123466. * @param useOverlay Defines if the rendering is for the overlay or the outline
  123467. */
  123468. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  123469. /**
  123470. * Returns whether or not the outline renderer is ready for a given submesh.
  123471. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  123472. * @param subMesh Defines the submesh to check readyness for
  123473. * @param useInstances Defines wheter wee are trying to render instances or not
  123474. * @returns true if ready otherwise false
  123475. */
  123476. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  123477. private _beforeRenderingMesh;
  123478. private _afterRenderingMesh;
  123479. }
  123480. }
  123481. declare module BABYLON {
  123482. /**
  123483. * Defines the list of states available for a task inside a AssetsManager
  123484. */
  123485. export enum AssetTaskState {
  123486. /**
  123487. * Initialization
  123488. */
  123489. INIT = 0,
  123490. /**
  123491. * Running
  123492. */
  123493. RUNNING = 1,
  123494. /**
  123495. * Done
  123496. */
  123497. DONE = 2,
  123498. /**
  123499. * Error
  123500. */
  123501. ERROR = 3
  123502. }
  123503. /**
  123504. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  123505. */
  123506. export abstract class AbstractAssetTask {
  123507. /**
  123508. * Task name
  123509. */ name: string;
  123510. /**
  123511. * Callback called when the task is successful
  123512. */
  123513. onSuccess: (task: any) => void;
  123514. /**
  123515. * Callback called when the task is not successful
  123516. */
  123517. onError: (task: any, message?: string, exception?: any) => void;
  123518. /**
  123519. * Creates a new AssetsManager
  123520. * @param name defines the name of the task
  123521. */
  123522. constructor(
  123523. /**
  123524. * Task name
  123525. */ name: string);
  123526. private _isCompleted;
  123527. private _taskState;
  123528. private _errorObject;
  123529. /**
  123530. * Get if the task is completed
  123531. */
  123532. readonly isCompleted: boolean;
  123533. /**
  123534. * Gets the current state of the task
  123535. */
  123536. readonly taskState: AssetTaskState;
  123537. /**
  123538. * Gets the current error object (if task is in error)
  123539. */
  123540. readonly errorObject: {
  123541. message?: string;
  123542. exception?: any;
  123543. };
  123544. /**
  123545. * Internal only
  123546. * @hidden
  123547. */
  123548. _setErrorObject(message?: string, exception?: any): void;
  123549. /**
  123550. * Execute the current task
  123551. * @param scene defines the scene where you want your assets to be loaded
  123552. * @param onSuccess is a callback called when the task is successfully executed
  123553. * @param onError is a callback called if an error occurs
  123554. */
  123555. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123556. /**
  123557. * Execute the current task
  123558. * @param scene defines the scene where you want your assets to be loaded
  123559. * @param onSuccess is a callback called when the task is successfully executed
  123560. * @param onError is a callback called if an error occurs
  123561. */
  123562. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123563. /**
  123564. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  123565. * This can be used with failed tasks that have the reason for failure fixed.
  123566. */
  123567. reset(): void;
  123568. private onErrorCallback;
  123569. private onDoneCallback;
  123570. }
  123571. /**
  123572. * Define the interface used by progress events raised during assets loading
  123573. */
  123574. export interface IAssetsProgressEvent {
  123575. /**
  123576. * Defines the number of remaining tasks to process
  123577. */
  123578. remainingCount: number;
  123579. /**
  123580. * Defines the total number of tasks
  123581. */
  123582. totalCount: number;
  123583. /**
  123584. * Defines the task that was just processed
  123585. */
  123586. task: AbstractAssetTask;
  123587. }
  123588. /**
  123589. * Class used to share progress information about assets loading
  123590. */
  123591. export class AssetsProgressEvent implements IAssetsProgressEvent {
  123592. /**
  123593. * Defines the number of remaining tasks to process
  123594. */
  123595. remainingCount: number;
  123596. /**
  123597. * Defines the total number of tasks
  123598. */
  123599. totalCount: number;
  123600. /**
  123601. * Defines the task that was just processed
  123602. */
  123603. task: AbstractAssetTask;
  123604. /**
  123605. * Creates a AssetsProgressEvent
  123606. * @param remainingCount defines the number of remaining tasks to process
  123607. * @param totalCount defines the total number of tasks
  123608. * @param task defines the task that was just processed
  123609. */
  123610. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  123611. }
  123612. /**
  123613. * Define a task used by AssetsManager to load meshes
  123614. */
  123615. export class MeshAssetTask extends AbstractAssetTask {
  123616. /**
  123617. * Defines the name of the task
  123618. */
  123619. name: string;
  123620. /**
  123621. * Defines the list of mesh's names you want to load
  123622. */
  123623. meshesNames: any;
  123624. /**
  123625. * Defines the root url to use as a base to load your meshes and associated resources
  123626. */
  123627. rootUrl: string;
  123628. /**
  123629. * Defines the filename of the scene to load from
  123630. */
  123631. sceneFilename: string;
  123632. /**
  123633. * Gets the list of loaded meshes
  123634. */
  123635. loadedMeshes: Array<AbstractMesh>;
  123636. /**
  123637. * Gets the list of loaded particle systems
  123638. */
  123639. loadedParticleSystems: Array<IParticleSystem>;
  123640. /**
  123641. * Gets the list of loaded skeletons
  123642. */
  123643. loadedSkeletons: Array<Skeleton>;
  123644. /**
  123645. * Gets the list of loaded animation groups
  123646. */
  123647. loadedAnimationGroups: Array<AnimationGroup>;
  123648. /**
  123649. * Callback called when the task is successful
  123650. */
  123651. onSuccess: (task: MeshAssetTask) => void;
  123652. /**
  123653. * Callback called when the task is successful
  123654. */
  123655. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  123656. /**
  123657. * Creates a new MeshAssetTask
  123658. * @param name defines the name of the task
  123659. * @param meshesNames defines the list of mesh's names you want to load
  123660. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  123661. * @param sceneFilename defines the filename of the scene to load from
  123662. */
  123663. constructor(
  123664. /**
  123665. * Defines the name of the task
  123666. */
  123667. name: string,
  123668. /**
  123669. * Defines the list of mesh's names you want to load
  123670. */
  123671. meshesNames: any,
  123672. /**
  123673. * Defines the root url to use as a base to load your meshes and associated resources
  123674. */
  123675. rootUrl: string,
  123676. /**
  123677. * Defines the filename of the scene to load from
  123678. */
  123679. sceneFilename: string);
  123680. /**
  123681. * Execute the current task
  123682. * @param scene defines the scene where you want your assets to be loaded
  123683. * @param onSuccess is a callback called when the task is successfully executed
  123684. * @param onError is a callback called if an error occurs
  123685. */
  123686. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123687. }
  123688. /**
  123689. * Define a task used by AssetsManager to load text content
  123690. */
  123691. export class TextFileAssetTask extends AbstractAssetTask {
  123692. /**
  123693. * Defines the name of the task
  123694. */
  123695. name: string;
  123696. /**
  123697. * Defines the location of the file to load
  123698. */
  123699. url: string;
  123700. /**
  123701. * Gets the loaded text string
  123702. */
  123703. text: string;
  123704. /**
  123705. * Callback called when the task is successful
  123706. */
  123707. onSuccess: (task: TextFileAssetTask) => void;
  123708. /**
  123709. * Callback called when the task is successful
  123710. */
  123711. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  123712. /**
  123713. * Creates a new TextFileAssetTask object
  123714. * @param name defines the name of the task
  123715. * @param url defines the location of the file to load
  123716. */
  123717. constructor(
  123718. /**
  123719. * Defines the name of the task
  123720. */
  123721. name: string,
  123722. /**
  123723. * Defines the location of the file to load
  123724. */
  123725. url: string);
  123726. /**
  123727. * Execute the current task
  123728. * @param scene defines the scene where you want your assets to be loaded
  123729. * @param onSuccess is a callback called when the task is successfully executed
  123730. * @param onError is a callback called if an error occurs
  123731. */
  123732. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123733. }
  123734. /**
  123735. * Define a task used by AssetsManager to load binary data
  123736. */
  123737. export class BinaryFileAssetTask extends AbstractAssetTask {
  123738. /**
  123739. * Defines the name of the task
  123740. */
  123741. name: string;
  123742. /**
  123743. * Defines the location of the file to load
  123744. */
  123745. url: string;
  123746. /**
  123747. * Gets the lodaded data (as an array buffer)
  123748. */
  123749. data: ArrayBuffer;
  123750. /**
  123751. * Callback called when the task is successful
  123752. */
  123753. onSuccess: (task: BinaryFileAssetTask) => void;
  123754. /**
  123755. * Callback called when the task is successful
  123756. */
  123757. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  123758. /**
  123759. * Creates a new BinaryFileAssetTask object
  123760. * @param name defines the name of the new task
  123761. * @param url defines the location of the file to load
  123762. */
  123763. constructor(
  123764. /**
  123765. * Defines the name of the task
  123766. */
  123767. name: string,
  123768. /**
  123769. * Defines the location of the file to load
  123770. */
  123771. url: string);
  123772. /**
  123773. * Execute the current task
  123774. * @param scene defines the scene where you want your assets to be loaded
  123775. * @param onSuccess is a callback called when the task is successfully executed
  123776. * @param onError is a callback called if an error occurs
  123777. */
  123778. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123779. }
  123780. /**
  123781. * Define a task used by AssetsManager to load images
  123782. */
  123783. export class ImageAssetTask extends AbstractAssetTask {
  123784. /**
  123785. * Defines the name of the task
  123786. */
  123787. name: string;
  123788. /**
  123789. * Defines the location of the image to load
  123790. */
  123791. url: string;
  123792. /**
  123793. * Gets the loaded images
  123794. */
  123795. image: HTMLImageElement;
  123796. /**
  123797. * Callback called when the task is successful
  123798. */
  123799. onSuccess: (task: ImageAssetTask) => void;
  123800. /**
  123801. * Callback called when the task is successful
  123802. */
  123803. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  123804. /**
  123805. * Creates a new ImageAssetTask
  123806. * @param name defines the name of the task
  123807. * @param url defines the location of the image to load
  123808. */
  123809. constructor(
  123810. /**
  123811. * Defines the name of the task
  123812. */
  123813. name: string,
  123814. /**
  123815. * Defines the location of the image to load
  123816. */
  123817. url: string);
  123818. /**
  123819. * Execute the current task
  123820. * @param scene defines the scene where you want your assets to be loaded
  123821. * @param onSuccess is a callback called when the task is successfully executed
  123822. * @param onError is a callback called if an error occurs
  123823. */
  123824. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123825. }
  123826. /**
  123827. * Defines the interface used by texture loading tasks
  123828. */
  123829. export interface ITextureAssetTask<TEX extends BaseTexture> {
  123830. /**
  123831. * Gets the loaded texture
  123832. */
  123833. texture: TEX;
  123834. }
  123835. /**
  123836. * Define a task used by AssetsManager to load 2D textures
  123837. */
  123838. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  123839. /**
  123840. * Defines the name of the task
  123841. */
  123842. name: string;
  123843. /**
  123844. * Defines the location of the file to load
  123845. */
  123846. url: string;
  123847. /**
  123848. * Defines if mipmap should not be generated (default is false)
  123849. */
  123850. noMipmap?: boolean | undefined;
  123851. /**
  123852. * Defines if texture must be inverted on Y axis (default is false)
  123853. */
  123854. invertY?: boolean | undefined;
  123855. /**
  123856. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  123857. */
  123858. samplingMode: number;
  123859. /**
  123860. * Gets the loaded texture
  123861. */
  123862. texture: Texture;
  123863. /**
  123864. * Callback called when the task is successful
  123865. */
  123866. onSuccess: (task: TextureAssetTask) => void;
  123867. /**
  123868. * Callback called when the task is successful
  123869. */
  123870. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  123871. /**
  123872. * Creates a new TextureAssetTask object
  123873. * @param name defines the name of the task
  123874. * @param url defines the location of the file to load
  123875. * @param noMipmap defines if mipmap should not be generated (default is false)
  123876. * @param invertY defines if texture must be inverted on Y axis (default is false)
  123877. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  123878. */
  123879. constructor(
  123880. /**
  123881. * Defines the name of the task
  123882. */
  123883. name: string,
  123884. /**
  123885. * Defines the location of the file to load
  123886. */
  123887. url: string,
  123888. /**
  123889. * Defines if mipmap should not be generated (default is false)
  123890. */
  123891. noMipmap?: boolean | undefined,
  123892. /**
  123893. * Defines if texture must be inverted on Y axis (default is false)
  123894. */
  123895. invertY?: boolean | undefined,
  123896. /**
  123897. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  123898. */
  123899. samplingMode?: number);
  123900. /**
  123901. * Execute the current task
  123902. * @param scene defines the scene where you want your assets to be loaded
  123903. * @param onSuccess is a callback called when the task is successfully executed
  123904. * @param onError is a callback called if an error occurs
  123905. */
  123906. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123907. }
  123908. /**
  123909. * Define a task used by AssetsManager to load cube textures
  123910. */
  123911. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  123912. /**
  123913. * Defines the name of the task
  123914. */
  123915. name: string;
  123916. /**
  123917. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  123918. */
  123919. url: string;
  123920. /**
  123921. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  123922. */
  123923. extensions?: string[] | undefined;
  123924. /**
  123925. * Defines if mipmaps should not be generated (default is false)
  123926. */
  123927. noMipmap?: boolean | undefined;
  123928. /**
  123929. * Defines the explicit list of files (undefined by default)
  123930. */
  123931. files?: string[] | undefined;
  123932. /**
  123933. * Gets the loaded texture
  123934. */
  123935. texture: CubeTexture;
  123936. /**
  123937. * Callback called when the task is successful
  123938. */
  123939. onSuccess: (task: CubeTextureAssetTask) => void;
  123940. /**
  123941. * Callback called when the task is successful
  123942. */
  123943. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  123944. /**
  123945. * Creates a new CubeTextureAssetTask
  123946. * @param name defines the name of the task
  123947. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  123948. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  123949. * @param noMipmap defines if mipmaps should not be generated (default is false)
  123950. * @param files defines the explicit list of files (undefined by default)
  123951. */
  123952. constructor(
  123953. /**
  123954. * Defines the name of the task
  123955. */
  123956. name: string,
  123957. /**
  123958. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  123959. */
  123960. url: string,
  123961. /**
  123962. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  123963. */
  123964. extensions?: string[] | undefined,
  123965. /**
  123966. * Defines if mipmaps should not be generated (default is false)
  123967. */
  123968. noMipmap?: boolean | undefined,
  123969. /**
  123970. * Defines the explicit list of files (undefined by default)
  123971. */
  123972. files?: string[] | undefined);
  123973. /**
  123974. * Execute the current task
  123975. * @param scene defines the scene where you want your assets to be loaded
  123976. * @param onSuccess is a callback called when the task is successfully executed
  123977. * @param onError is a callback called if an error occurs
  123978. */
  123979. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  123980. }
  123981. /**
  123982. * Define a task used by AssetsManager to load HDR cube textures
  123983. */
  123984. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  123985. /**
  123986. * Defines the name of the task
  123987. */
  123988. name: string;
  123989. /**
  123990. * Defines the location of the file to load
  123991. */
  123992. url: string;
  123993. /**
  123994. * Defines the desired size (the more it increases the longer the generation will be)
  123995. */
  123996. size: number;
  123997. /**
  123998. * Defines if mipmaps should not be generated (default is false)
  123999. */
  124000. noMipmap: boolean;
  124001. /**
  124002. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  124003. */
  124004. generateHarmonics: boolean;
  124005. /**
  124006. * 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)
  124007. */
  124008. gammaSpace: boolean;
  124009. /**
  124010. * Internal Use Only
  124011. */
  124012. reserved: boolean;
  124013. /**
  124014. * Gets the loaded texture
  124015. */
  124016. texture: HDRCubeTexture;
  124017. /**
  124018. * Callback called when the task is successful
  124019. */
  124020. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  124021. /**
  124022. * Callback called when the task is successful
  124023. */
  124024. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  124025. /**
  124026. * Creates a new HDRCubeTextureAssetTask object
  124027. * @param name defines the name of the task
  124028. * @param url defines the location of the file to load
  124029. * @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.
  124030. * @param noMipmap defines if mipmaps should not be generated (default is false)
  124031. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  124032. * @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)
  124033. * @param reserved Internal use only
  124034. */
  124035. constructor(
  124036. /**
  124037. * Defines the name of the task
  124038. */
  124039. name: string,
  124040. /**
  124041. * Defines the location of the file to load
  124042. */
  124043. url: string,
  124044. /**
  124045. * Defines the desired size (the more it increases the longer the generation will be)
  124046. */
  124047. size: number,
  124048. /**
  124049. * Defines if mipmaps should not be generated (default is false)
  124050. */
  124051. noMipmap?: boolean,
  124052. /**
  124053. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  124054. */
  124055. generateHarmonics?: boolean,
  124056. /**
  124057. * 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)
  124058. */
  124059. gammaSpace?: boolean,
  124060. /**
  124061. * Internal Use Only
  124062. */
  124063. reserved?: boolean);
  124064. /**
  124065. * Execute the current task
  124066. * @param scene defines the scene where you want your assets to be loaded
  124067. * @param onSuccess is a callback called when the task is successfully executed
  124068. * @param onError is a callback called if an error occurs
  124069. */
  124070. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  124071. }
  124072. /**
  124073. * Define a task used by AssetsManager to load Equirectangular cube textures
  124074. */
  124075. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  124076. /**
  124077. * Defines the name of the task
  124078. */
  124079. name: string;
  124080. /**
  124081. * Defines the location of the file to load
  124082. */
  124083. url: string;
  124084. /**
  124085. * Defines the desired size (the more it increases the longer the generation will be)
  124086. */
  124087. size: number;
  124088. /**
  124089. * Defines if mipmaps should not be generated (default is false)
  124090. */
  124091. noMipmap: boolean;
  124092. /**
  124093. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  124094. * but the standard material would require them in Gamma space) (default is true)
  124095. */
  124096. gammaSpace: boolean;
  124097. /**
  124098. * Gets the loaded texture
  124099. */
  124100. texture: EquiRectangularCubeTexture;
  124101. /**
  124102. * Callback called when the task is successful
  124103. */
  124104. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  124105. /**
  124106. * Callback called when the task is successful
  124107. */
  124108. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  124109. /**
  124110. * Creates a new EquiRectangularCubeTextureAssetTask object
  124111. * @param name defines the name of the task
  124112. * @param url defines the location of the file to load
  124113. * @param size defines the desired size (the more it increases the longer the generation will be)
  124114. * If the size is omitted this implies you are using a preprocessed cubemap.
  124115. * @param noMipmap defines if mipmaps should not be generated (default is false)
  124116. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  124117. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  124118. * (default is true)
  124119. */
  124120. constructor(
  124121. /**
  124122. * Defines the name of the task
  124123. */
  124124. name: string,
  124125. /**
  124126. * Defines the location of the file to load
  124127. */
  124128. url: string,
  124129. /**
  124130. * Defines the desired size (the more it increases the longer the generation will be)
  124131. */
  124132. size: number,
  124133. /**
  124134. * Defines if mipmaps should not be generated (default is false)
  124135. */
  124136. noMipmap?: boolean,
  124137. /**
  124138. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  124139. * but the standard material would require them in Gamma space) (default is true)
  124140. */
  124141. gammaSpace?: boolean);
  124142. /**
  124143. * Execute the current task
  124144. * @param scene defines the scene where you want your assets to be loaded
  124145. * @param onSuccess is a callback called when the task is successfully executed
  124146. * @param onError is a callback called if an error occurs
  124147. */
  124148. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  124149. }
  124150. /**
  124151. * This class can be used to easily import assets into a scene
  124152. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  124153. */
  124154. export class AssetsManager {
  124155. private _scene;
  124156. private _isLoading;
  124157. protected _tasks: AbstractAssetTask[];
  124158. protected _waitingTasksCount: number;
  124159. protected _totalTasksCount: number;
  124160. /**
  124161. * Callback called when all tasks are processed
  124162. */
  124163. onFinish: (tasks: AbstractAssetTask[]) => void;
  124164. /**
  124165. * Callback called when a task is successful
  124166. */
  124167. onTaskSuccess: (task: AbstractAssetTask) => void;
  124168. /**
  124169. * Callback called when a task had an error
  124170. */
  124171. onTaskError: (task: AbstractAssetTask) => void;
  124172. /**
  124173. * Callback called when a task is done (whatever the result is)
  124174. */
  124175. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  124176. /**
  124177. * Observable called when all tasks are processed
  124178. */
  124179. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  124180. /**
  124181. * Observable called when a task had an error
  124182. */
  124183. onTaskErrorObservable: Observable<AbstractAssetTask>;
  124184. /**
  124185. * Observable called when all tasks were executed
  124186. */
  124187. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  124188. /**
  124189. * Observable called when a task is done (whatever the result is)
  124190. */
  124191. onProgressObservable: Observable<IAssetsProgressEvent>;
  124192. /**
  124193. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  124194. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  124195. */
  124196. useDefaultLoadingScreen: boolean;
  124197. /**
  124198. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  124199. * when all assets have been downloaded.
  124200. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  124201. */
  124202. autoHideLoadingUI: boolean;
  124203. /**
  124204. * Creates a new AssetsManager
  124205. * @param scene defines the scene to work on
  124206. */
  124207. constructor(scene: Scene);
  124208. /**
  124209. * Add a MeshAssetTask to the list of active tasks
  124210. * @param taskName defines the name of the new task
  124211. * @param meshesNames defines the name of meshes to load
  124212. * @param rootUrl defines the root url to use to locate files
  124213. * @param sceneFilename defines the filename of the scene file
  124214. * @returns a new MeshAssetTask object
  124215. */
  124216. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  124217. /**
  124218. * Add a TextFileAssetTask to the list of active tasks
  124219. * @param taskName defines the name of the new task
  124220. * @param url defines the url of the file to load
  124221. * @returns a new TextFileAssetTask object
  124222. */
  124223. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  124224. /**
  124225. * Add a BinaryFileAssetTask to the list of active tasks
  124226. * @param taskName defines the name of the new task
  124227. * @param url defines the url of the file to load
  124228. * @returns a new BinaryFileAssetTask object
  124229. */
  124230. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  124231. /**
  124232. * Add a ImageAssetTask to the list of active tasks
  124233. * @param taskName defines the name of the new task
  124234. * @param url defines the url of the file to load
  124235. * @returns a new ImageAssetTask object
  124236. */
  124237. addImageTask(taskName: string, url: string): ImageAssetTask;
  124238. /**
  124239. * Add a TextureAssetTask to the list of active tasks
  124240. * @param taskName defines the name of the new task
  124241. * @param url defines the url of the file to load
  124242. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  124243. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  124244. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  124245. * @returns a new TextureAssetTask object
  124246. */
  124247. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  124248. /**
  124249. * Add a CubeTextureAssetTask to the list of active tasks
  124250. * @param taskName defines the name of the new task
  124251. * @param url defines the url of the file to load
  124252. * @param extensions defines the extension to use to load the cube map (can be null)
  124253. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  124254. * @param files defines the list of files to load (can be null)
  124255. * @returns a new CubeTextureAssetTask object
  124256. */
  124257. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  124258. /**
  124259. *
  124260. * Add a HDRCubeTextureAssetTask to the list of active tasks
  124261. * @param taskName defines the name of the new task
  124262. * @param url defines the url of the file to load
  124263. * @param size defines the size you want for the cubemap (can be null)
  124264. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  124265. * @param generateHarmonics defines if you want to automatically generate (true by default)
  124266. * @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)
  124267. * @param reserved Internal use only
  124268. * @returns a new HDRCubeTextureAssetTask object
  124269. */
  124270. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  124271. /**
  124272. *
  124273. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  124274. * @param taskName defines the name of the new task
  124275. * @param url defines the url of the file to load
  124276. * @param size defines the size you want for the cubemap (can be null)
  124277. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  124278. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  124279. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  124280. * @returns a new EquiRectangularCubeTextureAssetTask object
  124281. */
  124282. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  124283. /**
  124284. * Remove a task from the assets manager.
  124285. * @param task the task to remove
  124286. */
  124287. removeTask(task: AbstractAssetTask): void;
  124288. private _decreaseWaitingTasksCount;
  124289. private _runTask;
  124290. /**
  124291. * Reset the AssetsManager and remove all tasks
  124292. * @return the current instance of the AssetsManager
  124293. */
  124294. reset(): AssetsManager;
  124295. /**
  124296. * Start the loading process
  124297. * @return the current instance of the AssetsManager
  124298. */
  124299. load(): AssetsManager;
  124300. /**
  124301. * Start the loading process as an async operation
  124302. * @return a promise returning the list of failed tasks
  124303. */
  124304. loadAsync(): Promise<void>;
  124305. }
  124306. }
  124307. declare module BABYLON {
  124308. /**
  124309. * Wrapper class for promise with external resolve and reject.
  124310. */
  124311. export class Deferred<T> {
  124312. /**
  124313. * The promise associated with this deferred object.
  124314. */
  124315. readonly promise: Promise<T>;
  124316. private _resolve;
  124317. private _reject;
  124318. /**
  124319. * The resolve method of the promise associated with this deferred object.
  124320. */
  124321. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  124322. /**
  124323. * The reject method of the promise associated with this deferred object.
  124324. */
  124325. readonly reject: (reason?: any) => void;
  124326. /**
  124327. * Constructor for this deferred object.
  124328. */
  124329. constructor();
  124330. }
  124331. }
  124332. declare module BABYLON {
  124333. /**
  124334. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  124335. */
  124336. export class MeshExploder {
  124337. private _centerMesh;
  124338. private _meshes;
  124339. private _meshesOrigins;
  124340. private _toCenterVectors;
  124341. private _scaledDirection;
  124342. private _newPosition;
  124343. private _centerPosition;
  124344. /**
  124345. * Explodes meshes from a center mesh.
  124346. * @param meshes The meshes to explode.
  124347. * @param centerMesh The mesh to be center of explosion.
  124348. */
  124349. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  124350. private _setCenterMesh;
  124351. /**
  124352. * Get class name
  124353. * @returns "MeshExploder"
  124354. */
  124355. getClassName(): string;
  124356. /**
  124357. * "Exploded meshes"
  124358. * @returns Array of meshes with the centerMesh at index 0.
  124359. */
  124360. getMeshes(): Array<Mesh>;
  124361. /**
  124362. * Explodes meshes giving a specific direction
  124363. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  124364. */
  124365. explode(direction?: number): void;
  124366. }
  124367. }
  124368. declare module BABYLON {
  124369. /**
  124370. * Class used to help managing file picking and drag'n'drop
  124371. */
  124372. export class FilesInput {
  124373. /**
  124374. * List of files ready to be loaded
  124375. */
  124376. static readonly FilesToLoad: {
  124377. [key: string]: File;
  124378. };
  124379. /**
  124380. * Callback called when a file is processed
  124381. */
  124382. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  124383. private _engine;
  124384. private _currentScene;
  124385. private _sceneLoadedCallback;
  124386. private _progressCallback;
  124387. private _additionalRenderLoopLogicCallback;
  124388. private _textureLoadingCallback;
  124389. private _startingProcessingFilesCallback;
  124390. private _onReloadCallback;
  124391. private _errorCallback;
  124392. private _elementToMonitor;
  124393. private _sceneFileToLoad;
  124394. private _filesToLoad;
  124395. /**
  124396. * Creates a new FilesInput
  124397. * @param engine defines the rendering engine
  124398. * @param scene defines the hosting scene
  124399. * @param sceneLoadedCallback callback called when scene is loaded
  124400. * @param progressCallback callback called to track progress
  124401. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  124402. * @param textureLoadingCallback callback called when a texture is loading
  124403. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  124404. * @param onReloadCallback callback called when a reload is requested
  124405. * @param errorCallback callback call if an error occurs
  124406. */
  124407. 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);
  124408. private _dragEnterHandler;
  124409. private _dragOverHandler;
  124410. private _dropHandler;
  124411. /**
  124412. * Calls this function to listen to drag'n'drop events on a specific DOM element
  124413. * @param elementToMonitor defines the DOM element to track
  124414. */
  124415. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  124416. /**
  124417. * Release all associated resources
  124418. */
  124419. dispose(): void;
  124420. private renderFunction;
  124421. private drag;
  124422. private drop;
  124423. private _traverseFolder;
  124424. private _processFiles;
  124425. /**
  124426. * Load files from a drop event
  124427. * @param event defines the drop event to use as source
  124428. */
  124429. loadFiles(event: any): void;
  124430. private _processReload;
  124431. /**
  124432. * Reload the current scene from the loaded files
  124433. */
  124434. reload(): void;
  124435. }
  124436. }
  124437. declare module BABYLON {
  124438. /**
  124439. * Defines the root class used to create scene optimization to use with SceneOptimizer
  124440. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124441. */
  124442. export class SceneOptimization {
  124443. /**
  124444. * Defines the priority of this optimization (0 by default which means first in the list)
  124445. */
  124446. priority: number;
  124447. /**
  124448. * Gets a string describing the action executed by the current optimization
  124449. * @returns description string
  124450. */
  124451. getDescription(): string;
  124452. /**
  124453. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124454. * @param scene defines the current scene where to apply this optimization
  124455. * @param optimizer defines the current optimizer
  124456. * @returns true if everything that can be done was applied
  124457. */
  124458. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124459. /**
  124460. * Creates the SceneOptimization object
  124461. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  124462. * @param desc defines the description associated with the optimization
  124463. */
  124464. constructor(
  124465. /**
  124466. * Defines the priority of this optimization (0 by default which means first in the list)
  124467. */
  124468. priority?: number);
  124469. }
  124470. /**
  124471. * Defines an optimization used to reduce the size of render target textures
  124472. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124473. */
  124474. export class TextureOptimization extends SceneOptimization {
  124475. /**
  124476. * Defines the priority of this optimization (0 by default which means first in the list)
  124477. */
  124478. priority: number;
  124479. /**
  124480. * 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
  124481. */
  124482. maximumSize: number;
  124483. /**
  124484. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  124485. */
  124486. step: number;
  124487. /**
  124488. * Gets a string describing the action executed by the current optimization
  124489. * @returns description string
  124490. */
  124491. getDescription(): string;
  124492. /**
  124493. * Creates the TextureOptimization object
  124494. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  124495. * @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
  124496. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  124497. */
  124498. constructor(
  124499. /**
  124500. * Defines the priority of this optimization (0 by default which means first in the list)
  124501. */
  124502. priority?: number,
  124503. /**
  124504. * 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
  124505. */
  124506. maximumSize?: number,
  124507. /**
  124508. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  124509. */
  124510. step?: number);
  124511. /**
  124512. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124513. * @param scene defines the current scene where to apply this optimization
  124514. * @param optimizer defines the current optimizer
  124515. * @returns true if everything that can be done was applied
  124516. */
  124517. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124518. }
  124519. /**
  124520. * Defines an optimization used to increase or decrease the rendering resolution
  124521. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124522. */
  124523. export class HardwareScalingOptimization extends SceneOptimization {
  124524. /**
  124525. * Defines the priority of this optimization (0 by default which means first in the list)
  124526. */
  124527. priority: number;
  124528. /**
  124529. * Defines the maximum scale to use (2 by default)
  124530. */
  124531. maximumScale: number;
  124532. /**
  124533. * Defines the step to use between two passes (0.5 by default)
  124534. */
  124535. step: number;
  124536. private _currentScale;
  124537. private _directionOffset;
  124538. /**
  124539. * Gets a string describing the action executed by the current optimization
  124540. * @return description string
  124541. */
  124542. getDescription(): string;
  124543. /**
  124544. * Creates the HardwareScalingOptimization object
  124545. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  124546. * @param maximumScale defines the maximum scale to use (2 by default)
  124547. * @param step defines the step to use between two passes (0.5 by default)
  124548. */
  124549. constructor(
  124550. /**
  124551. * Defines the priority of this optimization (0 by default which means first in the list)
  124552. */
  124553. priority?: number,
  124554. /**
  124555. * Defines the maximum scale to use (2 by default)
  124556. */
  124557. maximumScale?: number,
  124558. /**
  124559. * Defines the step to use between two passes (0.5 by default)
  124560. */
  124561. step?: number);
  124562. /**
  124563. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124564. * @param scene defines the current scene where to apply this optimization
  124565. * @param optimizer defines the current optimizer
  124566. * @returns true if everything that can be done was applied
  124567. */
  124568. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124569. }
  124570. /**
  124571. * Defines an optimization used to remove shadows
  124572. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124573. */
  124574. export class ShadowsOptimization extends SceneOptimization {
  124575. /**
  124576. * Gets a string describing the action executed by the current optimization
  124577. * @return description string
  124578. */
  124579. getDescription(): string;
  124580. /**
  124581. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124582. * @param scene defines the current scene where to apply this optimization
  124583. * @param optimizer defines the current optimizer
  124584. * @returns true if everything that can be done was applied
  124585. */
  124586. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124587. }
  124588. /**
  124589. * Defines an optimization used to turn post-processes off
  124590. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124591. */
  124592. export class PostProcessesOptimization extends SceneOptimization {
  124593. /**
  124594. * Gets a string describing the action executed by the current optimization
  124595. * @return description string
  124596. */
  124597. getDescription(): string;
  124598. /**
  124599. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124600. * @param scene defines the current scene where to apply this optimization
  124601. * @param optimizer defines the current optimizer
  124602. * @returns true if everything that can be done was applied
  124603. */
  124604. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124605. }
  124606. /**
  124607. * Defines an optimization used to turn lens flares off
  124608. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124609. */
  124610. export class LensFlaresOptimization extends SceneOptimization {
  124611. /**
  124612. * Gets a string describing the action executed by the current optimization
  124613. * @return description string
  124614. */
  124615. getDescription(): string;
  124616. /**
  124617. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124618. * @param scene defines the current scene where to apply this optimization
  124619. * @param optimizer defines the current optimizer
  124620. * @returns true if everything that can be done was applied
  124621. */
  124622. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124623. }
  124624. /**
  124625. * Defines an optimization based on user defined callback.
  124626. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124627. */
  124628. export class CustomOptimization extends SceneOptimization {
  124629. /**
  124630. * Callback called to apply the custom optimization.
  124631. */
  124632. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  124633. /**
  124634. * Callback called to get custom description
  124635. */
  124636. onGetDescription: () => string;
  124637. /**
  124638. * Gets a string describing the action executed by the current optimization
  124639. * @returns description string
  124640. */
  124641. getDescription(): string;
  124642. /**
  124643. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124644. * @param scene defines the current scene where to apply this optimization
  124645. * @param optimizer defines the current optimizer
  124646. * @returns true if everything that can be done was applied
  124647. */
  124648. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124649. }
  124650. /**
  124651. * Defines an optimization used to turn particles off
  124652. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124653. */
  124654. export class ParticlesOptimization extends SceneOptimization {
  124655. /**
  124656. * Gets a string describing the action executed by the current optimization
  124657. * @return description string
  124658. */
  124659. getDescription(): string;
  124660. /**
  124661. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124662. * @param scene defines the current scene where to apply this optimization
  124663. * @param optimizer defines the current optimizer
  124664. * @returns true if everything that can be done was applied
  124665. */
  124666. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124667. }
  124668. /**
  124669. * Defines an optimization used to turn render targets off
  124670. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124671. */
  124672. export class RenderTargetsOptimization extends SceneOptimization {
  124673. /**
  124674. * Gets a string describing the action executed by the current optimization
  124675. * @return description string
  124676. */
  124677. getDescription(): string;
  124678. /**
  124679. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124680. * @param scene defines the current scene where to apply this optimization
  124681. * @param optimizer defines the current optimizer
  124682. * @returns true if everything that can be done was applied
  124683. */
  124684. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  124685. }
  124686. /**
  124687. * Defines an optimization used to merge meshes with compatible materials
  124688. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124689. */
  124690. export class MergeMeshesOptimization extends SceneOptimization {
  124691. private static _UpdateSelectionTree;
  124692. /**
  124693. * Gets or sets a boolean which defines if optimization octree has to be updated
  124694. */
  124695. /**
  124696. * Gets or sets a boolean which defines if optimization octree has to be updated
  124697. */
  124698. static UpdateSelectionTree: boolean;
  124699. /**
  124700. * Gets a string describing the action executed by the current optimization
  124701. * @return description string
  124702. */
  124703. getDescription(): string;
  124704. private _canBeMerged;
  124705. /**
  124706. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  124707. * @param scene defines the current scene where to apply this optimization
  124708. * @param optimizer defines the current optimizer
  124709. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  124710. * @returns true if everything that can be done was applied
  124711. */
  124712. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  124713. }
  124714. /**
  124715. * Defines a list of options used by SceneOptimizer
  124716. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124717. */
  124718. export class SceneOptimizerOptions {
  124719. /**
  124720. * Defines the target frame rate to reach (60 by default)
  124721. */
  124722. targetFrameRate: number;
  124723. /**
  124724. * Defines the interval between two checkes (2000ms by default)
  124725. */
  124726. trackerDuration: number;
  124727. /**
  124728. * Gets the list of optimizations to apply
  124729. */
  124730. optimizations: SceneOptimization[];
  124731. /**
  124732. * Creates a new list of options used by SceneOptimizer
  124733. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  124734. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  124735. */
  124736. constructor(
  124737. /**
  124738. * Defines the target frame rate to reach (60 by default)
  124739. */
  124740. targetFrameRate?: number,
  124741. /**
  124742. * Defines the interval between two checkes (2000ms by default)
  124743. */
  124744. trackerDuration?: number);
  124745. /**
  124746. * Add a new optimization
  124747. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  124748. * @returns the current SceneOptimizerOptions
  124749. */
  124750. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  124751. /**
  124752. * Add a new custom optimization
  124753. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  124754. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  124755. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  124756. * @returns the current SceneOptimizerOptions
  124757. */
  124758. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  124759. /**
  124760. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  124761. * @param targetFrameRate defines the target frame rate (60 by default)
  124762. * @returns a SceneOptimizerOptions object
  124763. */
  124764. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  124765. /**
  124766. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  124767. * @param targetFrameRate defines the target frame rate (60 by default)
  124768. * @returns a SceneOptimizerOptions object
  124769. */
  124770. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  124771. /**
  124772. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  124773. * @param targetFrameRate defines the target frame rate (60 by default)
  124774. * @returns a SceneOptimizerOptions object
  124775. */
  124776. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  124777. }
  124778. /**
  124779. * Class used to run optimizations in order to reach a target frame rate
  124780. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  124781. */
  124782. export class SceneOptimizer implements IDisposable {
  124783. private _isRunning;
  124784. private _options;
  124785. private _scene;
  124786. private _currentPriorityLevel;
  124787. private _targetFrameRate;
  124788. private _trackerDuration;
  124789. private _currentFrameRate;
  124790. private _sceneDisposeObserver;
  124791. private _improvementMode;
  124792. /**
  124793. * Defines an observable called when the optimizer reaches the target frame rate
  124794. */
  124795. onSuccessObservable: Observable<SceneOptimizer>;
  124796. /**
  124797. * Defines an observable called when the optimizer enables an optimization
  124798. */
  124799. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  124800. /**
  124801. * Defines an observable called when the optimizer is not able to reach the target frame rate
  124802. */
  124803. onFailureObservable: Observable<SceneOptimizer>;
  124804. /**
  124805. * Gets a boolean indicating if the optimizer is in improvement mode
  124806. */
  124807. readonly isInImprovementMode: boolean;
  124808. /**
  124809. * Gets the current priority level (0 at start)
  124810. */
  124811. readonly currentPriorityLevel: number;
  124812. /**
  124813. * Gets the current frame rate checked by the SceneOptimizer
  124814. */
  124815. readonly currentFrameRate: number;
  124816. /**
  124817. * Gets or sets the current target frame rate (60 by default)
  124818. */
  124819. /**
  124820. * Gets or sets the current target frame rate (60 by default)
  124821. */
  124822. targetFrameRate: number;
  124823. /**
  124824. * Gets or sets the current interval between two checks (every 2000ms by default)
  124825. */
  124826. /**
  124827. * Gets or sets the current interval between two checks (every 2000ms by default)
  124828. */
  124829. trackerDuration: number;
  124830. /**
  124831. * Gets the list of active optimizations
  124832. */
  124833. readonly optimizations: SceneOptimization[];
  124834. /**
  124835. * Creates a new SceneOptimizer
  124836. * @param scene defines the scene to work on
  124837. * @param options defines the options to use with the SceneOptimizer
  124838. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  124839. * @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)
  124840. */
  124841. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  124842. /**
  124843. * Stops the current optimizer
  124844. */
  124845. stop(): void;
  124846. /**
  124847. * Reset the optimizer to initial step (current priority level = 0)
  124848. */
  124849. reset(): void;
  124850. /**
  124851. * Start the optimizer. By default it will try to reach a specific framerate
  124852. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  124853. */
  124854. start(): void;
  124855. private _checkCurrentState;
  124856. /**
  124857. * Release all resources
  124858. */
  124859. dispose(): void;
  124860. /**
  124861. * Helper function to create a SceneOptimizer with one single line of code
  124862. * @param scene defines the scene to work on
  124863. * @param options defines the options to use with the SceneOptimizer
  124864. * @param onSuccess defines a callback to call on success
  124865. * @param onFailure defines a callback to call on failure
  124866. * @returns the new SceneOptimizer object
  124867. */
  124868. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  124869. }
  124870. }
  124871. declare module BABYLON {
  124872. /**
  124873. * Class used to serialize a scene into a string
  124874. */
  124875. export class SceneSerializer {
  124876. /**
  124877. * Clear cache used by a previous serialization
  124878. */
  124879. static ClearCache(): void;
  124880. /**
  124881. * Serialize a scene into a JSON compatible object
  124882. * @param scene defines the scene to serialize
  124883. * @returns a JSON compatible object
  124884. */
  124885. static Serialize(scene: Scene): any;
  124886. /**
  124887. * Serialize a mesh into a JSON compatible object
  124888. * @param toSerialize defines the mesh to serialize
  124889. * @param withParents defines if parents must be serialized as well
  124890. * @param withChildren defines if children must be serialized as well
  124891. * @returns a JSON compatible object
  124892. */
  124893. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  124894. }
  124895. }
  124896. declare module BABYLON {
  124897. /**
  124898. * Class used to host texture specific utilities
  124899. */
  124900. export class TextureTools {
  124901. /**
  124902. * Uses the GPU to create a copy texture rescaled at a given size
  124903. * @param texture Texture to copy from
  124904. * @param width defines the desired width
  124905. * @param height defines the desired height
  124906. * @param useBilinearMode defines if bilinear mode has to be used
  124907. * @return the generated texture
  124908. */
  124909. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  124910. }
  124911. }
  124912. declare module BABYLON {
  124913. /**
  124914. * This represents the different options available for the video capture.
  124915. */
  124916. export interface VideoRecorderOptions {
  124917. /** Defines the mime type of the video. */
  124918. mimeType: string;
  124919. /** Defines the FPS the video should be recorded at. */
  124920. fps: number;
  124921. /** Defines the chunk size for the recording data. */
  124922. recordChunckSize: number;
  124923. /** The audio tracks to attach to the recording. */
  124924. audioTracks?: MediaStreamTrack[];
  124925. }
  124926. /**
  124927. * This can help with recording videos from BabylonJS.
  124928. * This is based on the available WebRTC functionalities of the browser.
  124929. *
  124930. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  124931. */
  124932. export class VideoRecorder {
  124933. private static readonly _defaultOptions;
  124934. /**
  124935. * Returns whether or not the VideoRecorder is available in your browser.
  124936. * @param engine Defines the Babylon Engine.
  124937. * @returns true if supported otherwise false.
  124938. */
  124939. static IsSupported(engine: Engine): boolean;
  124940. private readonly _options;
  124941. private _canvas;
  124942. private _mediaRecorder;
  124943. private _recordedChunks;
  124944. private _fileName;
  124945. private _resolve;
  124946. private _reject;
  124947. /**
  124948. * True when a recording is already in progress.
  124949. */
  124950. readonly isRecording: boolean;
  124951. /**
  124952. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  124953. * @param engine Defines the BabylonJS Engine you wish to record.
  124954. * @param options Defines options that can be used to customize the capture.
  124955. */
  124956. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  124957. /**
  124958. * Stops the current recording before the default capture timeout passed in the startRecording function.
  124959. */
  124960. stopRecording(): void;
  124961. /**
  124962. * Starts recording the canvas for a max duration specified in parameters.
  124963. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  124964. * If null no automatic download will start and you can rely on the promise to get the data back.
  124965. * @param maxDuration Defines the maximum recording time in seconds.
  124966. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  124967. * @return A promise callback at the end of the recording with the video data in Blob.
  124968. */
  124969. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  124970. /**
  124971. * Releases internal resources used during the recording.
  124972. */
  124973. dispose(): void;
  124974. private _handleDataAvailable;
  124975. private _handleError;
  124976. private _handleStop;
  124977. }
  124978. }
  124979. declare module BABYLON {
  124980. /**
  124981. * Class containing a set of static utilities functions for screenshots
  124982. */
  124983. export class ScreenshotTools {
  124984. /**
  124985. * Captures a screenshot of the current rendering
  124986. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  124987. * @param engine defines the rendering engine
  124988. * @param camera defines the source camera
  124989. * @param size This parameter can be set to a single number or to an object with the
  124990. * following (optional) properties: precision, width, height. If a single number is passed,
  124991. * it will be used for both width and height. If an object is passed, the screenshot size
  124992. * will be derived from the parameters. The precision property is a multiplier allowing
  124993. * rendering at a higher or lower resolution
  124994. * @param successCallback defines the callback receives a single parameter which contains the
  124995. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  124996. * src parameter of an <img> to display it
  124997. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  124998. * Check your browser for supported MIME types
  124999. */
  125000. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  125001. /**
  125002. * Captures a screenshot of the current rendering
  125003. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  125004. * @param engine defines the rendering engine
  125005. * @param camera defines the source camera
  125006. * @param size This parameter can be set to a single number or to an object with the
  125007. * following (optional) properties: precision, width, height. If a single number is passed,
  125008. * it will be used for both width and height. If an object is passed, the screenshot size
  125009. * will be derived from the parameters. The precision property is a multiplier allowing
  125010. * rendering at a higher or lower resolution
  125011. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  125012. * Check your browser for supported MIME types
  125013. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  125014. * to the src parameter of an <img> to display it
  125015. */
  125016. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  125017. /**
  125018. * Generates an image screenshot from the specified camera.
  125019. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  125020. * @param engine The engine to use for rendering
  125021. * @param camera The camera to use for rendering
  125022. * @param size This parameter can be set to a single number or to an object with the
  125023. * following (optional) properties: precision, width, height. If a single number is passed,
  125024. * it will be used for both width and height. If an object is passed, the screenshot size
  125025. * will be derived from the parameters. The precision property is a multiplier allowing
  125026. * rendering at a higher or lower resolution
  125027. * @param successCallback The callback receives a single parameter which contains the
  125028. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  125029. * src parameter of an <img> to display it
  125030. * @param mimeType The MIME type of the screenshot image (default: image/png).
  125031. * Check your browser for supported MIME types
  125032. * @param samples Texture samples (default: 1)
  125033. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  125034. * @param fileName A name for for the downloaded file.
  125035. */
  125036. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  125037. /**
  125038. * Generates an image screenshot from the specified camera.
  125039. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  125040. * @param engine The engine to use for rendering
  125041. * @param camera The camera to use for rendering
  125042. * @param size This parameter can be set to a single number or to an object with the
  125043. * following (optional) properties: precision, width, height. If a single number is passed,
  125044. * it will be used for both width and height. If an object is passed, the screenshot size
  125045. * will be derived from the parameters. The precision property is a multiplier allowing
  125046. * rendering at a higher or lower resolution
  125047. * @param mimeType The MIME type of the screenshot image (default: image/png).
  125048. * Check your browser for supported MIME types
  125049. * @param samples Texture samples (default: 1)
  125050. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  125051. * @param fileName A name for for the downloaded file.
  125052. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  125053. * to the src parameter of an <img> to display it
  125054. */
  125055. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  125056. /**
  125057. * Gets height and width for screenshot size
  125058. * @private
  125059. */
  125060. private static _getScreenshotSize;
  125061. }
  125062. }
  125063. declare module BABYLON {
  125064. /**
  125065. * A cursor which tracks a point on a path
  125066. */
  125067. export class PathCursor {
  125068. private path;
  125069. /**
  125070. * Stores path cursor callbacks for when an onchange event is triggered
  125071. */
  125072. private _onchange;
  125073. /**
  125074. * The value of the path cursor
  125075. */
  125076. value: number;
  125077. /**
  125078. * The animation array of the path cursor
  125079. */
  125080. animations: Animation[];
  125081. /**
  125082. * Initializes the path cursor
  125083. * @param path The path to track
  125084. */
  125085. constructor(path: Path2);
  125086. /**
  125087. * Gets the cursor point on the path
  125088. * @returns A point on the path cursor at the cursor location
  125089. */
  125090. getPoint(): Vector3;
  125091. /**
  125092. * Moves the cursor ahead by the step amount
  125093. * @param step The amount to move the cursor forward
  125094. * @returns This path cursor
  125095. */
  125096. moveAhead(step?: number): PathCursor;
  125097. /**
  125098. * Moves the cursor behind by the step amount
  125099. * @param step The amount to move the cursor back
  125100. * @returns This path cursor
  125101. */
  125102. moveBack(step?: number): PathCursor;
  125103. /**
  125104. * Moves the cursor by the step amount
  125105. * If the step amount is greater than one, an exception is thrown
  125106. * @param step The amount to move the cursor
  125107. * @returns This path cursor
  125108. */
  125109. move(step: number): PathCursor;
  125110. /**
  125111. * Ensures that the value is limited between zero and one
  125112. * @returns This path cursor
  125113. */
  125114. private ensureLimits;
  125115. /**
  125116. * Runs onchange callbacks on change (used by the animation engine)
  125117. * @returns This path cursor
  125118. */
  125119. private raiseOnChange;
  125120. /**
  125121. * Executes a function on change
  125122. * @param f A path cursor onchange callback
  125123. * @returns This path cursor
  125124. */
  125125. onchange(f: (cursor: PathCursor) => void): PathCursor;
  125126. }
  125127. }
  125128. declare module BABYLON {
  125129. /** @hidden */
  125130. export var blurPixelShader: {
  125131. name: string;
  125132. shader: string;
  125133. };
  125134. }
  125135. declare module BABYLON {
  125136. /** @hidden */
  125137. export var pointCloudVertexDeclaration: {
  125138. name: string;
  125139. shader: string;
  125140. };
  125141. }
  125142. // Mixins
  125143. interface Window {
  125144. mozIndexedDB: IDBFactory;
  125145. webkitIndexedDB: IDBFactory;
  125146. msIndexedDB: IDBFactory;
  125147. webkitURL: typeof URL;
  125148. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  125149. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  125150. WebGLRenderingContext: WebGLRenderingContext;
  125151. MSGesture: MSGesture;
  125152. CANNON: any;
  125153. AudioContext: AudioContext;
  125154. webkitAudioContext: AudioContext;
  125155. PointerEvent: any;
  125156. Math: Math;
  125157. Uint8Array: Uint8ArrayConstructor;
  125158. Float32Array: Float32ArrayConstructor;
  125159. mozURL: typeof URL;
  125160. msURL: typeof URL;
  125161. VRFrameData: any; // WebVR, from specs 1.1
  125162. DracoDecoderModule: any;
  125163. setImmediate(handler: (...args: any[]) => void): number;
  125164. }
  125165. interface HTMLCanvasElement {
  125166. requestPointerLock(): void;
  125167. msRequestPointerLock?(): void;
  125168. mozRequestPointerLock?(): void;
  125169. webkitRequestPointerLock?(): void;
  125170. /** Track wether a record is in progress */
  125171. isRecording: boolean;
  125172. /** Capture Stream method defined by some browsers */
  125173. captureStream(fps?: number): MediaStream;
  125174. }
  125175. interface CanvasRenderingContext2D {
  125176. msImageSmoothingEnabled: boolean;
  125177. }
  125178. interface MouseEvent {
  125179. mozMovementX: number;
  125180. mozMovementY: number;
  125181. webkitMovementX: number;
  125182. webkitMovementY: number;
  125183. msMovementX: number;
  125184. msMovementY: number;
  125185. }
  125186. interface Navigator {
  125187. mozGetVRDevices: (any: any) => any;
  125188. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  125189. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  125190. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  125191. webkitGetGamepads(): Gamepad[];
  125192. msGetGamepads(): Gamepad[];
  125193. webkitGamepads(): Gamepad[];
  125194. }
  125195. interface HTMLVideoElement {
  125196. mozSrcObject: any;
  125197. }
  125198. interface Math {
  125199. fround(x: number): number;
  125200. imul(a: number, b: number): number;
  125201. }
  125202. interface WebGLRenderingContext {
  125203. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  125204. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  125205. vertexAttribDivisor(index: number, divisor: number): void;
  125206. createVertexArray(): any;
  125207. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  125208. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  125209. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  125210. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  125211. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  125212. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  125213. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  125214. // Queries
  125215. createQuery(): WebGLQuery;
  125216. deleteQuery(query: WebGLQuery): void;
  125217. beginQuery(target: number, query: WebGLQuery): void;
  125218. endQuery(target: number): void;
  125219. getQueryParameter(query: WebGLQuery, pname: number): any;
  125220. getQuery(target: number, pname: number): any;
  125221. MAX_SAMPLES: number;
  125222. RGBA8: number;
  125223. READ_FRAMEBUFFER: number;
  125224. DRAW_FRAMEBUFFER: number;
  125225. UNIFORM_BUFFER: number;
  125226. HALF_FLOAT_OES: number;
  125227. RGBA16F: number;
  125228. RGBA32F: number;
  125229. R32F: number;
  125230. RG32F: number;
  125231. RGB32F: number;
  125232. R16F: number;
  125233. RG16F: number;
  125234. RGB16F: number;
  125235. RED: number;
  125236. RG: number;
  125237. R8: number;
  125238. RG8: number;
  125239. UNSIGNED_INT_24_8: number;
  125240. DEPTH24_STENCIL8: number;
  125241. /* Multiple Render Targets */
  125242. drawBuffers(buffers: number[]): void;
  125243. readBuffer(src: number): void;
  125244. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  125245. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  125246. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  125247. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  125248. // Occlusion Query
  125249. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  125250. ANY_SAMPLES_PASSED: number;
  125251. QUERY_RESULT_AVAILABLE: number;
  125252. QUERY_RESULT: number;
  125253. }
  125254. interface WebGLProgram {
  125255. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  125256. }
  125257. interface EXT_disjoint_timer_query {
  125258. QUERY_COUNTER_BITS_EXT: number;
  125259. TIME_ELAPSED_EXT: number;
  125260. TIMESTAMP_EXT: number;
  125261. GPU_DISJOINT_EXT: number;
  125262. QUERY_RESULT_EXT: number;
  125263. QUERY_RESULT_AVAILABLE_EXT: number;
  125264. queryCounterEXT(query: WebGLQuery, target: number): void;
  125265. createQueryEXT(): WebGLQuery;
  125266. beginQueryEXT(target: number, query: WebGLQuery): void;
  125267. endQueryEXT(target: number): void;
  125268. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  125269. deleteQueryEXT(query: WebGLQuery): void;
  125270. }
  125271. interface WebGLUniformLocation {
  125272. _currentState: any;
  125273. }
  125274. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  125275. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  125276. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  125277. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  125278. interface WebGLRenderingContext {
  125279. readonly RASTERIZER_DISCARD: number;
  125280. readonly DEPTH_COMPONENT24: number;
  125281. readonly TEXTURE_3D: number;
  125282. readonly TEXTURE_2D_ARRAY: number;
  125283. readonly TEXTURE_COMPARE_FUNC: number;
  125284. readonly TEXTURE_COMPARE_MODE: number;
  125285. readonly COMPARE_REF_TO_TEXTURE: number;
  125286. readonly TEXTURE_WRAP_R: number;
  125287. readonly HALF_FLOAT: number;
  125288. readonly RGB8: number;
  125289. readonly RED_INTEGER: number;
  125290. readonly RG_INTEGER: number;
  125291. readonly RGB_INTEGER: number;
  125292. readonly RGBA_INTEGER: number;
  125293. readonly R8_SNORM: number;
  125294. readonly RG8_SNORM: number;
  125295. readonly RGB8_SNORM: number;
  125296. readonly RGBA8_SNORM: number;
  125297. readonly R8I: number;
  125298. readonly RG8I: number;
  125299. readonly RGB8I: number;
  125300. readonly RGBA8I: number;
  125301. readonly R8UI: number;
  125302. readonly RG8UI: number;
  125303. readonly RGB8UI: number;
  125304. readonly RGBA8UI: number;
  125305. readonly R16I: number;
  125306. readonly RG16I: number;
  125307. readonly RGB16I: number;
  125308. readonly RGBA16I: number;
  125309. readonly R16UI: number;
  125310. readonly RG16UI: number;
  125311. readonly RGB16UI: number;
  125312. readonly RGBA16UI: number;
  125313. readonly R32I: number;
  125314. readonly RG32I: number;
  125315. readonly RGB32I: number;
  125316. readonly RGBA32I: number;
  125317. readonly R32UI: number;
  125318. readonly RG32UI: number;
  125319. readonly RGB32UI: number;
  125320. readonly RGBA32UI: number;
  125321. readonly RGB10_A2UI: number;
  125322. readonly R11F_G11F_B10F: number;
  125323. readonly RGB9_E5: number;
  125324. readonly RGB10_A2: number;
  125325. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  125326. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  125327. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  125328. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  125329. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  125330. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  125331. 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;
  125332. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  125333. readonly TRANSFORM_FEEDBACK: number;
  125334. readonly INTERLEAVED_ATTRIBS: number;
  125335. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  125336. createTransformFeedback(): WebGLTransformFeedback;
  125337. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  125338. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  125339. beginTransformFeedback(primitiveMode: number): void;
  125340. endTransformFeedback(): void;
  125341. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  125342. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  125343. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  125344. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  125345. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  125346. }
  125347. interface ImageBitmap {
  125348. readonly width: number;
  125349. readonly height: number;
  125350. close(): void;
  125351. }
  125352. interface WebGLQuery extends WebGLObject {
  125353. }
  125354. declare var WebGLQuery: {
  125355. prototype: WebGLQuery;
  125356. new(): WebGLQuery;
  125357. };
  125358. interface WebGLSampler extends WebGLObject {
  125359. }
  125360. declare var WebGLSampler: {
  125361. prototype: WebGLSampler;
  125362. new(): WebGLSampler;
  125363. };
  125364. interface WebGLSync extends WebGLObject {
  125365. }
  125366. declare var WebGLSync: {
  125367. prototype: WebGLSync;
  125368. new(): WebGLSync;
  125369. };
  125370. interface WebGLTransformFeedback extends WebGLObject {
  125371. }
  125372. declare var WebGLTransformFeedback: {
  125373. prototype: WebGLTransformFeedback;
  125374. new(): WebGLTransformFeedback;
  125375. };
  125376. interface WebGLVertexArrayObject extends WebGLObject {
  125377. }
  125378. declare var WebGLVertexArrayObject: {
  125379. prototype: WebGLVertexArrayObject;
  125380. new(): WebGLVertexArrayObject;
  125381. };
  125382. // Type definitions for WebVR API
  125383. // Project: https://w3c.github.io/webvr/
  125384. // Definitions by: six a <https://github.com/lostfictions>
  125385. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  125386. interface VRDisplay extends EventTarget {
  125387. /**
  125388. * Dictionary of capabilities describing the VRDisplay.
  125389. */
  125390. readonly capabilities: VRDisplayCapabilities;
  125391. /**
  125392. * z-depth defining the far plane of the eye view frustum
  125393. * enables mapping of values in the render target depth
  125394. * attachment to scene coordinates. Initially set to 10000.0.
  125395. */
  125396. depthFar: number;
  125397. /**
  125398. * z-depth defining the near plane of the eye view frustum
  125399. * enables mapping of values in the render target depth
  125400. * attachment to scene coordinates. Initially set to 0.01.
  125401. */
  125402. depthNear: number;
  125403. /**
  125404. * An identifier for this distinct VRDisplay. Used as an
  125405. * association point in the Gamepad API.
  125406. */
  125407. readonly displayId: number;
  125408. /**
  125409. * A display name, a user-readable name identifying it.
  125410. */
  125411. readonly displayName: string;
  125412. readonly isConnected: boolean;
  125413. readonly isPresenting: boolean;
  125414. /**
  125415. * If this VRDisplay supports room-scale experiences, the optional
  125416. * stage attribute contains details on the room-scale parameters.
  125417. */
  125418. readonly stageParameters: VRStageParameters | null;
  125419. /**
  125420. * Passing the value returned by `requestAnimationFrame` to
  125421. * `cancelAnimationFrame` will unregister the callback.
  125422. * @param handle Define the hanle of the request to cancel
  125423. */
  125424. cancelAnimationFrame(handle: number): void;
  125425. /**
  125426. * Stops presenting to the VRDisplay.
  125427. * @returns a promise to know when it stopped
  125428. */
  125429. exitPresent(): Promise<void>;
  125430. /**
  125431. * Return the current VREyeParameters for the given eye.
  125432. * @param whichEye Define the eye we want the parameter for
  125433. * @returns the eye parameters
  125434. */
  125435. getEyeParameters(whichEye: string): VREyeParameters;
  125436. /**
  125437. * Populates the passed VRFrameData with the information required to render
  125438. * the current frame.
  125439. * @param frameData Define the data structure to populate
  125440. * @returns true if ok otherwise false
  125441. */
  125442. getFrameData(frameData: VRFrameData): boolean;
  125443. /**
  125444. * Get the layers currently being presented.
  125445. * @returns the list of VR layers
  125446. */
  125447. getLayers(): VRLayer[];
  125448. /**
  125449. * Return a VRPose containing the future predicted pose of the VRDisplay
  125450. * when the current frame will be presented. The value returned will not
  125451. * change until JavaScript has returned control to the browser.
  125452. *
  125453. * The VRPose will contain the position, orientation, velocity,
  125454. * and acceleration of each of these properties.
  125455. * @returns the pose object
  125456. */
  125457. getPose(): VRPose;
  125458. /**
  125459. * Return the current instantaneous pose of the VRDisplay, with no
  125460. * prediction applied.
  125461. * @returns the current instantaneous pose
  125462. */
  125463. getImmediatePose(): VRPose;
  125464. /**
  125465. * The callback passed to `requestAnimationFrame` will be called
  125466. * any time a new frame should be rendered. When the VRDisplay is
  125467. * presenting the callback will be called at the native refresh
  125468. * rate of the HMD. When not presenting this function acts
  125469. * identically to how window.requestAnimationFrame acts. Content should
  125470. * make no assumptions of frame rate or vsync behavior as the HMD runs
  125471. * asynchronously from other displays and at differing refresh rates.
  125472. * @param callback Define the eaction to run next frame
  125473. * @returns the request handle it
  125474. */
  125475. requestAnimationFrame(callback: FrameRequestCallback): number;
  125476. /**
  125477. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  125478. * Repeat calls while already presenting will update the VRLayers being displayed.
  125479. * @param layers Define the list of layer to present
  125480. * @returns a promise to know when the request has been fulfilled
  125481. */
  125482. requestPresent(layers: VRLayer[]): Promise<void>;
  125483. /**
  125484. * Reset the pose for this display, treating its current position and
  125485. * orientation as the "origin/zero" values. VRPose.position,
  125486. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  125487. * updated when calling resetPose(). This should be called in only
  125488. * sitting-space experiences.
  125489. */
  125490. resetPose(): void;
  125491. /**
  125492. * The VRLayer provided to the VRDisplay will be captured and presented
  125493. * in the HMD. Calling this function has the same effect on the source
  125494. * canvas as any other operation that uses its source image, and canvases
  125495. * created without preserveDrawingBuffer set to true will be cleared.
  125496. * @param pose Define the pose to submit
  125497. */
  125498. submitFrame(pose?: VRPose): void;
  125499. }
  125500. declare var VRDisplay: {
  125501. prototype: VRDisplay;
  125502. new(): VRDisplay;
  125503. };
  125504. interface VRLayer {
  125505. leftBounds?: number[] | Float32Array | null;
  125506. rightBounds?: number[] | Float32Array | null;
  125507. source?: HTMLCanvasElement | null;
  125508. }
  125509. interface VRDisplayCapabilities {
  125510. readonly canPresent: boolean;
  125511. readonly hasExternalDisplay: boolean;
  125512. readonly hasOrientation: boolean;
  125513. readonly hasPosition: boolean;
  125514. readonly maxLayers: number;
  125515. }
  125516. interface VREyeParameters {
  125517. /** @deprecated */
  125518. readonly fieldOfView: VRFieldOfView;
  125519. readonly offset: Float32Array;
  125520. readonly renderHeight: number;
  125521. readonly renderWidth: number;
  125522. }
  125523. interface VRFieldOfView {
  125524. readonly downDegrees: number;
  125525. readonly leftDegrees: number;
  125526. readonly rightDegrees: number;
  125527. readonly upDegrees: number;
  125528. }
  125529. interface VRFrameData {
  125530. readonly leftProjectionMatrix: Float32Array;
  125531. readonly leftViewMatrix: Float32Array;
  125532. readonly pose: VRPose;
  125533. readonly rightProjectionMatrix: Float32Array;
  125534. readonly rightViewMatrix: Float32Array;
  125535. readonly timestamp: number;
  125536. }
  125537. interface VRPose {
  125538. readonly angularAcceleration: Float32Array | null;
  125539. readonly angularVelocity: Float32Array | null;
  125540. readonly linearAcceleration: Float32Array | null;
  125541. readonly linearVelocity: Float32Array | null;
  125542. readonly orientation: Float32Array | null;
  125543. readonly position: Float32Array | null;
  125544. readonly timestamp: number;
  125545. }
  125546. interface VRStageParameters {
  125547. sittingToStandingTransform?: Float32Array;
  125548. sizeX?: number;
  125549. sizeY?: number;
  125550. }
  125551. interface Navigator {
  125552. getVRDisplays(): Promise<VRDisplay[]>;
  125553. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  125554. }
  125555. interface Window {
  125556. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  125557. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  125558. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  125559. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  125560. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  125561. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  125562. }
  125563. interface Gamepad {
  125564. readonly displayId: number;
  125565. }
  125566. type XRSessionMode =
  125567. | "inline"
  125568. | "immersive-vr"
  125569. | "immersive-ar";
  125570. type XRReferenceSpaceType =
  125571. | "viewer"
  125572. | "local"
  125573. | "local-floor"
  125574. | "bounded-floor"
  125575. | "unbounded";
  125576. type XREnvironmentBlendMode =
  125577. | "opaque"
  125578. | "additive"
  125579. | "alpha-blend";
  125580. type XRVisibilityState =
  125581. | "visible"
  125582. | "visible-blurred"
  125583. | "hidden";
  125584. type XRHandedness =
  125585. | "none"
  125586. | "left"
  125587. | "right";
  125588. type XRTargetRayMode =
  125589. | "gaze"
  125590. | "tracked-pointer"
  125591. | "screen";
  125592. type XREye =
  125593. | "none"
  125594. | "left"
  125595. | "right";
  125596. interface XRSpace extends EventTarget {
  125597. }
  125598. interface XRRenderState {
  125599. depthNear?: number;
  125600. depthFar?: number;
  125601. inlineVerticalFieldOfView?: number;
  125602. baseLayer?: XRWebGLLayer;
  125603. }
  125604. interface XRInputSource {
  125605. handedness: XRHandedness;
  125606. targetRayMode: XRTargetRayMode;
  125607. targetRaySpace: XRSpace;
  125608. gripSpace: XRSpace | undefined;
  125609. gamepad: Gamepad | undefined;
  125610. profiles: Array<string>;
  125611. }
  125612. interface XRSession {
  125613. addEventListener: Function;
  125614. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  125615. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  125616. requestAnimationFrame: Function;
  125617. end(): Promise<void>;
  125618. renderState: XRRenderState;
  125619. inputSources: Array<XRInputSource>;
  125620. }
  125621. interface XRReferenceSpace extends XRSpace {
  125622. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  125623. onreset: any;
  125624. }
  125625. interface XRFrame {
  125626. session: XRSession;
  125627. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  125628. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  125629. }
  125630. interface XRViewerPose extends XRPose {
  125631. views: Array<XRView>;
  125632. }
  125633. interface XRPose {
  125634. transform: XRRigidTransform;
  125635. emulatedPosition: boolean;
  125636. }
  125637. declare var XRWebGLLayer: {
  125638. prototype: XRWebGLLayer;
  125639. new(session: XRSession, context: WebGLRenderingContext | undefined): XRWebGLLayer;
  125640. };
  125641. interface XRWebGLLayer {
  125642. framebuffer: WebGLFramebuffer;
  125643. framebufferWidth: number;
  125644. framebufferHeight: number;
  125645. getViewport: Function;
  125646. }
  125647. interface XRRigidTransform {
  125648. position: DOMPointReadOnly;
  125649. orientation: DOMPointReadOnly;
  125650. matrix: Float32Array;
  125651. inverse: XRRigidTransform;
  125652. }
  125653. interface XRView {
  125654. eye: XREye;
  125655. projectionMatrix: Float32Array;
  125656. transform: XRRigidTransform;
  125657. }
  125658. interface XRInputSourceChangeEvent {
  125659. session: XRSession;
  125660. removed: Array<XRInputSource>;
  125661. added: Array<XRInputSource>;
  125662. }